igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
239 lines (238 loc) • 7.01 kB
TypeScript
import { IgPoint } from "igniteui-react-core";
import { IgrFinancialOverlay, IIgrFinancialOverlayProps } from "./igr-financial-overlay";
import { BollingerBandsOverlay } from "./BollingerBandsOverlay";
/**
* Represents a IgxDataChartComponent Bollinger Bands financial overlay series.
* Default required members: High, Low, Close
*
* You can use the `BollingerBandsOverlay` class represents a IgxDataChartComponent Bollinger Bands financial overlay 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" />
*
* <IgrBollingerBandsOverlay
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume" />
* </IgrDataChart>
* ```
*
* ```ts
* const s = new IgrBollingerBandsOverlay({ name: "", xAxisName: "" });
* ```
*/
export declare class IgrBollingerBandsOverlay extends IgrFinancialOverlay<IIgrBollingerBandsOverlayProps> {
protected createImplementation(): BollingerBandsOverlay;
/**
* @hidden
*/
get i(): BollingerBandsOverlay;
constructor(props: IIgrBollingerBandsOverlayProps);
/**
* Gets or sets the moving average period for the current BollingerBandOverlay object.
* The typical, and initial, value for Bollinger band periods is 14.
*
* You can use the `period` property for moving average of the current BollingerBandOverlay 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" />
*
* <IgrBollingerBandsOverlay
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* period={7} />
* </IgrDataChart>
* ```
*
* ```ts
* this.series.period = 7;
* ```
*/
get period(): number;
set period(v: number);
/**
* Gets or sets the moving average period for the current BollingerBandOverlay object.
* The typical, and initial, value for Bollinger band multipliers is 2.
*
* You can use the `BollingerBandsOverlay`
*
* ```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" />
*
* <IgrBollingerBandsOverlay
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* multiplier= {2} />
* </IgrDataChart>
* ```
*/
get multiplier(): number;
set multiplier(v: number);
getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number;
getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number;
getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number;
}
export interface IIgrBollingerBandsOverlayProps extends IIgrFinancialOverlayProps {
/**
* Gets or sets the moving average period for the current BollingerBandOverlay object.
* The typical, and initial, value for Bollinger band periods is 14.
*
* You can use the `period` property for moving average of the current BollingerBandOverlay 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" />
*
* <IgrBollingerBandsOverlay
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* period={7} />
* </IgrDataChart>
* ```
*
* ```ts
* this.series.period = 7;
* ```
*/
period?: number | string;
/**
* Gets or sets the moving average period for the current BollingerBandOverlay object.
* The typical, and initial, value for Bollinger band multipliers is 2.
*
* You can use the `BollingerBandsOverlay`
*
* ```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" />
*
* <IgrBollingerBandsOverlay
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* multiplier= {2} />
* </IgrDataChart>
* ```
*/
multiplier?: number | string;
}