igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
105 lines (104 loc) • 3.57 kB
TypeScript
import { IgxStrategyBasedIndicatorComponent } from "./igx-strategy-based-indicator-component";
import { BollingerBandWidthIndicator } from "./BollingerBandWidthIndicator";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent Bollinger Bandwidth indicator series.
* Represents the normalized width of the Bollinger bands for each provided value.
* For more info see:
* BollingerBandsOverlay
* Default required members: High, Low, Close
*
* You can use the `BollingerBandWidthIndicator` to represents a IgxDataChartComponent Bollinger Bandwidth indicator series.
*
* ```html
* <igx-data-chart
* #chart
* [dataSource]="data" >
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-bollinger-band-width-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close">
* </igx-bollinger-band-width-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxBollingerBandWidthIndicatorComponent();
* 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 IgxBollingerBandWidthIndicatorComponent extends IgxStrategyBasedIndicatorComponent {
protected createImplementation(): BollingerBandWidthIndicator;
/**
* @hidden
*/
get i(): BollingerBandWidthIndicator;
constructor();
/**
* Gets or sets the moving average period for the Bollinger Band Width Indicator.
* The typical, and initial, value for CCI periods is 20.
*
* You can use the `Period` to set the moving average.
*
* ```html
* <igx-data-chart
* #chart
* [dataSource]="data" >
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-bollinger-band-width-indicator
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close"
* period="14">
* </igx-bollinger-band-width-indicator>
* </igx-data-chart>
* ```
*
* ```ts
* this.series.period = 14;
* ```
*/
get period(): number;
set period(v: number);
static ngAcceptInputType_period: number | string;
/**
* Gets or sets the multiplier for the Bollinger Band width.
* The typical, and initial, value for Bollinger Band width multiplier is 2.
*
* Use the `Multiplier` property for the Bollinger Band width. The typical, and initial, value for Bollinger Band width multiplier is 2.
*
* ```ts
* this.series.multiplier = 14;
* ```
*/
get multiplier(): number;
set multiplier(v: number);
static ngAcceptInputType_multiplier: number | string;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxBollingerBandWidthIndicatorComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxBollingerBandWidthIndicatorComponent, "igx-bollinger-band-width-indicator", never, { "period": "period"; "multiplier": "multiplier"; }, {}, never, never>;
}