igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
89 lines (88 loc) • 3.85 kB
TypeScript
import { IgxStrategyBasedIndicatorComponent } from "./igx-strategy-based-indicator-component";
import { SlowStochasticOscillatorIndicator } from "./SlowStochasticOscillatorIndicator";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent Slow Stochastic Oscillator indicator series.
* Default required members: High, Low, Close
*
* `SlowStochasticOscillatorIndicator` (SSO) displays the closing price relative to the high-low range over a given period of time. There are three types of Stochastic Oscillators: Fast, Slow, and Full. The Stochastic Oscillator is a momentum indicator that shows the relation of the current close price relative to the high/low range over a given time period using a scale of 0 to 100. It is based on the premise that prices will close near 100 in a rising market and closer to 0 in a declining market.
*
* The Fast Stochastic Oscillator Indicator is used to identify buying or selling divergences. The Slow Stochastic Oscillator uses a 3-day SMA and the Full Stochastic Oscillator is the Slow Stochastic Oscillator with time period.
*
* Using this indicator requires setting both the `HighMemberPath`, `LowMemberPath` and `VolumeMemberPath`.
*
* ```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-slow-stochastic-oscillator-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* volumeMemberPath="Volume"
* highMemberPath="High"
* lowMemberPath="Low">
* </igx-slow-stochastic-oscillator-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxSlowStochasticOscillatorIndicatorComponent();
* series.xAxis = this.xAxis;
* series.yAxis = this.yAxis;
* series.volumeMemberPath = "Volume";
* series.highMemberPath = "high";
* series.lowMemberPath = "low";
* this.chart.series.add(series);
* ```
*/
export declare class IgxSlowStochasticOscillatorIndicatorComponent extends IgxStrategyBasedIndicatorComponent {
protected createImplementation(): SlowStochasticOscillatorIndicator;
/**
* @hidden
*/
get i(): SlowStochasticOscillatorIndicator;
constructor();
/**
* Gets or sets the moving average period for the current SlowStochasticOscillatorIndicator object.
* The typical, and initial, value for SlowStochasticOscillatorIndicator periods is 14.
*
* ```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-slow-stochastic-oscillator-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* closeMemberPath="Close"
* highMemberPath="High"
* lowMemberPath="Low"
* period=10>
* </igx-slow-stochastic-oscillator-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxSlowStochasticOscillatorIndicatorComponent();
* series.period=10;
* ```
*/
get period(): number;
set period(v: number);
static ngAcceptInputType_period: number | string;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxSlowStochasticOscillatorIndicatorComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxSlowStochasticOscillatorIndicatorComponent, "igx-slow-stochastic-oscillator-indicator", never, { "period": "period"; }, {}, never, never>;
}