igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
206 lines (205 loc) • 6.39 kB
TypeScript
import { IgrStrategyBasedIndicator, IIgrStrategyBasedIndicatorProps } from "./igr-strategy-based-indicator";
import { AbsoluteVolumeOscillatorIndicator } from "./AbsoluteVolumeOscillatorIndicator";
/**
* Represents a IgxDataChartComponent Absolute Volume Oscillator indicator series.
* Default required members: Volume
*
* You can use the `AbsoluteVolumeOscillatorIndicator` to identify whether volume trands are increasing or decreasing.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAbsoluteVolumeOscillatorIndicator
* name="series3"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Line"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume" />
* </IgrDataChart>
* ```
*
* ```ts
* let series = new IgxAbsoluteVolumeOscillatorIndicatorComponent();
* series.xAxis = this.xAxis;
* series.yAxis = this.yAxis;
* series.openMemberPath = "open";
* series.highMemberPath = "high";
* series.lowMemberPath = "low";
* series.closeMemberPath = "close";
* this.chart.series.add(series);
* ```
*
* ```ts
* let series = new IgrAbsoluteVolumeOscillatorIndicator({name:"series3"});
* series.xAxisName = this.xAxis;
* series.yAxisName = this.yAxis;
* series.openMemberPath = "open";
* series.highMemberPath = "high";
* series.lowMemberPath = "low";
* series.closeMemberPath = "close";
* this.chart.series.add(series);
* ```
*/
export declare class IgrAbsoluteVolumeOscillatorIndicator extends IgrStrategyBasedIndicator<IIgrAbsoluteVolumeOscillatorIndicatorProps> {
protected createImplementation(): AbsoluteVolumeOscillatorIndicator;
/**
* @hidden
*/
get i(): AbsoluteVolumeOscillatorIndicator;
constructor(props: IIgrAbsoluteVolumeOscillatorIndicatorProps);
/**
* Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object.
* The typical, and initial, value for short AVO periods is 10.
*
* You can use the `ShortPeriod` to set the short moving average period.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAbsoluteVolumeOscillatorIndicator
* name="series3"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Line"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* shortPeriod="10" />
* </IgrDataChart>
* ```
*
* ```ts
* this.series.shortPeriod = 10;
* ```
*/
get shortPeriod(): number;
set shortPeriod(v: number);
/**
* Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object.
* The typical, and initial, value for long AVO periods is 30.
*
* You can use the `LongPeriod` to set the long moving average period.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAbsoluteVolumeOscillatorIndicator
* name="series3"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Line"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* longPeriod=30/>
* </IgrDataChart>
* ```
*
* ```ts
* this.series.longPeriod = 30;
* ```
*/
get longPeriod(): number;
set longPeriod(v: number);
}
export interface IIgrAbsoluteVolumeOscillatorIndicatorProps extends IIgrStrategyBasedIndicatorProps {
/**
* Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object.
* The typical, and initial, value for short AVO periods is 10.
*
* You can use the `ShortPeriod` to set the short moving average period.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAbsoluteVolumeOscillatorIndicator
* name="series3"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Line"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* shortPeriod="10" />
* </IgrDataChart>
* ```
*
* ```ts
* this.series.shortPeriod = 10;
* ```
*/
shortPeriod?: number | string;
/**
* Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object.
* The typical, and initial, value for long AVO periods is 30.
*
* You can use the `LongPeriod` to set the long moving average period.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
*
* <IgrCategoryXAxis name="xAxis" label="Date" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAbsoluteVolumeOscillatorIndicator
* name="series3"
* xAxisName="xAxis"
* yAxisName="yAxis"
* displayType="Line"
* lowMemberPath="Low"
* highMemberPath="High"
* openMemberPath="Open"
* closeMemberPath="Close"
* volumeMemberPath="Volume"
* longPeriod=30/>
* </IgrDataChart>
* ```
*
* ```ts
* this.series.longPeriod = 30;
* ```
*/
longPeriod?: number | string;
}