igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
309 lines (303 loc) • 11.5 kB
TypeScript
import { IgPoint } from "igniteui-react-core";
import { CategoryCollisionMode } from "./CategoryCollisionMode";
import { CategoryTransitionInMode } from "./CategoryTransitionInMode";
import { IgrAssigningCategoryStyleEventArgs } from "./igr-assigning-category-style-event-args";
import { IgrAssigningCategoryMarkerStyleEventArgs } from "./igr-assigning-category-marker-style-event-args";
import { IgrMarkerSeries, IIgrMarkerSeriesProps } from "./igr-marker-series";
import { CategorySeries } from "./CategorySeries";
/**
* Represents the base class for IgxDataChartComponent category series.
*
* `CategorySeries` class represents the base class for IgxDataChartComponent category series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"/>
* </IgrDataChart>
* ```
*
* ```ts
* this.columnSeries2 = new IgrColumnSeries({ name: "colSeries2" });
* this.columnSeries2.dataSource = this.categoryData;
* this.columnSeries2.xAxis = this.categoryXAxis;
* this.columnSeries2.yAxis = this.numericYAxis;
* this.columnSeries2.xAxisName = "categoryXAxis";
* this.columnSeries2.yAxisName = "numericYAxis";
* this.columnSeries2.valueMemberPath = "RUS";
* ```
*/
export declare abstract class IgrCategorySeries<P extends IIgrCategorySeriesProps = IIgrCategorySeriesProps> extends IgrMarkerSeries<P> {
/**
* @hidden
*/
get i(): CategorySeries;
constructor(props: P);
get hasValueAxis(): boolean;
get isValueAxisInverted(): boolean;
/**
* Gets whether or not this series is Category series
*/
get isCategory(): boolean;
/**
* Gets or sets whether this category series should allow custom style overrides of its individual visuals.
*/
get isCustomCategoryStyleAllowed(): boolean;
set isCustomCategoryStyleAllowed(v: boolean);
/**
* Gets or sets whether this category series should allow custom style overrides of its individual marker visuals.
*/
get isCustomCategoryMarkerStyleAllowed(): boolean;
set isCustomCategoryMarkerStyleAllowed(v: boolean);
/**
* Gets or sets the category collision mode selection behavior to use for the series.
*/
get categoryCollisionMode(): CategoryCollisionMode;
set categoryCollisionMode(v: CategoryCollisionMode);
/**
* Sets or Gets whether to increase marker fidelity for extreme data shapes that have lots of Y variation over short X intervals.
*
* Set `UseHighMarkerFidelity` when your data has high variation along the y-axis within a short span of this x-axis.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"
* useHighMarkerFidelity="true"/>
* </IgrDataChart>
* ```
*
* ```ts
* this.columnSeries2.useHighMarkerFidelity= "true";
* ```
*/
get useHighMarkerFidelity(): boolean;
set useHighMarkerFidelity(v: boolean);
/**
* Gets or sets the method by which to animate the data into the chart when the chart data source is swapped.
* Note: Transitions are not currently supported for stacked series.
*
* `TransitionInMode` controls the direction of the transition-in animation.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"
* transitionInMode="accordionfromRight"/>
* </IgrDataChart>
* ```
*
* ```ts
*
* this.columnSeries2.transitionInMode= "accordionfromRight";
* ```
*/
get transitionInMode(): CategoryTransitionInMode;
set transitionInMode(v: CategoryTransitionInMode);
/**
* Gets or sets whether the series should transition into the plot area when a new data source is assigned.
* Note: Transitions are not currently supported for stacked series.
*
* Set `IsTransitionInEnabled` to true if you want your chart series to animate into position when the chart is loading into view.
*
* ```ts
* this.columnSeries2 = new IgrColumnSeries({ name: "colSeries2" });
* this.columnSeries2.dataSource = this.categoryData;
* this.columnSeries2.xAxis = this.categoryXAxis;
* this.columnSeries2.yAxis = this.numericYAxis;
* this.columnSeries2.xAxisName = "categoryXAxis";
* this.columnSeries2.yAxisName = "numericYAxis";
* this.columnSeries2.valueMemberPath = "RUS";
* this.columnSeries2.isTransitionInEnabled= "true";
* ```
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"
* isTransitionInEnabled="true"/>
* </IgrDataChart>
* ```
*/
get isTransitionInEnabled(): boolean;
set isTransitionInEnabled(v: boolean);
/**
* Returns the offset value for this series if grouped on a category axis.
*/
getOffsetValue(): number;
/**
* Returns the width of the category grouping this series is in.
*/
getCategoryWidth(): number;
/**
* Gets the item that is the best match for the specified world coordinates.
* @param world * The world coordinates to use.
*/
getItem(world: IgPoint): any;
/**
* Gets the index of the item based on world coordinates.
* @param world * The world coordinates to use.
*/
getItemIndex(world: IgPoint): number;
/**
* Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.
* @param world * The world position for which to return the index.
*/
getExactItemIndex(world: IgPoint): number;
private _assigningCategoryStyle;
private _assigningCategoryStyle_wrapped;
/**
* Event raised when Assigning Category Style
*/
get assigningCategoryStyle(): (s: IgrCategorySeries, e: IgrAssigningCategoryStyleEventArgs) => void;
set assigningCategoryStyle(ev: (s: IgrCategorySeries, e: IgrAssigningCategoryStyleEventArgs) => void);
private _assigningCategoryMarkerStyle;
private _assigningCategoryMarkerStyle_wrapped;
/**
* Event raised when Assigning Category Marker Style
*/
get assigningCategoryMarkerStyle(): (s: IgrCategorySeries, e: IgrAssigningCategoryMarkerStyleEventArgs) => void;
set assigningCategoryMarkerStyle(ev: (s: IgrCategorySeries, e: IgrAssigningCategoryMarkerStyleEventArgs) => void);
}
export interface IIgrCategorySeriesProps extends IIgrMarkerSeriesProps {
/**
* Gets or sets whether this category series should allow custom style overrides of its individual visuals.
*/
isCustomCategoryStyleAllowed?: boolean | string;
/**
* Gets or sets whether this category series should allow custom style overrides of its individual marker visuals.
*/
isCustomCategoryMarkerStyleAllowed?: boolean | string;
/**
* Gets or sets the category collision mode selection behavior to use for the series.
*/
categoryCollisionMode?: CategoryCollisionMode | string;
/**
* Sets or Gets whether to increase marker fidelity for extreme data shapes that have lots of Y variation over short X intervals.
*
* Set `UseHighMarkerFidelity` when your data has high variation along the y-axis within a short span of this x-axis.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"
* useHighMarkerFidelity="true"/>
* </IgrDataChart>
* ```
*
* ```ts
* this.columnSeries2.useHighMarkerFidelity= "true";
* ```
*/
useHighMarkerFidelity?: boolean | string;
/**
* Gets or sets the method by which to animate the data into the chart when the chart data source is swapped.
* Note: Transitions are not currently supported for stacked series.
*
* `TransitionInMode` controls the direction of the transition-in animation.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"
* transitionInMode="accordionfromRight"/>
* </IgrDataChart>
* ```
*
* ```ts
*
* this.columnSeries2.transitionInMode= "accordionfromRight";
* ```
*/
transitionInMode?: CategoryTransitionInMode | string;
/**
* Gets or sets whether the series should transition into the plot area when a new data source is assigned.
* Note: Transitions are not currently supported for stacked series.
*
* Set `IsTransitionInEnabled` to true if you want your chart series to animate into position when the chart is loading into view.
*
* ```ts
* this.columnSeries2 = new IgrColumnSeries({ name: "colSeries2" });
* this.columnSeries2.dataSource = this.categoryData;
* this.columnSeries2.xAxis = this.categoryXAxis;
* this.columnSeries2.yAxis = this.numericYAxis;
* this.columnSeries2.xAxisName = "categoryXAxis";
* this.columnSeries2.yAxisName = "numericYAxis";
* this.columnSeries2.valueMemberPath = "RUS";
* this.columnSeries2.isTransitionInEnabled= "true";
* ```
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* valueMemberPath="Value"
* isTransitionInEnabled="true"/>
* </IgrDataChart>
* ```
*/
isTransitionInEnabled?: boolean | string;
/**
* Event raised when Assigning Category Style
*/
assigningCategoryStyle?: (s: IgrCategorySeries, e: IgrAssigningCategoryStyleEventArgs) => void;
/**
* Event raised when Assigning Category Marker Style
*/
assigningCategoryMarkerStyle?: (s: IgrCategorySeries, e: IgrAssigningCategoryMarkerStyleEventArgs) => void;
}