igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
695 lines (690 loc) • 22.3 kB
TypeScript
import { IgRect } from "igniteui-react-core";
import { IgPoint } from "igniteui-react-core";
import { TrendLineType } from "igniteui-react-core";
import { PriceDisplayType } from "./PriceDisplayType";
import { CategoryCollisionMode } from "./CategoryCollisionMode";
import { ValueLayerValueMode } from "./ValueLayerValueMode";
import { IgrFinancialSeries, IIgrFinancialSeriesProps } from "./igr-financial-series";
import { FinancialPriceSeries } from "./FinancialPriceSeries";
/**
* Represents a IgxDataChartComponent financial price series that renders as Candlestick or OHLC representations.
* Default required members: Open, Low, High, Close
*
* The `FinancialPriceSeries` class represents a IgxDataChartComponent financial price series that renders as Candlestick or OHLC representations.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume" />
* </IgrDataChart>
* ```
*
* ```ts
* this.series = new IgrFinancialPriceSeries({name: "series"});
* this.series.dataSource = this.financialData;
* this.series.xAxis = this.timeXAxis;
* this.series.yAxis = this.numericYAxis;
* this.series.xAxisName = "timeXAxis";
* this.series.yAxisName = "numericYAxis";
* this.series.highMemberPath="High" ;
* this.series.lowMemberPath="Low";
* this.series.closeMemberPath="Close";
* this.series.openMemberPath="Open";
* this.series.volumeMemberPath="Volume";
* ```
*/
export declare class IgrFinancialPriceSeries extends IgrFinancialSeries<IIgrFinancialPriceSeriesProps> {
protected createImplementation(): FinancialPriceSeries;
/**
* @hidden
*/
get i(): FinancialPriceSeries;
constructor(props: IIgrFinancialPriceSeriesProps);
/**
* Gets whether the series has financial OHLC/candlestick visuals
*/
get isFinancialSeries(): boolean;
/**
* Gets or sets the trend type for the current financial series.
*
* Use the `TrendLineType` property for the trend type of the current financial series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLineType={this.state.trendLineType} />
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLineType= "CubicFit";
* ```
*/
get trendLineType(): TrendLineType;
set trendLineType(v: TrendLineType);
/**
* Gets or sets the brush to use to draw the trend line.
*
* Use the `TrendLineBrush` property to brush the the trend line.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLineBrush="Blue" />
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLineBrush="red";
* ```
*/
get trendLineBrush(): string;
set trendLineBrush(v: string);
/**
* Gets the effective TrendLineBrush for this FinancialPriceSeries.
*
* Use the `ActualTrendLineBrush` property to Gets the effective TrendLineBrush for the FinancialIndicator.
*
* ````ts
* <IgrDataChart
* ref={this.onChartRef}
* dataSource={this.data}
* width="100%"
* height="100%" >
*
* <IgrCategoryXAxis name="xAxis" label="Label" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrFinancialPriceSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="Close"
* openMemberPath="Open"
* volumeMemberPath="Volume"
* trendLineType={this.state.trendLineType}
* displayType= "Candlestick"
* trendLinePeriod = {2}
* actualTrendLineBrush= "blue"/>
*
* </IgrDataChart>
*
* ```
* ````
*/
get actualTrendLineBrush(): string;
set actualTrendLineBrush(v: string);
/**
* Gets or sets the thickness of the current FinancialPriceSeries object's trend line.
*
* Use the `TrendLineThickness` property for the thickness of the current FinancialPriceSeries object's trend line.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLineThickness="3"/>
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLineThickness=5;
* ```
*/
get trendLineThickness(): number;
set trendLineThickness(v: number);
/**
* Gets or sets a collection of double values that indicate the pattern of dashes and gaps that
* is used to draw the trend line for the current FinancialPriceSeries object.
*/
get trendLineDashArray(): number[];
set trendLineDashArray(v: number[]);
/**
* Gets or sets the trend line period for the current series.
* The typical, and initial, value for trend line period is 7.
*
* Use the `TrendLinePeriod` property for the periodo the the current series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLinePeriod={7} />
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLinePeriod= 7;
* ```
*/
get trendLinePeriod(): number;
set trendLinePeriod(v: number);
/**
* Gets or sets the display type for the current FinancialPriceSeries object.
*
* Use the `DisplayType` property for the display type of the current FinancialPriceSeries object.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* />
* </IgrDataChart>
* ```
*
* ```ts
* series.displayType=PriceDisplayType.Candlestick;
* ```
*/
get displayType(): PriceDisplayType;
set displayType(v: PriceDisplayType);
/**
* Gets or sets the category collision mode selection behavior to use for the series.
*/
get categoryCollisionMode(): CategoryCollisionMode;
set categoryCollisionMode(v: CategoryCollisionMode);
/**
* Brush to use for outlining negative elements in the series.
*
* Use the `NegativeOutline` property to brush the outline negative elements in the series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* negativeOutline="Red" />
* </IgrDataChart>
* ```
*
* ```ts
* series.negativeOutline="red";
* ```
*/
get negativeOutline(): string;
set negativeOutline(v: string);
/**
* Gets or sets the label displayed before series' Low value in the Data Legend.
*/
get lowMemberAsLegendLabel(): string;
set lowMemberAsLegendLabel(v: string);
/**
* Gets or sets the label displayed before series' High value in the Data Legend.
*/
get highMemberAsLegendLabel(): string;
set highMemberAsLegendLabel(v: string);
/**
* Gets or sets the label displayed before series' Close value in the Data Legend.
*/
get closeMemberAsLegendLabel(): string;
set closeMemberAsLegendLabel(v: string);
/**
* Gets or sets the label displayed before series' Open value in the Data Legend.
*/
get openMemberAsLegendLabel(): string;
set openMemberAsLegendLabel(v: string);
/**
* Gets or sets the unit displayed after series' Low value in the Data Legend.
*/
get lowMemberAsLegendUnit(): string;
set lowMemberAsLegendUnit(v: string);
/**
* Gets or sets the unit displayed after series' High value in the Data Legend.
*/
get highMemberAsLegendUnit(): string;
set highMemberAsLegendUnit(v: string);
/**
* Gets or sets the unit displayed after series' Close value in the Data Legend.
*/
get closeMemberAsLegendUnit(): string;
set closeMemberAsLegendUnit(v: string);
/**
* Gets or sets the unit displayed after series' Open value in the Data Legend.
*/
get openMemberAsLegendUnit(): string;
set openMemberAsLegendUnit(v: 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
*
* The `GetSeriesValueBoundingBox` method return the best available value bounding box within the series that has the best value match for the world position provided.
*/
getSeriesValueBoundingBox(world: IgPoint): IgRect;
/**
* Scrolls the series to display the item for the specified data item.
* The categorySeries 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.
*
* The `ScrollIntoView` methos scrolls the series to display the item for the specified data item.
*/
scrollIntoView(item: any): boolean;
/**
* 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 is used 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;
setNegativeColors(negativeBrush: string, negativeOutline: string): void;
/**
* Gets a numeric value from the numeric axis associated with this series that matches the desired
* value mode.
* @param mode * The type of value desired from the series numeric axis.
*/
getSeriesValueType(mode: ValueLayerValueMode): number[];
getSeriesValueTypePosition(mode: ValueLayerValueMode): IgPoint;
getSeriesValueTypePositionFromValue(values: number[]): IgPoint;
}
export interface IIgrFinancialPriceSeriesProps extends IIgrFinancialSeriesProps {
/**
* Gets or sets the trend type for the current financial series.
*
* Use the `TrendLineType` property for the trend type of the current financial series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLineType={this.state.trendLineType} />
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLineType= "CubicFit";
* ```
*/
trendLineType?: TrendLineType | string;
/**
* Gets or sets the brush to use to draw the trend line.
*
* Use the `TrendLineBrush` property to brush the the trend line.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLineBrush="Blue" />
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLineBrush="red";
* ```
*/
trendLineBrush?: string;
/**
* Gets the effective TrendLineBrush for this FinancialPriceSeries.
*
* Use the `ActualTrendLineBrush` property to Gets the effective TrendLineBrush for the FinancialIndicator.
*
* ````ts
* <IgrDataChart
* ref={this.onChartRef}
* dataSource={this.data}
* width="100%"
* height="100%" >
*
* <IgrCategoryXAxis name="xAxis" label="Label" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrFinancialPriceSeries
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="Close"
* openMemberPath="Open"
* volumeMemberPath="Volume"
* trendLineType={this.state.trendLineType}
* displayType= "Candlestick"
* trendLinePeriod = {2}
* actualTrendLineBrush= "blue"/>
*
* </IgrDataChart>
*
* ```
* ````
*/
actualTrendLineBrush?: string;
/**
* Gets or sets the thickness of the current FinancialPriceSeries object's trend line.
*
* Use the `TrendLineThickness` property for the thickness of the current FinancialPriceSeries object's trend line.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLineThickness="3"/>
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLineThickness=5;
* ```
*/
trendLineThickness?: number | string;
/**
* Gets or sets a collection of double values that indicate the pattern of dashes and gaps that
* is used to draw the trend line for the current FinancialPriceSeries object.
*/
trendLineDashArray?: number[] | string;
/**
* Gets or sets the trend line period for the current series.
* The typical, and initial, value for trend line period is 7.
*
* Use the `TrendLinePeriod` property for the periodo the the current series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* trendLinePeriod={7} />
* </IgrDataChart>
* ```
*
* ```ts
* series.trendLinePeriod= 7;
* ```
*/
trendLinePeriod?: number | string;
/**
* Gets or sets the display type for the current FinancialPriceSeries object.
*
* Use the `DisplayType` property for the display type of the current FinancialPriceSeries object.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* />
* </IgrDataChart>
* ```
*
* ```ts
* series.displayType=PriceDisplayType.Candlestick;
* ```
*/
displayType?: PriceDisplayType | string;
/**
* Gets or sets the category collision mode selection behavior to use for the series.
*/
categoryCollisionMode?: CategoryCollisionMode | string;
/**
* Brush to use for outlining negative elements in the series.
*
* Use the `NegativeOutline` property to brush the outline negative elements in the series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
*
* <IgrFinancialPriceSeries
* name="series2"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Candlestick"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* negativeOutline="Red" />
* </IgrDataChart>
* ```
*
* ```ts
* series.negativeOutline="red";
* ```
*/
negativeOutline?: string;
/**
* Gets or sets the label displayed before series' Low value in the Data Legend.
*/
lowMemberAsLegendLabel?: string;
/**
* Gets or sets the label displayed before series' High value in the Data Legend.
*/
highMemberAsLegendLabel?: string;
/**
* Gets or sets the label displayed before series' Close value in the Data Legend.
*/
closeMemberAsLegendLabel?: string;
/**
* Gets or sets the label displayed before series' Open value in the Data Legend.
*/
openMemberAsLegendLabel?: string;
/**
* Gets or sets the unit displayed after series' Low value in the Data Legend.
*/
lowMemberAsLegendUnit?: string;
/**
* Gets or sets the unit displayed after series' High value in the Data Legend.
*/
highMemberAsLegendUnit?: string;
/**
* Gets or sets the unit displayed after series' Close value in the Data Legend.
*/
closeMemberAsLegendUnit?: string;
/**
* Gets or sets the unit displayed after series' Open value in the Data Legend.
*/
openMemberAsLegendUnit?: string;
}