igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
229 lines (228 loc) • 7.69 kB
TypeScript
import { IndicatorDisplayType } from "./IndicatorDisplayType";
import { IgrStrategyBasedIndicator, IIgrStrategyBasedIndicatorProps } from "./igr-strategy-based-indicator";
import { MovingAverageConvergenceDivergenceIndicator } from "./MovingAverageConvergenceDivergenceIndicator";
/**
* Represents a IgxDataChartComponent Moving Average Convergence/Divergence (MACD) indicator series.
* Default required members: High, Low, Close
*
* Represents a Ignite UIDataChart Moving Average Convergence/Divergence (MACD) indicator series.
*
* Example:
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"/>
* </IgrDataChart>
* ```
*
* ```ts
* this.series = new IgrMovingAverageConvergenceDivergenceIndicator ({ name: "Series1" });
* this.series.dataSource = this.data;
* this.series.xAxis = this.categoryXAxis;
* this.series.yAxis = this.numericYAxis;
* this.series.xAxisName = "categoryXAxis";
* this.series.yAxisName = "numericYAxis";
* this.series.openMemberPath = "open";
* this.series.highMemberPath = "high";
* this.series.lowMemberPath = "low";
* this.series.closeMemberPath = "close";
* ```
*/
export declare class IgrMovingAverageConvergenceDivergenceIndicator extends IgrStrategyBasedIndicator<IIgrMovingAverageConvergenceDivergenceIndicatorProps> {
protected createImplementation(): MovingAverageConvergenceDivergenceIndicator;
/**
* @hidden
*/
get i(): MovingAverageConvergenceDivergenceIndicator;
constructor(props: IIgrMovingAverageConvergenceDivergenceIndicatorProps);
/**
* Gets default display type for the current Financial Indicator
*/
get defaultDisplayType(): IndicatorDisplayType;
/**
* Gets or sets the short moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
* The typical, and initial, value for short MACD periods is 10.
*
* Gets or sets the short moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
*
* Example:
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"
* shortPeriod="30"/>
* </IgrDataChart>
* ```
*/
get shortPeriod(): number;
set shortPeriod(v: number);
/**
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
* The typical, and initial, value for long MACD periods is 30.
*
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
*
* Example:
*
* ```ts
* this.series.longPeriod="30" ;
* ```
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"
* longPeriod="30"/>
* </IgrDataChart>
* ```
*/
get longPeriod(): number;
set longPeriod(v: number);
/**
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
* The typical, and initial, value for long PVO periods is 30.
*
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
*
* Example:
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"
* signalPeriod="30"/>
* </IgrDataChart>
* ```
*/
get signalPeriod(): number;
set signalPeriod(v: number);
}
export interface IIgrMovingAverageConvergenceDivergenceIndicatorProps extends IIgrStrategyBasedIndicatorProps {
/**
* Gets or sets the short moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
* The typical, and initial, value for short MACD periods is 10.
*
* Gets or sets the short moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
*
* Example:
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"
* shortPeriod="30"/>
* </IgrDataChart>
* ```
*/
shortPeriod?: number | string;
/**
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
* The typical, and initial, value for long MACD periods is 30.
*
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
*
* Example:
*
* ```ts
* this.series.longPeriod="30" ;
* ```
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"
* longPeriod="30"/>
* </IgrDataChart>
* ```
*/
longPeriod?: number | string;
/**
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
* The typical, and initial, value for long PVO periods is 30.
*
* Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object.
*
* Example:
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrMovingAverageConvergenceDivergenceIndicator
* name="series1"
* openMemberPath="open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* closeMemberPath="close"
* signalPeriod="30"/>
* </IgrDataChart>
* ```
*/
signalPeriod?: number | string;
}