igniteui-webcomponents-charts
Version:
Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.
48 lines (46 loc) • 1.93 kB
TypeScript
import { IgcFinancialSeriesComponent } from "./igc-financial-series-component";
import { FinancialOverlay } from "./FinancialOverlay";
/**
* Represents the base functionality for a IgxDataChartComponent financial overlay series.
* The difference between a FinancialIndicator and a FinancialOverlay is small.
* Overlays are usually drawn against the same axes as the price, but they don't
* have to be. Overlays mostly display multiple values, but not all of them, and so
* so some indicators.
*
* The `FinancialOverlay` class represents the base functionality for a IgxDataChartComponent financial overlay series.
*/
export declare abstract class IgcFinancialOverlayComponent extends IgcFinancialSeriesComponent {
/**
* @hidden
*/
get i(): FinancialOverlay;
constructor();
connectedCallback(): void;
disconnectedCallback(): void;
private static _observedAttributesIgcFinancialOverlayComponent;
static get observedAttributes(): string[];
/**
* Gets whether the series is financial overlay
*/
get isFinancialOverlay(): boolean;
/**
* Gets or sets the number of values to hide at the beginning of the indicator.
*
* Use the `IgnoreFirst` property to sets the number of values to hide at the beginning of the indicator.
*
* ```ts
* series.ignoreFirst=2;
* ```
*/
get ignoreFirst(): number;
set ignoreFirst(v: number);
/**
* Scrolls the series to display the item for the specified data item.
* The series is scrolled by the minimum amount required to place the specified data item within
* the central 80% of the visible axis.
* @param item * The data item (item) to scroll to.
*
* Use the `ScrollIntoView` method to scrolls the series to display the item for the specified data item.
*/
scrollIntoView(item: any): boolean;
}