igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
78 lines (75 loc) • 3.48 kB
TypeScript
import { IgRect } from "igniteui-angular-core";
import { IgPoint } from "igniteui-angular-core";
import { ConsolidatedItemsPosition } from "./ConsolidatedItemsPosition";
import { IgxHorizontalAnchoredCategorySeriesComponent } from "./igx-horizontal-anchored-category-series-component";
import { ColumnSeries } from "./ColumnSeries";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent column series.
* Compare values across categories by using vertical rectangles.
* Use it when the order of categories is not important or for displaying
* item counts such as a histogram.
*
* ```html
* <igx-data-chart [dataSource]="data" >
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value" >
* </igx-column-series>
* </igx-data-chart>
* ```
*/
export declare class IgxColumnSeriesComponent extends IgxHorizontalAnchoredCategorySeriesComponent {
protected createImplementation(): ColumnSeries;
/**
* @hidden
*/
get i(): ColumnSeries;
constructor();
/**
* Gets whether the current series shows a column shape.
*/
get isColumn(): boolean;
static ngAcceptInputType_isColumn: boolean | string;
/**
* Overridden by derived series classes to indicate when marker-less display is preferred or not.
*/
get isMarkerlessDisplayPreferred(): boolean;
static ngAcceptInputType_isMarkerlessDisplayPreferred: boolean | string;
/**
* Gets or sets the x-radius of the ellipse that is used to round the corners of the column.
*/
get radiusX(): number;
set radiusX(v: number);
static ngAcceptInputType_radiusX: number | string;
/**
* Gets or sets the y-radius of the ellipse that is used to round the corners of the column.
*/
get radiusY(): number;
set radiusY(v: number);
static ngAcceptInputType_radiusY: number | string;
/**
* The positioning logic to use for columns which have been consolidated into a single visual element.
*/
get consolidatedColumnVerticalPosition(): ConsolidatedItemsPosition;
set consolidatedColumnVerticalPosition(v: ConsolidatedItemsPosition);
static ngAcceptInputType_consolidatedColumnVerticalPosition: ConsolidatedItemsPosition | string;
/**
* If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.
* @param world * The world coordinate for which to get a value bounding box for
*/
getSeriesValueBoundingBox(world: IgPoint): IgRect;
/**
* For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.
*/
getItemSpan(): number;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxColumnSeriesComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxColumnSeriesComponent, "igx-column-series", never, { "radiusX": "radiusX"; "radiusY": "radiusY"; "consolidatedColumnVerticalPosition": "consolidatedColumnVerticalPosition"; }, {}, never, never>;
}