igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
209 lines (206 loc) • 6.69 kB
TypeScript
import { IgrCategorySeries, IIgrCategorySeriesProps } from "./igr-category-series";
import { RangeCategorySeries } from "./RangeCategorySeries";
/**
* Represents the base class for all IgxDataChartComponent ranged category/value series.
*
* The `RangeCategorySeries` represents the base class for all IgxDataChartComponent ranged category/value series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrRangeColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low" />
* </IgrDataChart>
* ```
*
* ```ts
* let series1 = new IgrRangeColumnSeries({ name: "series1" });
* series1.highMemberPath = "High";
* series1.lowMemberPath = "Low";
* series1.xAxisName = "xAxis";
* series1.yAxisName = "yAxis";
* this.chart.series.add(series1);
* ```
*/
export declare abstract class IgrRangeCategorySeries<P extends IIgrRangeCategorySeriesProps = IIgrRangeCategorySeriesProps> extends IgrCategorySeries<P> {
/**
* @hidden
*/
get i(): RangeCategorySeries;
constructor(props: P);
/**
* Gets or sets the value mapping property for the current series object.
*
* The `LowMemberPath` is used for low mapping property of the current series object.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrRangeColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low" />
* </IgrDataChart>
* ```
*
* ```ts
* const series1 = new IgrRangeColumnSeries({ name: "series1" });
* series1.highMemberPath = "High";
* series1.lowMemberPath = "Low";
* ```
*/
get lowMemberPath(): string;
set lowMemberPath(v: string);
/**
* Gets or sets the value mapping property for the current series object.
*
* Use `HighMemberPath` propert for high mapping of the current series object.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrRangeColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low" />
* </IgrDataChart>
* ```
*
* ```ts
* series.highMemberPath = "high";
* ```
*
* ```ts
* const series1 = new IgrRangeColumnSeries({ name: "series1" });
* series1.highMemberPath = "High";
* series1.lowMemberPath = "Low";
* ```
*/
get highMemberPath(): string;
set highMemberPath(v: string);
/**
* Gets or sets the highlighted low value mapping property for the current series object.
*/
get highlightedLowMemberPath(): string;
set highlightedLowMemberPath(v: string);
/**
* Gets or sets the highlighted High value mapping property for the current series object.
*/
get highlightedHighMemberPath(): string;
set highlightedHighMemberPath(v: string);
getItemValue(item: any, memberPathName: string): any;
/**
* Gets the value of a requested member path from the series.
* @param memberPathName * The property name of a valid member path for the series
*/
getMemberPathValue(memberPathName: string): string;
/**
* Scrolls the series to display the item for the specified data item.
* The series is scrolled by the minimum amount required to place the specified data item within
* the central 80% of the visible axis.
* @param item * The data item (item) to scroll to.
*
* `ScrollIntoView` method Scrolls the series to display the item for the specified data item.
*/
scrollIntoView(item: any): boolean;
}
export interface IIgrRangeCategorySeriesProps extends IIgrCategorySeriesProps {
/**
* Gets or sets the value mapping property for the current series object.
*
* The `LowMemberPath` is used for low mapping property of the current series object.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrRangeColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low" />
* </IgrDataChart>
* ```
*
* ```ts
* const series1 = new IgrRangeColumnSeries({ name: "series1" });
* series1.highMemberPath = "High";
* series1.lowMemberPath = "Low";
* ```
*/
lowMemberPath?: string;
/**
* Gets or sets the value mapping property for the current series object.
*
* Use `HighMemberPath` propert for high mapping of the current series object.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrRangeColumnSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low" />
* </IgrDataChart>
* ```
*
* ```ts
* series.highMemberPath = "high";
* ```
*
* ```ts
* const series1 = new IgrRangeColumnSeries({ name: "series1" });
* series1.highMemberPath = "High";
* series1.lowMemberPath = "Low";
* ```
*/
highMemberPath?: string;
/**
* Gets or sets the highlighted low value mapping property for the current series object.
*/
highlightedLowMemberPath?: string;
/**
* Gets or sets the highlighted High value mapping property for the current series object.
*/
highlightedHighMemberPath?: string;
}