igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
61 lines (60 loc) • 2.71 kB
TypeScript
import { IgxStrategyBasedIndicatorComponent } from "./igx-strategy-based-indicator-component";
import { StandardDeviationIndicator } from "./StandardDeviationIndicator";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent Standard Deviation indicator series.
* Default required members: High, Low, Close
*
* `StandardDeviationIndicator` (SDI) measures statistical variation in stock prices or volatility. The difference between an individual security’s closing price and the average security closing price is called the dispersion. The larger the dispersion is the higher the standard deviation will be and therefore the volatility. The smaller the dispersion is (the difference between an individual closing price and the average price), the smaller the standard deviation and the lower the price volatility.
*
* Using this indicator requires setting both the `HighMemberPath`, `LowMemberPath` and `CloseMemberPath`.
*
* ```html
* <igx-data-chart
* width=500px
* height=500px
* [dataSource]="data" >
* <igx-ordinal-time-x-axis
* dateTimeMemberPath="TimeStamp"
* #xAxis>
* </igx-ordinal-time-x-axis>
* <igx-numeric-y-axis
* #yAxis></igx-numeric-y-axis>
* <igx-standard-deviation-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* closeMemberPath="Close"
* highMemberPath="High"
* lowMemberPath="Low">
* </igx-standard-deviation-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxStandardDeviatioIndicatorComponent();
* series.xAxis = this.xAxis;
* series.yAxis = this.yAxis;
* series.highMemberPath = "high";
* series.lowMemberPath = "low";
* series.closeMemberPath = "close";
* this.chart.series.add(series);
*
* ```
*/
export declare class IgxStandardDeviationIndicatorComponent extends IgxStrategyBasedIndicatorComponent {
protected createImplementation(): StandardDeviationIndicator;
/**
* @hidden
*/
get i(): StandardDeviationIndicator;
constructor();
/**
* Gets or sets the moving average period for the current StandardDeviationIndicator object.
* The typical, and initial, value for STDEV periods is 20.
*/
get period(): number;
set period(v: number);
static ngAcceptInputType_period: number | string;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxStandardDeviationIndicatorComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxStandardDeviationIndicatorComponent, "igx-standard-deviation-indicator", never, { "period": "period"; }, {}, never, never>;
}