igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
192 lines (189 loc) • 5.87 kB
TypeScript
import { IgRect } from "igniteui-react-core";
import { IgPoint } from "igniteui-react-core";
import { IgrHorizontalRangeCategorySeries, IIgrHorizontalRangeCategorySeriesProps } from "./igr-horizontal-range-category-series";
import { RangeColumnSeries } from "./RangeColumnSeries";
/**
* Represents a IgxDataChartComponent range column series.
*
* The `RangeColumnSeries` class represents range column series of the IgxDataChartComponent.
*
* ```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";
* series1.xAxisName = "xAxis";
* series1.yAxisName = "yAxis";
* this.chart.series.add(series1);
* ```
*/
export declare class IgrRangeColumnSeries extends IgrHorizontalRangeCategorySeries<IIgrRangeColumnSeriesProps> {
protected createImplementation(): RangeColumnSeries;
/**
* @hidden
*/
get i(): RangeColumnSeries;
constructor(props: IIgrRangeColumnSeriesProps);
/**
* Gets whether the current series shows a column shape.
*/
get isColumn(): boolean;
/**
* Overridden by derived series classes to indicate when marker-less display is preferred or not.
*/
get isMarkerlessDisplayPreferred(): boolean;
/**
* Gets or sets the x-radius of the ellipse that is used to round the corners of the column.
*
* Use the `RadiusX` property to round the corners of the column.
*
* ```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"
* radiusX={10} />
* </IgrDataChart>
* ```
*
* ```ts
* series.radiusX=10;
* ```
*/
get radiusX(): number;
set radiusX(v: number);
/**
* Gets or sets the y-radius of the ellipse that is used to round the corners of the column.
*
* Use the `RadiusY` property for the y-radius of the ellipse that is used to round the corners of the column.
*
* ```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"
* radiusY={10} />
* </IgrDataChart>
* ```
*
* ```ts
* series.radiusY=10;
* ```
*/
get radiusY(): number;
set radiusY(v: number);
/**
* 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
*
* The `GetSeriesValueBoundingBox` method return the best available value of the bounding box within the series.
*/
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.
*
* The `GetItemSpan` method returns the current width of the items within the categories.
*
* ```ts
* var x =series.getItemSpan();
* ```
*/
getItemSpan(): number;
}
export interface IIgrRangeColumnSeriesProps extends IIgrHorizontalRangeCategorySeriesProps {
/**
* Gets or sets the x-radius of the ellipse that is used to round the corners of the column.
*
* Use the `RadiusX` property to round the corners of the column.
*
* ```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"
* radiusX={10} />
* </IgrDataChart>
* ```
*
* ```ts
* series.radiusX=10;
* ```
*/
radiusX?: number | string;
/**
* Gets or sets the y-radius of the ellipse that is used to round the corners of the column.
*
* Use the `RadiusY` property for the y-radius of the ellipse that is used to round the corners of the column.
*
* ```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"
* radiusY={10} />
* </IgrDataChart>
* ```
*
* ```ts
* series.radiusY=10;
* ```
*/
radiusY?: number | string;
}