ag-charts-types/dist/types/src/chartBuilderOptions.d.ts

Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue

import type { AgInitialStateOptions } from './api/initialStateOptions';
import type { AgBaseCartesianChartOptions } from './chart/cartesianOptions';
import type { AgBaseChartOptions } from './chart/chartOptions';
import type { AgDataTransaction } from './chart/dataTransaction';
import type { AgBasePolarChartOptions } from './chart/polarOptions';
import type { AgBaseChartThemeOptions, AgBaseGaugePresetThemeOptions, AgChartTheme, AgChartThemeName } from './chart/themeOptions';
import type { ContextDefault, DatumDefault, PixelSize } from './chart/types';
import type { AgFinancialChartPresets } from './presets/financial/financialOptions';
import type { AgGaugePresets } from './presets/gauge/gaugeOptions';
import type { AgLinearGaugePreset } from './presets/gauge/linearGaugeOptions';
import type { AgRadialGaugePreset } from './presets/gauge/radialGaugeOptions';
import type { AgSparklineBaseThemeableOptions, AgSparklinePresets } from './presets/sparkline/sparklineOptions';
import type { AgBaseFlowProportionChartOptions } from './series/standalone/flowProportionOptions';
import type { AgBaseHierarchyChartOptions } from './series/standalone/hierarchyOptions';
import type { AgBaseStandaloneChartOptions } from './series/standalone/standaloneOptions';
import type { AgBaseTopologyChartOptions } from './series/topology/topologyOptions';
export interface AgChartThemeOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseChartThemeOptions<TDatum, TContext> {
}
export interface AgCartesianChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseCartesianChartOptions<TDatum, TContext>, AgBaseChartOptions<TDatum, TContext> {
    /**
     * A predefined theme name or an object containing theme overrides.
     *
     *
     * See: [Themes Reference](/themes-api/)
     */
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export interface AgPolarChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBasePolarChartOptions<TDatum, TContext>, AgBaseChartOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export interface AgTopologyChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseTopologyChartOptions<TDatum, TContext>, AgBaseChartOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export interface AgStandaloneChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseStandaloneChartOptions<TDatum, TContext>, AgBaseChartOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export interface AgGaugeChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseChartOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export interface AgHierarchyChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseHierarchyChartOptions<TDatum, TContext>, AgBaseChartOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export interface AgFlowProportionChartOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseFlowProportionChartOptions<TDatum, TContext>, AgBaseChartOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export type AgChartOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgCartesianChartOptions<TDatum, TContext> | AgPolarChartOptions<TDatum, TContext> | AgTopologyChartOptions<TDatum, TContext> | AgStandaloneChartOptions<TDatum, TContext>;
export type AgBaseFinancialPresetOptions<TDatum = DatumDefault> = Pick<AgCartesianChartOptions<TDatum, never>, 'container' | 'width' | 'height' | 'minWidth' | 'minHeight' | 'theme' | 'title' | 'initialState' | 'data' | 'listeners' | 'formatter'>;
export type AgBaseSparklinePresetThemeOptions<TDatum = DatumDefault> = AgSparklineBaseThemeableOptions<TDatum> & Pick<AgCartesianChartOptions<TDatum, never>, 'background' | 'container' | 'height' | 'listeners' | 'locale' | 'minHeight' | 'minWidth' | 'padding' | 'width' | 'data'>;
export type AgFinancialChartOptions<TDatum = DatumDefault> = AgBaseFinancialPresetOptions<TDatum> & AgFinancialChartPresets;
export interface AgBaseGaugePresetOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseGaugePresetThemeOptions<TDatum, TContext> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
    /** The element to place the rendered chart into. */
    container?: HTMLElement | null;
}
export type AgLinearGaugeOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgBaseGaugePresetOptions<TDatum, TContext> & AgLinearGaugePreset<TContext>;
export type AgRadialGaugeOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgBaseGaugePresetOptions<TDatum, TContext> & AgRadialGaugePreset<TContext>;
export type AgGaugeOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgBaseGaugePresetOptions<TDatum, TContext> & AgGaugePresets<TContext>;
export interface AgBaseSparklinePresetOptions<TDatum = DatumDefault, TContext = ContextDefault> extends AgBaseSparklinePresetThemeOptions<TDatum> {
    theme?: AgChartTheme<TDatum, TContext> | AgChartThemeName;
}
export type AgSparklineOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgBaseSparklinePresetOptions<TDatum, TContext> & AgSparklinePresets<TDatum>;
export type AgPresetOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgFinancialChartOptions<TDatum> | AgGaugeOptions<TDatum, TContext> | AgSparklineOptions<TDatum, TContext>;
export type AgChartInstanceOptions<TDatum = DatumDefault, TContext = ContextDefault> = AgChartOptions<TDatum, TContext> | AgPresetOptions<TDatum, TContext>;
type DeepPartial<T> = T extends Array<unknown> ? T : T extends object ? {
    [K in keyof T]?: DeepPartial<T[K]>;
} : T;
export interface AgTypedChartInstance<TDatum, TContext, O extends AgChartInstanceOptions<TDatum, TContext>> {
    /**
     * Update an existing `AgChartInstance`. Options provided should be complete and not
     * partial.
     *
     * @returns a `Promise` that resolves once the requested change has been rendered.
     *
     * __Note:__ As each call could trigger a chart redraw, multiple calls in
     * quick succession could result in undesirable flickering. Callers should batch up and/or
     * debounce changes to avoid unintended partial update renderings.
     */
    update(options: O): Promise<void>;
    /**
     * Update an existing `AgChartInstance` by applying a partial set of option changes.
     *
     * @returns a `Promise` that resolves once the requested change has been rendered.
     *
     * __Note:__ As each call could trigger a chart redraw, each individual delta options update
     * should leave the chart in a valid options state.
     *
     * Also, multiple calls in  quick succession could result in undesirable flickering. Callers
     * should batch up and/or debounce changes to avoid unintended partial update renderings.
     */
    updateDelta(deltaOptions: DeepPartial<O>): Promise<void>;
    /**
     * Apply a transaction to incrementally update the chart data without replacing the entire dataset.
     *
     * @returns a `Promise` that resolves once the transaction has been applied and rendered
     */
    applyTransaction(transaction: AgDataTransaction<TDatum>): Promise<void>;
    /** Get the `AgChartOptions` representing the current chart configuration. */
    getOptions(): O;
    /** @returns a `Promise` that resolves once any pending changes have been rendered. */
    waitForUpdate(): Promise<void>;
    /**
     * Starts a browser-based image download for the given `AgChartInstance`.
     *
     * @returns a `Promise` that resolves once the download has been initiated.
     */
    download(options?: DownloadOptions): Promise<void>;
    /** Reset animation state; treat the next AgChartInstance.update() as-if the chart is being created from scratch. */
    resetAnimations(): void;
    /** Skip animations on the next redraw. */
    skipAnimations(): void;
    /** Returns a base64-encoded image data URL for the given `AgChartInstance`.*/
    getImageDataURL(options?: ImageDataUrlOptions): Promise<string>;
    /** Returns a representation of the current state of the given `AgChartInstance`. */
    getState(): AgChartState;
    /** Sets the state of the given `AgChartInstance` to the state provided.*/
    setState(state: AgChartState): Promise<void>;
    /** Destroy the chart instance and any allocated resources supporting its rendering. */
    destroy(): void;
}
export interface AgChartInstance<TOptions extends AgChartInstanceOptions<DatumDefault, ContextDefault> = AgChartOptions<DatumDefault, ContextDefault>> extends AgTypedChartInstance<DatumDefault, ContextDefault, TOptions> {
}
export interface DownloadOptions extends ImageDataUrlOptions {
    /** Name of downloaded image file. Defaults to `image`.  */
    fileName?: string;
}
export interface ImageDataUrlOptions {
    /** Width of downloaded chart image in pixels. Defaults to current chart width. */
    width?: PixelSize;
    /** Height of downloaded chart image in pixels. Defaults to current chart height. */
    height?: PixelSize;
    /** A MIME-type string indicating the image format. The default format type is `image/png`. Options: `image/png`, `image/jpeg`.  */
    fileFormat?: string;
}
export interface AgChartState extends AgInitialStateOptions {
    version: string;
}
export {};