igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
78 lines (77 loc) • 2.2 kB
JavaScript
import { IgrStrategyBasedIndicator } from "./igr-strategy-based-indicator";
import { StochRSIIndicator } from "./StochRSIIndicator";
/**
* Represents a IgxDataChartComponent StochRSI indicator series.
* Default required members: Close
*
* `StochRSIIndicator` or Stochastic Relative Strength IndexI Indicator (SRSI) measures when a security is overbought or oversold within a specified period of time. The values range from 0 to 1. The StochRSI Indicator is calculated by applying the Stochastic Oscillator formula to RelativeStrengthIndexIndicator (RSI) data.
*
* Using this indicator requires setting the `CloseMemberPath`.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrOrdinalTimeXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrStochRSIIndicator
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* closeMemberPath="Close"/>
* </IgrDataChart>
* ```
*
* ```ts
* let series = new IgrStochRSIIndicator({name:"series1"});
* series.xAxis = this.xAxis;
* series.yAxis = this.yAxis;
* series.closeMemberPath = "close";
* this.chart.series.add(series);
* ```
*/
export class IgrStochRSIIndicator extends IgrStrategyBasedIndicator {
createImplementation() {
return new StochRSIIndicator();
}
/**
* @hidden
*/
get i() {
return this._implementation;
}
constructor(props) {
super(props);
}
/**
* Gets or sets the moving average period for the current StochRSIIndicator object.
* The typical, and initial, value for StochRSI periods is 14.
*
* ```ts
* this.series.period = 10;
* ```
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrOrdinalTimeXAxis name="xAxis" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrStochRSIIndicator
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* closeMemberPath="Close"
* period={10} />
* </IgrDataChart>
* ```
*/
get period() {
return this.i.acr;
}
set period(v) {
this.i.acr = +v;
}
}