igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
103 lines (102 loc) • 3.32 kB
JavaScript
import { __extends } from "tslib";
import { IgrStrategyBasedIndicator } from "./igr-strategy-based-indicator";
import { AverageTrueRangeIndicator } from "./AverageTrueRangeIndicator";
/**
* Represents a IgxDataChartComponent Average True Range indicator series.
* Default required members: High, Low, Close
*
* You can use the `AverageTrueRangeIndicator` to measures a security's degree of price movement or volatility within a given period of time.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAverageTrueRangeIndicator
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* openMemberPath="Open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low" />
* </IgrDataChart>
* ```
*
* ```ts
* let series = new IgrAverageTrueRangeIndicator({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);
* ```
*/
var IgrAverageTrueRangeIndicator = /** @class */ /*@__PURE__*/ (function (_super) {
__extends(IgrAverageTrueRangeIndicator, _super);
function IgrAverageTrueRangeIndicator(props) {
return _super.call(this, props) || this;
}
IgrAverageTrueRangeIndicator.prototype.createImplementation = function () {
return new AverageTrueRangeIndicator();
};
Object.defineProperty(IgrAverageTrueRangeIndicator.prototype, "i", {
/**
* @hidden
*/
get: function () {
return this._implementation;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAverageTrueRangeIndicator.prototype, "period", {
/**
* Gets or sets the moving average period for the current AverageTrueRangeSeries object.
* The typical, and initial, value for AverageTrueRange periods is 14.
*
* You can use the `Period` to set the moving average.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource}
* width="700px"
* height="500px">
*
* <IgrCategoryXAxis name="xAxis" label="Year" />
* <IgrNumericYAxis name="yAxis" />
*
* <IgrAverageTrueRangeIndicator
* name="series1"
* xAxisName="xAxis"
* yAxisName="yAxis"
* openMemberPath="Open"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low"
* period="14" />
* </IgrDataChart>
* ```
*
* ```ts
* this.series.period = 14;
* ```
*/
get: function () {
return this.i.acl;
},
set: function (v) {
this.i.acl = +v;
},
enumerable: false,
configurable: true
});
return IgrAverageTrueRangeIndicator;
}(IgrStrategyBasedIndicator));
export { IgrAverageTrueRangeIndicator };