devextreme/viz/chart.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

/**
* DevExtreme (viz/chart.d.ts)
* Version: 20.1.7
* Build date: Tue Aug 25 2020
*
* Copyright (c) 2012 - 2020 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import '../jquery_augmentation';

import {
    dxElement
} from '../core/element';

import {
    event
} from '../events/index';

import {
    format
} from '../ui/widget/ui.widget';

import {
    BaseChart,
    BaseChartLegend,
    BaseChartOptions,
    BaseChartTooltip,
    BaseChartAnnotationConfig
} from './chart_components/base_chart';

import {
    ChartSeries,
    ScaleBreak,
    VizRange,
    ChartSeriesType,
    DashStyleType,
    TimeIntervalType,
    HatchingDirectionType
} from './common';

import {
    Font,
    WordWrapType,
    VizTextOverflowType
} from './core/base_widget';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export type ChartSingleValueSeriesAggregationMethodType = 'avg' | 'count' | 'max' | 'min' | 'sum' | 'custom';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface baseLabelObject {
    /** Gets the parameters of the label's minimum bounding rectangle (MBR). */
    getBoundingRect(): any;
    /** Hides the point label. */
    hide(): void;
    /** Hides the point label and keeps it invisible until the show() method is called. */
    hide(holdInvisible: boolean): void;
    /** Checks whether the point label is visible. */
    isVisible(): boolean;
    /** Shows the point label. */
    show(): void;
    /** Shows the point label and keeps it visible until the hide() method is called. */
    show(holdVisible: boolean): void;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface basePointObject {
    /** Switches the point from the hover state back to normal. */
    clearHover(): void;
    /** Deselects the point. */
    clearSelection(): void;
    /** Contains the data object that the series point represents. */
    data?: any;
    /** Provides information about the state of the point object. */
    fullState?: number;
    /** Gets the color of a particular point. */
    getColor(): string;
    /** Allows you to obtain the label(s) of the series point. */
    getLabel(): baseLabelObject & Array<baseLabelObject>;
    /** Hides the tooltip of the point. */
    hideTooltip(): void;
    /** Switches the point into the hover state, the same as when a user places the mouse pointer on it. */
    hover(): void;
    /** Provides information about the hover state of a point. */
    isHovered(): boolean;
    /** Provides information about the selection state of a point. */
    isSelected(): boolean;
    /** Returns the point's argument value that was set in the data source. */
    originalArgument?: string | number | Date;
    /** Returns the point's value that was set in the data source. */
    originalValue?: string | number | Date;
    /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */
    select(): void;
    /** Returns the series object to which the point belongs. */
    series?: any;
    /** Shows the tooltip of the point. */
    showTooltip(): void;
    /** Returns the tag of the point. */
    tag?: any;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface baseSeriesObject {
    /** Switches the series from the hover state back to normal. */
    clearHover(): void;
    /** Cancels the selection of this particular series. The series is displayed in its initial style. */
    clearSelection(): void;
    /** Deselects the specified point. The point is displayed in an initial style. */
    deselectPoint(point: basePointObject): void;
    /** Provides information about the state of the series object. */
    fullState?: number;
    /** Gets all points in the series. */
    getAllPoints(): Array<basePointObject>;
    /** Gets the color of a particular series. */
    getColor(): string;
    /** Gets a series point with the specified index. */
    getPointByPos(positionIndex: number): basePointObject;
    /** Gets a series point with the specified argument value. */
    getPointsByArg(pointArg: number | string | Date): Array<basePointObject>;
    /** Gets visible series points. */
    getVisiblePoints(): Array<basePointObject>;
    /** Hides a series at runtime. */
    hide(): void;
    /** Switches the series into the hover state, the same as when a user places the mouse pointer on it. */
    hover(): void;
    /** Provides information about the hover state of a series. */
    isHovered(): boolean;
    /** Provides information about the selection state of a series. */
    isSelected(): boolean;
    /** Provides information about the visibility state of a series. */
    isVisible(): boolean;
    /** Returns the name of the series. */
    name?: any;
    /** Selects the series. */
    select(): void;
    /** Selects the specified point. The point is displayed in a 'selected' style. */
    selectPoint(point: basePointObject): void;
    /** Makes a particular series visible. */
    show(): void;
    /** Returns the tag of the series. */
    tag?: any;
    /** Returns the type of the series. */
    type?: string;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface chartAxisObject {
    /** Gets the axis' displayed range. */
    visualRange(): VizRange;
    /** Sets the axis's displayed range. */
    visualRange(visualRange: Array<number | string | Date> | VizRange): void;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface chartPointAggregationInfoObject {
    /** Contains the length of the aggregation interval in axis units (numbers or dates). If the interval is set in pixels (using the aggregationGroupWidth option), it will be converted to axis units. */
    aggregationInterval?: any;
    /** Contains data objects that were aggregated into this point. */
    data?: Array<any>;
    /** Contains the end value of the interval to which the point belongs. */
    intervalEnd?: any;
    /** Contains the start value of the interval to which the point belongs. */
    intervalStart?: any;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface chartPointObject extends basePointObject {
    /** Provides information about the aggregation interval and the data objects that fall within it. */
    aggregationInfo?: chartPointAggregationInfoObject;
    /** Gets the parameters of the point's minimum bounding rectangle (MBR). */
    getBoundingRect(): any;
    /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
    originalCloseValue?: number | string;
    /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
    originalHighValue?: number | string;
    /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
    originalLowValue?: number | string;
    /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */
    originalMinValue?: string | number | Date;
    /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
    originalOpenValue?: number | string;
    /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */
    size?: number | string;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface chartSeriesObject extends baseSeriesObject {
    /** Returns the name of the value axis of the series. */
    axis?: string;
    /** The name of the series' barOverlapGroup. */
    barOverlapGroup?: string;
    /** Gets the argument axis to which the series belongs. */
    getArgumentAxis(): chartAxisObject;
    /** Gets the value axis to which the series belongs. */
    getValueAxis(): chartAxisObject;
    /** Returns the name of the series pane. */
    pane?: string;
    /** The name of the series' stack. */
    stack?: string;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartOptions extends BaseChartOptions<dxChart> {
    /** Specifies whether to adjust the value axis's visualRange when the argument axis is being zoomed or panned. */
    adjustOnZoom?: boolean;
    /** Specifies the annotation collection. */
    annotations?: Array<dxChartAnnotationConfig | any>;
    /** Configures the argument axis. */
    argumentAxis?: dxChartArgumentAxis;
    /** Specifies whether to hide series point markers automatically to reduce visual clutter. */
    autoHidePointMarkers?: boolean;
    /** Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth option is set. */
    barGroupPadding?: number;
    /** Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding option. */
    barGroupWidth?: number;
    /** @deprecated Use CommonSeries.barPadding instead. */
/** Controls the width of bars in the widget. Applies only to bar-like series and when the equalBarWidth option is true. */
    barWidth?: number;
    /** Specifies settings common for all annotations in the chart. */
    commonAnnotationSettings?: dxChartCommonAnnotationConfig;
    /** Defines common settings for both the argument and value axis in a chart. */
    commonAxisSettings?: dxChartCommonAxisSettings;
    /** Defines common settings for all panes in a chart. */
    commonPaneSettings?: dxChartCommonPaneSettings;
    /** Specifies settings common for all series in the chart. */
    commonSeriesSettings?: dxChartCommonSeriesSettings;
    /** Colors the background of the chart container. */
    containerBackgroundColor?: string;
    /** Configures the crosshair feature. */
    crosshair?: { color?: string, dashStyle?: DashStyleType, enabled?: boolean, horizontalLine?: { color?: string, dashStyle?: DashStyleType, label?: { backgroundColor?: string, customizeText?: ((info: { value?: Date | number | string, valueText?: string, point?: chartPointObject }) => string), font?: Font, format?: format, visible?: boolean }, opacity?: number, visible?: boolean, width?: number } | boolean, label?: { backgroundColor?: string, customizeText?: ((info: { value?: Date | number | string, valueText?: string, point?: chartPointObject }) => string), font?: Font, format?: format, visible?: boolean }, opacity?: number, verticalLine?: { color?: string, dashStyle?: DashStyleType, label?: { backgroundColor?: string, customizeText?: ((info: { value?: Date | number | string, valueText?: string, point?: chartPointObject }) => string), font?: Font, format?: format, visible?: boolean }, opacity?: number, visible?: boolean, width?: number } | boolean, width?: number };
    /** Customizes an individual annotation. */
    customizeAnnotation?: ((annotation: dxChartAnnotationConfig | any) => dxChartAnnotationConfig);
    /** Processes data before visualizing it. */
    dataPrepareSettings?: { checkTypeForAllData?: boolean, convertToAxisDataType?: boolean, sortingMethod?: boolean | ((a: any, b: any) => number) };
    /** Specifies which pane should be used by default. */
    defaultPane?: string;
    /** @deprecated Use CommonSeries.ignoreEmptyPoints instead. */
/** Specifies whether all bars should have equal width, even if some values are missing from a series. Applies only to bar-like series. */
    equalBarWidth?: boolean;
    /** Specifies the options of a chart's legend. */
    legend?: dxChartLegend;
    /** Specifies a coefficient determining the diameter of the largest bubble. */
    maxBubbleSize?: number;
    /** Specifies the diameter of the smallest bubble measured in pixels. */
    minBubbleSize?: number;
    /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */
    negativesAsZeroes?: boolean;
    /** A function that is executed when a label on the argument axis is clicked or tapped. */
    onArgumentAxisClick?: ((e: { component?: dxChart, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, argument?: Date | number | string }) => any) | string;
    /** A function that is executed when a legend item is clicked or tapped. */
    onLegendClick?: ((e: { component?: dxChart, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, target?: chartSeriesObject }) => any) | string;
    /** A function that is executed when a series is clicked or tapped. */
    onSeriesClick?: ((e: { component?: dxChart, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, target?: chartSeriesObject }) => any) | string;
    /** A function that is executed after the pointer enters or leaves a series. */
    onSeriesHoverChanged?: ((e: { component?: dxChart, element?: dxElement, model?: any, target?: chartSeriesObject }) => any);
    /** A function that is executed when a series is selected or selection is canceled. */
    onSeriesSelectionChanged?: ((e: { component?: dxChart, element?: dxElement, model?: any, target?: chartSeriesObject }) => any);
    /** A function that is executed when zooming or panning ends. */
    onZoomEnd?: ((e: { component?: dxChart, element?: dxElement, model?: any, event?: event, rangeStart?: Date | number, rangeEnd?: Date | number, axis?: chartAxisObject, range?: VizRange, previousRange?: VizRange, cancel?: boolean, actionType?: 'zoom' | 'pan', zoomFactor?: number, shift?: number }) => any);
    /** A function that is executed when zooming or panning begins. */
    onZoomStart?: ((e: { component?: dxChart, element?: dxElement, model?: any, event?: event, axis?: chartAxisObject, range?: VizRange, cancel?: boolean, actionType?: 'zoom' | 'pan' }) => any);
    /** Declares a collection of panes. */
    panes?: dxChartPanes | Array<dxChartPanes>;
    /** Specifies whether panes can be resized if other chart elements require more space after zooming or panning. */
    resizePanesOnZoom?: boolean;
    /** Specifies how the chart must behave when series point labels overlap. */
    resolveLabelOverlapping?: 'hide' | 'none' | 'stack';
    /** Swaps the axes around making the value axis horizontal and the argument axis vertical. */
    rotated?: boolean;
    /** Specifies the settings of the scroll bar. */
    scrollBar?: { color?: string, offset?: number, opacity?: number, position?: 'bottom' | 'left' | 'right' | 'top', visible?: boolean, width?: number };
    /** @deprecated Use the zoomAndPan option instead. */
/** Enables scrolling in your chart. */
    scrollingMode?: 'all' | 'mouse' | 'none' | 'touch';
    /** Specifies options for Chart widget series. */
    series?: ChartSeries | Array<ChartSeries>;
    /** Specifies whether a single series or multiple series can be selected in the chart. */
    seriesSelectionMode?: 'multiple' | 'single';
    /** Defines options for the series template. */
    seriesTemplate?: { customizeSeries?: ((seriesName: any) => ChartSeries), nameField?: string };
    /** Specifies whether a point should remain in the hover state when the mouse pointer moves away. */
    stickyHovering?: boolean;
    /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */
    synchronizeMultiAxes?: boolean;
    /** Configures tooltips. */
    tooltip?: dxChartTooltip;
    /** @deprecated Use CommonSeries.aggregation.enabled instead. */
/** Specifies whether or not to filter the series points depending on their quantity. */
    useAggregation?: boolean;
    /** Configures the value axis. */
    valueAxis?: dxChartValueAxis | Array<dxChartValueAxis>;
    /** Configures zooming and panning. */
    zoomAndPan?: { allowMouseWheel?: boolean, allowTouchGestures?: boolean, argumentAxis?: 'both' | 'none' | 'pan' | 'zoom', dragBoxStyle?: { color?: string, opacity?: number }, dragToZoom?: boolean, panKey?: 'alt' | 'ctrl' | 'meta' | 'shift', valueAxis?: 'both' | 'none' | 'pan' | 'zoom' };
    /** @deprecated Use the zoomAndPan option instead. */
/** Enables zooming in your chart. */
    zoomingMode?: 'all' | 'mouse' | 'none' | 'touch';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxis extends dxChartCommonAxisSettings {
    /** Aggregates series points that fall into the same category. */
    aggregateByCategory?: boolean;
    /** Specifies the length of aggregation intervals in pixels. Does not apply if aggregateByCategory is true. May be ignored in favor of the aggregationInterval option. */
    aggregationGroupWidth?: number;
    /** Specifies the length of aggregation intervals in axis units. Applies only to axes of continuous and logarithmic types. */
    aggregationInterval?: number | any | TimeIntervalType;
    /** Casts arguments to a specified data type. */
    argumentType?: 'datetime' | 'numeric' | 'string';
    /** Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the "continuous" and "logarithmic" types. */
    axisDivisionFactor?: number;
    /** Declares a scale break collection. Applies only if the axis' type is "continuous" or "logarithmic". */
    breaks?: Array<ScaleBreak>;
    /** Specifies the order of categories on an axis of the "discrete" type. */
    categories?: Array<number | string | Date>;
    /** Specifies the appearance of those constant lines that belong to the argument axis. */
    constantLineStyle?: dxChartArgumentAxisConstantLineStyle;
    /** Declares a collection of constant lines belonging to the argument axis. */
    constantLines?: Array<dxChartArgumentAxisConstantLines>;
    /** Specifies whether to force the axis to start and end on ticks. */
    endOnTick?: boolean;
    /** Dates to be excluded from the axis when workdaysOnly is true. */
    holidays?: Array<Date | string> | Array<number>;
    /** Specifies chart elements to be highlighted when a user points to an axis label. */
    hoverMode?: 'allArgumentPoints' | 'none';
    /** Configures the labels of the argument axis. */
    label?: dxChartArgumentAxisLabel;
    /** Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes. */
    linearThreshold?: number;
    /** Specifies the value to be raised to a power when generating ticks for an axis of the "logarithmic" type. */
    logarithmBase?: number;
    /** @deprecated Use the argumentAxis.visualRange option instead. */
/** Coupled with the min option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */
    max?: number | Date | string;
    /** @deprecated Use the argumentAxis.visualRange option instead. */
/** Coupled with the max option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */
    min?: number | Date | string;
    /** Specifies the minimum length of the visual range. */
    minVisualRangeLength?: number | any | TimeIntervalType;
    /** Specifies how many minor ticks to place between two neighboring major ticks. */
    minorTickCount?: number;
    /** Specifies the interval between minor ticks. Applies only to the axes of the "continuous" type. */
    minorTickInterval?: number | any | TimeIntervalType;
    /** Relocates the argument axis. */
    position?: 'bottom' | 'left' | 'right' | 'top';
    /** Specifies the position of the argument axis on the value axis. */
    customPosition?: number | Date | string;
    /** Specifies the name of a value axis on which the argument axis should be positioned. Applies only to multi-axis charts. */
    customPositionAxis?: string;
    /** Specifies the shift in pixels of the argument axis. */
    offset?: number;
    /** Dates to be included on the axis when workdaysOnly is true. */
    singleWorkdays?: Array<Date | string> | Array<number>;
    /** Declares a collection of strips belonging to the argument axis. */
    strips?: Array<dxChartArgumentAxisStrips>;
    /** Specifies the interval between major ticks. */
    tickInterval?: number | any | TimeIntervalType;
    /** Configures the axis title. */
    title?: dxChartArgumentAxisTitle;
    /** Specifies the type of the argument axis. */
    type?: 'continuous' | 'discrete' | 'logarithmic';
    /** Defines the axis' displayed range. Cannot be wider than the wholeRange. */
    visualRange?: VizRange | Array<number | string | Date>;
    /** Specifies how the axis's visual range should behave when chart data is updated. */
    visualRangeUpdateMode?: 'auto' | 'keep' | 'reset' | 'shift';
    /** Defines the range where the axis can be zoomed and panned. */
    wholeRange?: VizRange | Array<number | string | Date>;
    /** Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true. */
    workWeek?: Array<number>;
    /** Leaves only workdays on the axis: the work week days plus single workdays minus holidays. Applies only if the axis' argumentType is "datetime". */
    workdaysOnly?: boolean;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisConstantLineStyle extends dxChartCommonAxisSettingsConstantLineStyle {
    /** Specifies the appearance of the labels of those constant lines that belong to the argument axis. */
    label?: dxChartArgumentAxisConstantLineStyleLabel;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisConstantLineStyleLabel extends dxChartCommonAxisSettingsConstantLineStyleLabel {
    /** Aligns constant line labels in the horizontal direction. */
    horizontalAlignment?: 'center' | 'left' | 'right';
    /** Aligns constant line labels in the vertical direction. */
    verticalAlignment?: 'bottom' | 'center' | 'top';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisConstantLines extends dxChartCommonAxisSettingsConstantLineStyle {
    /** Specifies whether to display the constant line behind or in front of the series. */
    displayBehindSeries?: boolean;
    /** Specifies whether to extend the axis's default visual range to display the constant line. */
    extendAxis?: boolean;
    /** Configures the constant line label. */
    label?: dxChartArgumentAxisConstantLinesLabel;
    /** Specifies the value indicated by a constant line. Setting this option is necessary. */
    value?: number | Date | string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisConstantLinesLabel extends dxChartCommonAxisSettingsConstantLineStyleLabel {
    /** Aligns constant line labels in the horizontal direction. */
    horizontalAlignment?: 'center' | 'left' | 'right';
    /** Specifies the text of a constant line label. By default, equals to the value of the constant line. */
    text?: string;
    /** Aligns constant line labels in the vertical direction. */
    verticalAlignment?: 'bottom' | 'center' | 'top';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisLabel extends dxChartCommonAxisSettingsLabel {
    /** Specifies the hint that appears when a user points to an axis label. */
    customizeHint?: ((argument: { value?: Date | number | string, valueText?: string }) => string);
    /** Customizes the text displayed by axis labels. */
    customizeText?: ((argument: { value?: Date | number | string, valueText?: string }) => string);
    /** Formats a value before it is displayed in an axis label. */
    format?: format;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisStrips extends dxChartCommonAxisSettingsStripStyle {
    /** Specifies the color of the strip. */
    color?: string;
    /** Along with the startValue option, limits the strip. */
    endValue?: number | Date | string;
    /** Configures the strip label. */
    label?: dxChartArgumentAxisStripsLabel;
    /** Along with the endValue option, limits the strip. */
    startValue?: number | Date | string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisStripsLabel extends dxChartCommonAxisSettingsStripStyleLabel {
    /** Specifies the text of the strip label. */
    text?: string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartArgumentAxisTitle extends dxChartCommonAxisSettingsTitle {
    /** Specifies the text of the axis title. */
    text?: string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettings {
    /** Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only. */
    allowDecimals?: boolean;
    /** Configures the scale breaks' appearance. */
    breakStyle?: { color?: string, line?: 'straight' | 'waved', width?: number };
    /** Specifies the color of the axis line. */
    color?: string;
    /** Configures the appearance of all constant lines in the widget. */
    constantLineStyle?: dxChartCommonAxisSettingsConstantLineStyle;
    /** Specifies whether ticks and grid lines should cross axis labels or lie between them. Applies only to the axes of the "discrete" type. */
    discreteAxisDivisionMode?: 'betweenLabels' | 'crossLabels';
    /** Specifies whether to force the axis to start and end on ticks. */
    endOnTick?: boolean;
    /** Configures the grid. */
    grid?: { color?: string, opacity?: number, visible?: boolean, width?: number };
    /** Inverts the axis. */
    inverted?: boolean;
    /** Configures axis labels. */
    label?: dxChartCommonAxisSettingsLabel;
    /** Controls the empty space between the maximum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */
    maxValueMargin?: number;
    /** Controls the empty space between the minimum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */
    minValueMargin?: number;
    /** Configures the minor grid. */
    minorGrid?: { color?: string, opacity?: number, visible?: boolean, width?: number };
    /** Configures the appearance of minor axis ticks. */
    minorTick?: { color?: string, length?: number, opacity?: number, shift?: number, visible?: boolean, width?: number };
    /** Specifies how transparent the axis line should be. */
    opacity?: number;
    /** Reserves a pixel-measured space for the axis. */
    placeholderSize?: number;
    /** Configures the appearance of strips. */
    stripStyle?: dxChartCommonAxisSettingsStripStyle;
    /** Configures the appearance of major axis ticks. */
    tick?: { color?: string, length?: number, opacity?: number, shift?: number, visible?: boolean, width?: number };
    /** Configures axis titles. */
    title?: dxChartCommonAxisSettingsTitle;
    /** Adds an empty space between the axis and the minimum and maximum series points. */
    valueMarginsEnabled?: boolean;
    /** Makes the axis line visible. */
    visible?: boolean;
    /** Specifies the width of the axis line in pixels. */
    width?: number;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettingsConstantLineStyle {
    /** Specifies the color of constant lines. */
    color?: string;
    /** Specifies the dash style of constant lines. */
    dashStyle?: DashStyleType;
    /** Configures constant line labels. */
    label?: dxChartCommonAxisSettingsConstantLineStyleLabel;
    /** Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label. */
    paddingLeftRight?: number;
    /** Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label. */
    paddingTopBottom?: number;
    /** Specifies the width of constant lines in pixels. */
    width?: number;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettingsConstantLineStyleLabel {
    /** Specifies font options for constant line labels. */
    font?: Font;
    /** Specifies the position of constant line labels on the chart plot. */
    position?: 'inside' | 'outside';
    /** Makes constant line labels visible. */
    visible?: boolean;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettingsLabel {
    /** Aligns axis labels in relation to ticks. */
    alignment?: 'center' | 'left' | 'right';
    /** Allows you to rotate or stagger axis labels. Applies to the horizontal axis only. */
    displayMode?: 'rotate' | 'stagger' | 'standard';
    /** Specifies font options for axis labels. */
    font?: Font;
    /** Adds a pixel-measured empty space between an axis and its labels. */
    indentFromAxis?: number;
    /** Decides how to arrange axis labels when there is not enough space to keep all of them. */
    overlappingBehavior?: 'rotate' | 'stagger' | 'none' | 'hide';
    /**  */
    position?: 'inside' | 'outside' | 'bottom' | 'left' | 'right' | 'top';
    /** Specifies the rotation angle of axis labels. Applies only if displayMode or overlappingBehavior is "rotate". */
    rotationAngle?: number;
    /** Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if displayMode or overlappingBehavior is "stagger". */
    staggeringSpacing?: number;
    /** Specifies what to do with axis labels that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */
    textOverflow?: VizTextOverflowType;
    /** Shows/hides axis labels. */
    visible?: boolean;
    /** Specifies how to wrap texts that do not fit into a single line. */
    wordWrap?: WordWrapType;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettingsStripStyle {
    /** Configures the appearance of strip labels. */
    label?: dxChartCommonAxisSettingsStripStyleLabel;
    /** Generates a pixel-measured empty space between the left/right border of a strip and the strip label. */
    paddingLeftRight?: number;
    /** Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label. */
    paddingTopBottom?: number;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettingsStripStyleLabel {
    /** Specifies font options for strip labels. */
    font?: Font;
    /** Aligns strip labels in the horizontal direction. */
    horizontalAlignment?: 'center' | 'left' | 'right';
    /** Aligns strip labels in the vertical direction. */
    verticalAlignment?: 'bottom' | 'center' | 'top';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAxisSettingsTitle {
    /** Aligns the axis title to the left, center, or right of the axis. */
    alignment?: 'center' | 'left' | 'right';
    /** Specifies font options for the axis title. */
    font?: Font;
    /** Adds a pixel-measured empty space between the axis title and axis labels. */
    margin?: number;
    /** Specifies what to do with the axis title when it overflows the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */
    textOverflow?: VizTextOverflowType;
    /** Specifies how to wrap the axis title if it does not fit into a single line. */
    wordWrap?: WordWrapType;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonPaneSettings {
    /** Specifies the color of the pane's background. */
    backgroundColor?: string;
    /** Configures the pane border. */
    border?: { bottom?: boolean, color?: string, dashStyle?: DashStyleType, left?: boolean, opacity?: number, right?: boolean, top?: boolean, visible?: boolean, width?: number };
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonSeriesSettings extends dxChartSeriesTypesCommonSeries {
    /** Defines common settings for all area series. */
    area?: any;
    /** Defines common settings for all bar series. */
    bar?: any;
    /** Defines common settings for all bubble series. */
    bubble?: any;
    /** Defines common settings for all candlestick series. */
    candlestick?: any;
    /** Defines common settings for all full-stacked area series. */
    fullstackedarea?: any;
    /** Defines common settings for all full-stacked bar series. */
    fullstackedbar?: any;
    /** Defines common settings for all full-stacked line series. */
    fullstackedline?: any;
    /** Defines common settings for all full-stacked spline series. */
    fullstackedspline?: any;
    /** Defines common settings for all full-stacked spline area series. */
    fullstackedsplinearea?: any;
    /** Defines common settings for all line series. */
    line?: any;
    /** Defines common settings for all range area series. */
    rangearea?: any;
    /** Defines common settings for all range bar series. */
    rangebar?: any;
    /** Defines common settings for all scatter series. */
    scatter?: any;
    /** Defines common settings for all spline series. */
    spline?: any;
    /** Defines common settings for all spline area series. */
    splinearea?: any;
    /** Defines common settings for all stacked area series. */
    stackedarea?: any;
    /** Defines common settings for all stacked bar series. */
    stackedbar?: any;
    /** Defines common settings for all stacked line series. */
    stackedline?: any;
    /** Defines common settings for all stacked spline series. */
    stackedspline?: any;
    /** Defines common settings for all stacked spline area series. */
    stackedsplinearea?: any;
    /** Defines common settings for all step area series. */
    steparea?: any;
    /** Defines common settings for all step line series. */
    stepline?: any;
    /** Defines common settings for all stock series. */
    stock?: any;
    /** Specifies the type of the series. */
    type?: ChartSeriesType;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartLegend extends BaseChartLegend {
    /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */
    customizeHint?: ((seriesInfo: { seriesName?: any, seriesIndex?: number, seriesColor?: string }) => string);
    /** Specifies a callback function that returns the text to be displayed by a legend item. */
    customizeText?: ((seriesInfo: { seriesName?: any, seriesIndex?: number, seriesColor?: string }) => string);
    /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */
    hoverMode?: 'excludePoints' | 'includePoints' | 'none';
    /** Specifies whether the legend is located outside or inside the chart's plot. */
    position?: 'inside' | 'outside';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartPanes extends dxChartCommonPaneSettings {
    /** Specifies the pane's height (or width when the chart is rotated) in a multi-pane chart. */
    height?: number | string;
    /** Specifies the name of the pane. */
    name?: string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartTooltip extends BaseChartTooltip {
    /** Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only. */
    location?: 'center' | 'edge';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxis extends dxChartCommonAxisSettings {
    /** Enables auto-calculated scale breaks. Applies only if the axis' type is "continuous" or "logarithmic" and valueType is "numeric". */
    autoBreaksEnabled?: boolean;
    /** Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the "continuous" and "logarithmic" types. */
    axisDivisionFactor?: number;
    /** Declares a custom scale break collection. Applies only if the axis' type is "continuous" or "logarithmic". */
    breaks?: Array<ScaleBreak>;
    /** Specifies the order of categories on an axis of the "discrete" type. */
    categories?: Array<number | string | Date>;
    /** Specifies the appearance of those constant lines that belong to the value axis. */
    constantLineStyle?: dxChartValueAxisConstantLineStyle;
    /** Declares a collection of constant lines belonging to the value axis. */
    constantLines?: Array<dxChartValueAxisConstantLines>;
    /** Specifies whether to force the axis to start and end on ticks. */
    endOnTick?: boolean;
    /** Configures the labels of the value axis. */
    label?: dxChartValueAxisLabel;
    /** Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes. */
    linearThreshold?: number;
    /** Specifies the value to be raised to a power when generating ticks for an axis of the "logarithmic" type. */
    logarithmBase?: number;
    /** @deprecated Use the valueAxis.visualRange option instead. */
/** Coupled with the min option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */
    max?: number | Date | string;
    /** Sets a limit on auto-calculated scale breaks. Custom scale breaks are not counted. */
    maxAutoBreakCount?: number;
    /** @deprecated Use the valueAxis.visualRange option instead. */
/** Coupled with the max option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */
    min?: number | Date | string;
    /** Specifies the minimum length of the visual range. */
    minVisualRangeLength?: number | any | TimeIntervalType;
    /** Specifies how many minor ticks to place between two neighboring major ticks. */
    minorTickCount?: number;
    /** Specifies the interval between minor ticks. Applies only to continuous axes. */
    minorTickInterval?: number | any | TimeIntervalType;
    /** Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart. */
    multipleAxesSpacing?: number;
    /** Specifies the name of the value axis. */
    name?: string;
    /** Binds the value axis to a pane. */
    pane?: string;
    /** Relocates the value axis. */
    position?: 'bottom' | 'left' | 'right' | 'top';
    /** Specifies the position of the value axis on the argument axis. */
    customPosition?: number | Date | string;
    /** Specifies the shift in pixels of the value axis. */
    offset?: number;
    /** Specifies whether or not to show zero on the value axis. */
    showZero?: boolean;
    /** Declares a collection of strips belonging to the value axis. */
    strips?: Array<dxChartValueAxisStrips>;
    /** Synchronizes two or more value axes with each other at a specific value. */
    synchronizedValue?: number;
    /** Specifies the interval between major ticks. Does not apply to discrete axes. */
    tickInterval?: number | any | TimeIntervalType;
    /** Configures the axis title. */
    title?: dxChartValueAxisTitle;
    /** Specifies the type of the value axis. */
    type?: 'continuous' | 'discrete' | 'logarithmic';
    /** Casts values to a specified data type. */
    valueType?: 'datetime' | 'numeric' | 'string';
    /** Defines the axis' displayed range. Cannot be wider than the wholeRange. */
    visualRange?: VizRange | Array<number | string | Date>;
    /** Specifies how the axis's visual range should behave when chart data is updated. */
    visualRangeUpdateMode?: 'auto' | 'keep' | 'reset' | 'shift';
    /** Defines the range where the axis can be zoomed and panned. */
    wholeRange?: VizRange | Array<number | string | Date>;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisConstantLineStyle extends dxChartCommonAxisSettingsConstantLineStyle {
    /** Specifies the appearance of the labels of those constant lines that belong to the value axis. */
    label?: dxChartValueAxisConstantLineStyleLabel;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisConstantLineStyleLabel extends dxChartCommonAxisSettingsConstantLineStyleLabel {
    /** Aligns constant line labels in the horizontal direction. */
    horizontalAlignment?: 'center' | 'left' | 'right';
    /** Aligns constant line labels in the vertical direction. */
    verticalAlignment?: 'bottom' | 'center' | 'top';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisConstantLines extends dxChartCommonAxisSettingsConstantLineStyle {
    /** Specifies whether to display the constant line behind or in front of the series. */
    displayBehindSeries?: boolean;
    /** Specifies whether to extend the axis's default visual range to display the constant line. */
    extendAxis?: boolean;
    /** Configures the constant line label. */
    label?: dxChartValueAxisConstantLinesLabel;
    /** Specifies the value indicated by a constant line. Setting this option is necessary. */
    value?: number | Date | string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisConstantLinesLabel extends dxChartCommonAxisSettingsConstantLineStyleLabel {
    /** Aligns constant line labels in the horizontal direction. */
    horizontalAlignment?: 'center' | 'left' | 'right';
    /** Specifies the text of a constant line label. By default, equals to the value of the constant line. */
    text?: string;
    /** Aligns constant line labels in the vertical direction. */
    verticalAlignment?: 'bottom' | 'center' | 'top';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisLabel extends dxChartCommonAxisSettingsLabel {
    /** Specifies the hint that appears when a user points to an axis label. */
    customizeHint?: ((axisValue: { value?: Date | number | string, valueText?: string }) => string);
    /** Customizes the text displayed by axis labels. */
    customizeText?: ((axisValue: { value?: Date | number | string, valueText?: string }) => string);
    /** Formats a value before it is displayed in an axis label. */
    format?: format;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisStrips extends dxChartCommonAxisSettingsStripStyle {
    /** Specifies the color of the strip. */
    color?: string;
    /** Along with the startValue option, limits the strip. */
    endValue?: number | Date | string;
    /** Configures the strip label. */
    label?: dxChartValueAxisStripsLabel;
    /** Along with the endValue option, limits the strip. */
    startValue?: number | Date | string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisStripsLabel extends dxChartCommonAxisSettingsStripStyleLabel {
    /** Specifies the text of the strip label. */
    text?: string;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartValueAxisTitle extends dxChartCommonAxisSettingsTitle {
    /** Specifies the text of the axis title. */
    text?: string;
}
/** The Chart is a widget that visualizes data from a local or remote storage using a great variety of series types along with different interactive elements, such as tooltips, crosshair pointer, legend, etc. */
export default class dxChart extends BaseChart {
    constructor(element: Element, options?: dxChartOptions)
    constructor(element: JQuery, options?: dxChartOptions)
    
    getArgumentAxis(): chartAxisObject;
    
    getValueAxis(): chartAxisObject;
    
    getValueAxis(name: string): chartAxisObject;
    
    resetVisualRange(): void;
    
    zoomArgument(startValue: number | Date | string, endValue: number | Date | string): void;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartAnnotationConfig extends dxChartCommonAnnotationConfig {
    /** Specifies the annotation's name. */
    name?: string;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartCommonAnnotationConfig extends BaseChartAnnotationConfig {
    /** Specifies the name of the value axis on which the value is specified. Useful for a multi-axis chart. */
    axis?: string;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartSeriesTypes {
    /** Describes settings supported by a series of the area type. */
    AreaSeries?: dxChartSeriesTypesAreaSeries;
    /** Describes settings supported by a series of the bar type. */
    BarSeries?: dxChartSeriesTypesBarSeries;
    /** Describes settings supported by a series of the bubble type. */
    BubbleSeries?: dxChartSeriesTypesBubbleSeries;
    /** Describes settings supported by a series of the candlestick type. */
    CandleStickSeries?: dxChartSeriesTypesCandleStickSeries;
    /** Warning! This type is used for internal purposes. Do not import it directly. */
/** An object that defines configuration options for chart series. */
    CommonSeries?: dxChartSeriesTypesCommonSeries;
    /** Describes settings supported by a series of the full-stacked area type. */
    FullStackedAreaSeries?: dxChartSeriesTypesFullStackedAreaSeries;
    /** Describes settings supported by a series of the full-stacked bar type. */
    FullStackedBarSeries?: dxChartSeriesTypesFullStackedBarSeries;
    /** Describes settings supported by a series of the full-stacked line type. */
    FullStackedLineSeries?: dxChartSeriesTypesFullStackedLineSeries;
    /** Describes settings supported by a series of the full-stacked spline area type. */
    FullStackedSplineAreaSeries?: dxChartSeriesTypesFullStackedSplineAreaSeries;
    /** Describes settings supported by a series of the full-stacked spline area type. An object defining a series of the fullStackedSpline type. */
    FullStackedSplineSeries?: dxChartSeriesTypesFullStackedSplineSeries;
    /** Describes settings supported by a series of the line type. */
    LineSeries?: dxChartSeriesTypesLineSeries;
    /** Describes settings supported by a series of the range area type. */
    RangeAreaSeries?: dxChartSeriesTypesRangeAreaSeries;
    /** Describes settings supported by a series of the range bar type. */
    RangeBarSeries?: dxChartSeriesTypesRangeBarSeries;
    /** Describes settings supported by a series of the scatter type. */
    ScatterSeries?: dxChartSeriesTypesScatterSeries;
    /** Describes settings supported by a series of the spline area type. */
    SplineAreaSeries?: dxChartSeriesTypesSplineAreaSeries;
    /** Describes settings supported by a series of the spline type. */
    SplineSeries?: dxChartSeriesTypesSplineSeries;
    /** Describes settings supported by a series of the stacked area type. */
    StackedAreaSeries?: dxChartSeriesTypesStackedAreaSeries;
    /** Describes settings supported by a series of the stacked bar type. */
    StackedBarSeries?: dxChartSeriesTypesStackedBarSeries;
    /** Describes settings supported by a series of the stacked line type. */
    StackedLineSeries?: dxChartSeriesTypesStackedLineSeries;
    /** Describes settings supported by a series of the stacked spline area type. */
    StackedSplineAreaSeries?: dxChartSeriesTypesStackedSplineAreaSeries;
    /** Describes settings supported by a series of the stacked spline type. */
    StackedSplineSeries?: dxChartSeriesTypesStackedSplineSeries;
    /** Describes settings supported by a series of the step rea type. */
    StepAreaSeries?: dxChartSeriesTypesStepAreaSeries;
    /** Describes settings supported by a series of the step line type. */
    StepLineSeries?: dxChartSeriesTypesStepLineSeries;
    /** Describes settings supported by a series of the stock type. */
    StockSeries?: dxChartSeriesTypesStockSeries;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxChartSeriesTypesAreaSeries extends dxChartSeriesTypesCommonSeries {
    /** Configures data aggregation for the series. */
    aggregation?: dxChartSeriesTypesAreaSeriesAggregation;
    /** Specifies series elements to be highlighted when a user points to a series. */
    hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none';
    /** Configures point labels. */
    label?: dxChartSeriesTypesAreaSeriesLabel;
    /** Configures se