igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
165 lines (164 loc) • 5.7 kB
TypeScript
import { IgxStrategyBasedIndicatorComponent } from "./igx-strategy-based-indicator-component";
import { FullStochasticOscillatorIndicator } from "./FullStochasticOscillatorIndicator";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent Full Stochastic Oscillator indicator series.
* Default required members: High, Low, Close
*
* The `FullStochasticOscillatorIndicator` class represents a IgxDataChartComponent Full Stochastic Oscillator indicator series.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data">
* <igx-category-x-axis
* label="label"
* #xAxis
* >
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-full-stochastic-oscillator-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close">
* </gx-full-stochastic-oscillator-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxFullStochasticOscillatorIndicatorComponent();
* series.xAxis = this.xAxis;
* series.yAxis = this.yAxis;
* series.openMemberPath = "open";
* series.highMemberPath = "high";
* series.lowMemberPath = "low";
* series.closeMemberPath = "close";
* this.chart.series.add(series);
* ```
*/
export declare class IgxFullStochasticOscillatorIndicatorComponent extends IgxStrategyBasedIndicatorComponent {
protected createImplementation(): FullStochasticOscillatorIndicator;
/**
* @hidden
*/
get i(): FullStochasticOscillatorIndicator;
constructor();
/**
* Gets or sets the moving average period for the current FullStochasticOscillatorIndicator object.
* The typical, and initial, value for FullStochasticOscillatorIndicator periods is 14.
*
* You can use the `period` property for the moving average period of the current FullStochasticOscillatorIndicator object.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data">
* <igx-category-x-axis
* label="label"
* #xAxis
* >
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-full-stochastic-oscillator-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close"
* period=30>
* </gx-full-stochastic-oscillator-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* this.series.period = 30;
* ```
*/
get period(): number;
set period(v: number);
static ngAcceptInputType_period: number | string;
/**
* Gets or sets the moving average SmoothingPeriod for the current FullStochasticOscillatorIndicator object.
* The typical, and initial, value for FullStochasticOscillatorIndicator SmoothingPeriod is 3.
*
* The `SmoothingPeriod` property to fets/sets the moving average SmoothingPeriod for the current FullStochasticOscillatorIndicator object.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data">
* <igx-category-x-axis
* label="label"
* #xAxis
* >
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-full-stochastic-oscillator-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close"
* [smoothingPeriod]=30>
* </gx-full-stochastic-oscillator-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* series.smoothingPeriod=30;
* ```
*/
get smoothingPeriod(): number;
set smoothingPeriod(v: number);
static ngAcceptInputType_smoothingPeriod: number | string;
/**
* Gets or sets the moving average TriggerPeriod for the current FullStochasticOscillatorIndicator object.
* The typical, and initial, value for FullStochasticOscillatorIndicator TriggerPeriod is 3.
*
* You can use the `period` to set the current moving average period.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data">
* <igx-category-x-axis
* label="label"
* #xAxis
* >
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-full-stochastic-oscillator-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close"
* [triggerPeriod]=30>
* </gx-full-stochastic-oscillator-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* this.series.triggerPeriod = 30;
* ```
*/
get triggerPeriod(): number;
set triggerPeriod(v: number);
static ngAcceptInputType_triggerPeriod: number | string;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxFullStochasticOscillatorIndicatorComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxFullStochasticOscillatorIndicatorComponent, "igx-full-stochastic-oscillator-indicator", never, { "period": "period"; "smoothingPeriod": "smoothingPeriod"; "triggerPeriod": "triggerPeriod"; }, {}, never, never>;
}