igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
102 lines (101 loc) • 3.55 kB
TypeScript
import { IgPoint } from "igniteui-angular-core";
import { IgxFinancialOverlayComponent } from "./igx-financial-overlay-component";
import { BollingerBandsOverlay } from "./BollingerBandsOverlay";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent Bollinger Bands financial overlay series.
* Default required members: High, Low, Close
*
* You can use the `BollingerBandsOverlay` class represents a IgxDataChartComponent Bollinger Bands financial overlay 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-overlay
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close">
* </igx-bollinger-band-overlay>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxBollingerBandOverlayComponent();
* 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 IgxBollingerBandsOverlayComponent extends IgxFinancialOverlayComponent {
protected createImplementation(): BollingerBandsOverlay;
/**
* @hidden
*/
get i(): BollingerBandsOverlay;
constructor();
/**
* Gets or sets the moving average period for the current BollingerBandOverlay object.
* The typical, and initial, value for Bollinger band periods is 14.
*
* You can use the `period` property for moving average of the current BollingerBandOverlay object.
*
* ```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-overlay
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* openMemberPath="open"
* highMemberPath="high"
* lowMemberPath="low"
* closeMemberPath="close"
* period="7">
* </igx-bollinger-band-overlay>
* </igx-data-chart>
* ```
*
* ```ts
* this.series.period = 7;
* ```
*/
get period(): number;
set period(v: number);
static ngAcceptInputType_period: number | string;
/**
* Gets or sets the moving average period for the current BollingerBandOverlay object.
* The typical, and initial, value for Bollinger band multipliers is 2.
*
* You can use the `BollingerBandsOverlay`
*/
get multiplier(): number;
set multiplier(v: number);
static ngAcceptInputType_multiplier: number | string;
getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number;
getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number;
getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxBollingerBandsOverlayComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxBollingerBandsOverlayComponent, "igx-bollinger-bands-overlay", never, { "period": "period"; "multiplier": "multiplier"; }, {}, never, never>;
}