devextreme

/** * DevExtreme (viz/chart.d.ts) * Version: 19.2.6 * Build date: Thu Jan 30 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 { template } from '../core/templates/template'; import { event } from '../events'; import { format } from '../ui/widget/ui.widget'; import { BaseChart, BaseChartLegend, BaseChartOptions, BaseChartTooltip } from './chart_components/base_chart'; import { ChartSeries, ScaleBreak, VizRange } from './common'; import { Font } from './core/base_widget'; /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface baseLabelObject { /** * @docid baseLabelObjectMethods.getBoundingRect * @publicName getBoundingRect() * @return object * @prevFileNamespace DevExpress.viz * @public */ getBoundingRect(): any; /** * @docid baseLabelObjectMethods.hide * @publicName hide() * @prevFileNamespace DevExpress.viz * @public */ hide(): void; /** * @docid baseLabelObjectMethods.hide * @publicName hide(holdInvisible) * @param1 holdInvisible:boolean * @prevFileNamespace DevExpress.viz * @public */ hide(holdInvisible: boolean): void; /** * @docid baseLabelObjectMethods.isVisible * @publicName isVisible() * @return boolean * @prevFileNamespace DevExpress.viz * @public */ isVisible(): boolean; /** * @docid baseLabelObjectMethods.show * @publicName show() * @prevFileNamespace DevExpress.viz * @public */ show(): void; /** * @docid baseLabelObjectMethods.show * @publicName show(holdVisible) * @param1 holdVisible:boolean * @prevFileNamespace DevExpress.viz * @public */ show(holdVisible: boolean): void; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface basePointObject { /** * @docid basePointObjectMethods.clearHover * @publicName clearHover() * @prevFileNamespace DevExpress.viz * @public */ clearHover(): void; /** * @docid basePointObjectMethods.clearSelection * @publicName clearSelection() * @prevFileNamespace DevExpress.viz * @public */ clearSelection(): void; /** * @docid basePointObjectFields.data * @type any * @prevFileNamespace DevExpress.viz * @public */ data?: any; /** * @docid basePointObjectFields.fullState * @type number * @prevFileNamespace DevExpress.viz * @public */ fullState?: number; /** * @docid basePointObjectMethods.getColor * @publicName getColor() * @return string * @prevFileNamespace DevExpress.viz * @public */ getColor(): string; /** * @docid basePointObjectMethods.getLabel * @publicName getLabel() * @return baseLabelObject|Array<baseLabelObject> * @prevFileNamespace DevExpress.viz * @public */ getLabel(): baseLabelObject & Array<baseLabelObject>; /** * @docid basePointObjectMethods.hideTooltip * @publicName hideTooltip() * @prevFileNamespace DevExpress.viz * @public */ hideTooltip(): void; /** * @docid basePointObjectMethods.hover * @publicName hover() * @prevFileNamespace DevExpress.viz * @public */ hover(): void; /** * @docid basePointObjectMethods.isHovered * @publicName isHovered() * @return boolean * @prevFileNamespace DevExpress.viz * @public */ isHovered(): boolean; /** * @docid basePointObjectMethods.isSelected * @publicName isSelected() * @return boolean * @prevFileNamespace DevExpress.viz * @public */ isSelected(): boolean; /** * @docid basePointObjectFields.originalArgument * @type string|number|date * @prevFileNamespace DevExpress.viz * @public */ originalArgument?: string | number | Date; /** * @docid basePointObjectFields.originalValue * @type string|number|date * @prevFileNamespace DevExpress.viz * @public */ originalValue?: string | number | Date; /** * @docid basePointObjectMethods.select * @publicName select() * @prevFileNamespace DevExpress.viz * @public */ select(): void; /** * @docid basePointObjectFields.series * @type object * @prevFileNamespace DevExpress.viz * @public */ series?: any; /** * @docid basePointObjectMethods.showTooltip * @publicName showTooltip() * @prevFileNamespace DevExpress.viz * @public */ showTooltip(): void; /** * @docid basePointObjectFields.tag * @type any * @prevFileNamespace DevExpress.viz * @public */ tag?: any; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface baseSeriesObject { /** * @docid baseSeriesObjectMethods.clearHover * @publicName clearHover() * @prevFileNamespace DevExpress.viz * @public */ clearHover(): void; /** * @docid baseSeriesObjectMethods.clearSelection * @publicName clearSelection() * @prevFileNamespace DevExpress.viz * @public */ clearSelection(): void; /** * @docid baseSeriesObjectMethods.deselectPoint * @publicName deselectPoint(point) * @param1 point:basePointObject * @prevFileNamespace DevExpress.viz * @public */ deselectPoint(point: basePointObject): void; /** * @docid baseSeriesObjectFields.fullState * @type number * @prevFileNamespace DevExpress.viz * @public */ fullState?: number; /** * @docid baseSeriesObjectMethods.getAllPoints * @publicName getAllPoints() * @return Array<basePointObject> * @prevFileNamespace DevExpress.viz * @public */ getAllPoints(): Array<basePointObject>; /** * @docid baseSeriesObjectMethods.getColor * @publicName getColor() * @return string * @prevFileNamespace DevExpress.viz * @public */ getColor(): string; /** * @docid baseSeriesObjectMethods.getPointByPos * @publicName getPointByPos(positionIndex) * @param1 positionIndex:number * @return basePointObject * @prevFileNamespace DevExpress.viz * @public */ getPointByPos(positionIndex: number): basePointObject; /** * @docid baseSeriesObjectMethods.getPointsByArg * @publicName getPointsByArg(pointArg) * @param1 pointArg:number|string|date * @return Array<basePointObject> * @prevFileNamespace DevExpress.viz * @public */ getPointsByArg(pointArg: number | string | Date): Array<basePointObject>; /** * @docid baseSeriesObjectMethods.getVisiblePoints * @publicName getVisiblePoints() * @return Array<basePointObject> * @prevFileNamespace DevExpress.viz * @public */ getVisiblePoints(): Array<basePointObject>; /** * @docid baseSeriesObjectMethods.hide * @publicName hide() * @prevFileNamespace DevExpress.viz * @public */ hide(): void; /** * @docid baseSeriesObjectMethods.hover * @publicName hover() * @prevFileNamespace DevExpress.viz * @public */ hover(): void; /** * @docid baseSeriesObjectMethods.isHovered * @publicName isHovered() * @return boolean * @prevFileNamespace DevExpress.viz * @public */ isHovered(): boolean; /** * @docid baseSeriesObjectMethods.isSelected * @publicName isSelected() * @return boolean * @prevFileNamespace DevExpress.viz * @public */ isSelected(): boolean; /** * @docid baseSeriesObjectMethods.isVisible * @publicName isVisible() * @return boolean * @prevFileNamespace DevExpress.viz * @public */ isVisible(): boolean; /** * @docid baseSeriesObjectFields.name * @type any * @prevFileNamespace DevExpress.viz * @public */ name?: any; /** * @docid baseSeriesObjectMethods.select * @publicName select() * @prevFileNamespace DevExpress.viz * @public */ select(): void; /** * @docid baseSeriesObjectMethods.selectPoint * @publicName selectPoint(point) * @param1 point:basePointObject * @prevFileNamespace DevExpress.viz * @public */ selectPoint(point: basePointObject): void; /** * @docid baseSeriesObjectMethods.show * @publicName show() * @prevFileNamespace DevExpress.viz * @public */ show(): void; /** * @docid baseSeriesObjectFields.tag * @type any * @prevFileNamespace DevExpress.viz * @public */ tag?: any; /** * @docid baseSeriesObjectFields.type * @type string * @prevFileNamespace DevExpress.viz * @public */ type?: string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface chartAxisObject { /** * @docid chartAxisObjectMethods.visualRange * @publicName visualRange() * @return VizRange * @prevFileNamespace DevExpress.viz * @public */ visualRange(): VizRange; /** * @docid chartAxisObjectMethods.visualRange * @publicName visualRange(visualRange) * @param1 visualRange:Array<number,string,Date> | VizRange * @prevFileNamespace DevExpress.viz * @public */ visualRange(visualRange: Array<number | string | Date> | VizRange): void; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface chartPointAggregationInfoObject { /** * @docid chartPointAggregationInfoObject.aggregationInterval * @type any * @prevFileNamespace DevExpress.viz * @public */ aggregationInterval?: any; /** * @docid chartPointAggregationInfoObject.data * @type Array<any> * @prevFileNamespace DevExpress.viz * @public */ data?: Array<any>; /** * @docid chartPointAggregationInfoObject.intervalEnd * @type any * @prevFileNamespace DevExpress.viz * @public */ intervalEnd?: any; /** * @docid chartPointAggregationInfoObject.intervalStart * @type any * @prevFileNamespace DevExpress.viz * @public */ intervalStart?: any; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface chartPointObject extends basePointObject { /** * @docid chartPointObjectFields.aggregationInfo * @type chartPointAggregationInfoObject * @prevFileNamespace DevExpress.viz * @public */ aggregationInfo?: chartPointAggregationInfoObject; /** * @docid chartPointObjectmethods.getBoundingRect * @publicName getBoundingRect() * @return object * @prevFileNamespace DevExpress.viz * @public */ getBoundingRect(): any; /** * @docid chartPointObjectFields.originalCloseValue * @type number|string * @prevFileNamespace DevExpress.viz * @public */ originalCloseValue?: number | string; /** * @docid chartPointObjectFields.originalHighValue * @type number|string * @prevFileNamespace DevExpress.viz * @public */ originalHighValue?: number | string; /** * @docid chartPointObjectFields.originalLowValue * @type number|string * @prevFileNamespace DevExpress.viz * @public */ originalLowValue?: number | string; /** * @docid chartPointObjectFields.originalMinValue * @type string|number|date * @prevFileNamespace DevExpress.viz * @public */ originalMinValue?: string | number | Date; /** * @docid chartPointObjectFields.originalOpenValue * @type number|string * @prevFileNamespace DevExpress.viz * @public */ originalOpenValue?: number | string; /** * @docid chartPointObjectFields.size * @type number|string * @prevFileNamespace DevExpress.viz * @public */ size?: number | string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface chartSeriesObject extends baseSeriesObject { /** * @docid chartSeriesObjectFields.axis * @type string * @prevFileNamespace DevExpress.viz * @public */ axis?: string; /** * @docid chartSeriesObjectFields.barOverlapGroup * @type string * @prevFileNamespace DevExpress.viz * @public */ barOverlapGroup?: string; /** * @docid chartSeriesObjectMethods.getArgumentAxis * @publicName getArgumentAxis() * @return chartAxisObject * @prevFileNamespace DevExpress.viz * @public */ getArgumentAxis(): chartAxisObject; /** * @docid chartSeriesObjectMethods.getValueAxis * @publicName getValueAxis() * @return chartAxisObject * @prevFileNamespace DevExpress.viz * @public */ getValueAxis(): chartAxisObject; /** * @docid chartSeriesObjectFields.pane * @type string * @prevFileNamespace DevExpress.viz * @public */ pane?: string; /** * @docid chartSeriesObjectFields.stack * @type string * @prevFileNamespace DevExpress.viz * @public */ stack?: string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartOptions extends BaseChartOptions<dxChart> { /** * @docid dxChartOptions.adjustOnZoom * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ adjustOnZoom?: boolean; /** * @docid dxChartOptions.annotations * @type Array<dxChartAnnotationConfig,object> * @inherits dxChartOptions.commonAnnotationSettings * @prevFileNamespace DevExpress.viz * @public */ annotations?: Array<dxChartAnnotationConfig | any>; /** * @docid dxChartOptions.argumentAxis * @type object * @inherits dxChartOptions.commonAxisSettings * @prevFileNamespace DevExpress.viz * @public */ argumentAxis?: dxChartArgumentAxis; /** * @docid dxChartOptions.autoHidePointMarkers * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ autoHidePointMarkers?: boolean; /** * @docid dxChartOptions.barGroupPadding * @type number * @default 0.3 * @propertyOf dxChartSeriesTypes.BarSeries,dxChartSeriesTypes.StackedBarSeries,dxChartSeriesTypes.FullStackedBarSeries,dxChartSeriesTypes.RangeBarSeries * @prevFileNamespace DevExpress.viz * @public */ barGroupPadding?: number; /** * @docid dxChartOptions.barGroupWidth * @type number * @default undefined * @propertyOf dxChartSeriesTypes.BarSeries,dxChartSeriesTypes.StackedBarSeries,dxChartSeriesTypes.FullStackedBarSeries,dxChartSeriesTypes.RangeBarSeries * @prevFileNamespace DevExpress.viz * @public */ barGroupWidth?: number; /** * @docid dxChartOptions.barWidth * @type number * @deprecated dxChartSeriesTypes.CommonSeries.barPadding * @prevFileNamespace DevExpress.viz * @public */ barWidth?: number; /** * @docid dxChartOptions.commonAnnotationSettings * @type dxChartCommonAnnotationConfig * @prevFileNamespace DevExpress.viz * @public */ commonAnnotationSettings?: dxChartCommonAnnotationConfig; /** * @docid dxChartOptions.commonAxisSettings * @type object * @prevFileNamespace DevExpress.viz * @public */ commonAxisSettings?: dxChartCommonAxisSettings; /** * @docid dxChartOptions.commonPaneSettings * @type object * @prevFileNamespace DevExpress.viz * @public */ commonPaneSettings?: dxChartCommonPaneSettings; /** * @docid dxChartOptions.commonSeriesSettings * @type object * @inherits dxChartSeriesTypes.CommonSeries * @hideDefaults true * @inheritAll * @prevFileNamespace DevExpress.viz * @public */ commonSeriesSettings?: dxChartCommonSeriesSettings; /** * @docid dxChartOptions.containerBackgroundColor * @type string * @default '#FFFFFF' * @prevFileNamespace DevExpress.viz * @public */ containerBackgroundColor?: string; /** * @docid dxChartOptions.crosshair * @type object * @prevFileNamespace DevExpress.viz * @public */ crosshair?: { color?: string, dashStyle?: 'dash' | 'dot' | 'longDash' | 'solid', enabled?: boolean, horizontalLine?: { color?: string, dashStyle?: 'dash' | 'dot' | 'longDash' | 'solid', 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?: 'dash' | 'dot' | 'longDash' | 'solid', 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 }; /** * @docid dxChartOptions.customizeAnnotation * @type function(annotation) * @type_function_param1 annotation:dxChartAnnotationConfig|any * @type_function_return dxChartAnnotationConfig * @default undefined * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ customizeAnnotation?: ((annotation: dxChartAnnotationConfig | any) => dxChartAnnotationConfig); /** * @docid dxChartOptions.dataPrepareSettings * @type object * @prevFileNamespace DevExpress.viz * @public */ dataPrepareSettings?: { checkTypeForAllData?: boolean, convertToAxisDataType?: boolean, sortingMethod?: boolean | ((a: any, b: any) => number) }; /** * @docid dxChartOptions.defaultPane * @type string * @default undefined * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ defaultPane?: string; /** * @docid dxChartOptions.equalBarWidth * @type boolean * @deprecated dxChartSeriesTypes.CommonSeries.ignoreEmptyPoints * @prevFileNamespace DevExpress.viz * @public */ equalBarWidth?: boolean; /** * @docid dxChartOptions.legend * @type object * @prevFileNamespace DevExpress.viz * @public */ legend?: dxChartLegend; /** * @docid dxChartOptions.maxBubbleSize * @default 0.2 * @type number * @propertyOf dxChartSeriesTypes.BubbleSeries * @prevFileNamespace DevExpress.viz * @public */ maxBubbleSize?: number; /** * @docid dxChartOptions.minBubbleSize * @default 12 * @type number * @propertyOf dxChartSeriesTypes.BubbleSeries * @prevFileNamespace DevExpress.viz * @public */ minBubbleSize?: number; /** * @docid dxChartOptions.negativesAsZeroes * @type boolean * @default false * @propertyOf dxChartSeriesTypes.StackedBarSeries,dxChartSeriesTypes.FullStackedBarSeries,dxChartSeriesTypes.StackedAreaSeries,dxChartSeriesTypes.FullStackedAreaSeries,dxChartSeriesTypes.StackedLineSeries,dxChartSeriesTypes.FullStackedLineSeries,dxChartSeriesTypes.StackedSplineSeries,dxChartSeriesTypes.FullStackedSplineSeries,dxChartSeriesTypes.StackedSplineAreaSeries,dxChartSeriesTypes.FullStackedSplineAreaSeries * @prevFileNamespace DevExpress.viz * @public */ negativesAsZeroes?: boolean; /** * @docid dxChartOptions.onArgumentAxisClick * @extends Action * @type function(e)|string * @type_function_param1 e:object * @type_function_param1_field4 jQueryEvent:jQuery.Event:deprecated(event) * @type_function_param1_field5 event:event * @type_function_param1_field6 argument:Date|Number|string * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ onArgumentAxisClick?: ((e: { component?: dxChart, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, argument?: Date | number | string }) => any) | string; /** * @docid dxChartOptions.onLegendClick * @extends Action * @type function(e)|string * @type_function_param1 e:object * @type_function_param1_field4 jQueryEvent:jQuery.Event:deprecated(event) * @type_function_param1_field5 event:event * @type_function_param1_field6 target:chartSeriesObject * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ onLegendClick?: ((e: { component?: dxChart, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, target?: chartSeriesObject }) => any) | string; /** * @docid dxChartOptions.onSeriesClick * @extends Action * @type function(e)|string * @type_function_param1 e:object * @type_function_param1_field4 jQueryEvent:jQuery.Event:deprecated(event) * @type_function_param1_field5 event:event * @type_function_param1_field6 target:chartSeriesObject * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ onSeriesClick?: ((e: { component?: dxChart, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, target?: chartSeriesObject }) => any) | string; /** * @docid dxChartOptions.onSeriesHoverChanged * @extends Action * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 target:chartSeriesObject * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ onSeriesHoverChanged?: ((e: { component?: dxChart, element?: dxElement, model?: any, target?: chartSeriesObject }) => any); /** * @docid dxChartOptions.onSeriesSelectionChanged * @extends Action * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 target:chartSeriesObject * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ onSeriesSelectionChanged?: ((e: { component?: dxChart, element?: dxElement, model?: any, target?: chartSeriesObject }) => any); /** * @docid dxChartOptions.onZoomEnd * @extends Action * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 event:event * @type_function_param1_field5 rangeStart:Date|Number:deprecated(range) * @type_function_param1_field6 rangeEnd:Date|Number:deprecated(range) * @type_function_param1_field7 axis:chartAxisObject * @type_function_param1_field8 range:VizRange * @type_function_param1_field9 previousRange:VizRange * @type_function_param1_field10 cancel:boolean * @type_function_param1_field11 actionType:Enums.ChartZoomPanActionType * @type_function_param1_field12 zoomFactor:Number * @type_function_param1_field13 shift:Number * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ 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); /** * @docid dxChartOptions.onZoomStart * @extends Action * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 event:event * @type_function_param1_field5 axis:chartAxisObject * @type_function_param1_field6 range:VizRange * @type_function_param1_field7 cancel:boolean * @type_function_param1_field8 actionType:Enums.ChartZoomPanActionType * @notUsedInTheme * @action * @prevFileNamespace DevExpress.viz * @public */ onZoomStart?: ((e: { component?: dxChart, element?: dxElement, model?: any, event?: event, axis?: chartAxisObject, range?: VizRange, cancel?: boolean, actionType?: 'zoom' | 'pan' }) => any); /** * @docid dxChartOptions.panes * @type Object|Array<Object> * @inherits dxChartOptions.commonPaneSettings * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ panes?: dxChartPanes | Array<dxChartPanes>; /** * @docid dxChartOptions.resizePanesOnZoom * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ resizePanesOnZoom?: boolean; /** * @docid dxChartOptions.resolveLabelOverlapping * @type Enums.ChartResolveLabelOverlapping * @default "none" * @prevFileNamespace DevExpress.viz * @public */ resolveLabelOverlapping?: 'hide' | 'none' | 'stack'; /** * @docid dxChartOptions.rotated * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ rotated?: boolean; /** * @docid dxChartOptions.scrollBar * @type object * @prevFileNamespace DevExpress.viz * @public */ scrollBar?: { color?: string, offset?: number, opacity?: number, position?: 'bottom' | 'left' | 'right' | 'top', visible?: boolean, width?: number }; /** * @docid dxChartOptions.scrollingMode * @type Enums.ChartPointerType * @default 'none' * @deprecated dxChartOptions.zoomAndPan * @prevFileNamespace DevExpress.viz * @public */ scrollingMode?: 'all' | 'mouse' | 'none' | 'touch'; /** * @docid dxChartOptions.series * @type ChartSeries|Array<ChartSeries> * @default undefined * @hideDefaults true * @notUsedInTheme * @inheritAll * @prevFileNamespace DevExpress.viz * @public */ series?: ChartSeries | Array<ChartSeries>; /** * @docid dxChartOptions.seriesSelectionMode * @type Enums.ChartElementSelectionMode * @default 'single' * @prevFileNamespace DevExpress.viz * @public */ seriesSelectionMode?: 'multiple' | 'single'; /** * @docid dxChartOptions.seriesTemplate * @type object * @default undefined * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ seriesTemplate?: { customizeSeries?: ((seriesName: any) => ChartSeries), nameField?: string }; /** * @docid dxChartOptions.stickyHovering * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ stickyHovering?: boolean; /** * @docid dxChartOptions.synchronizeMultiAxes * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ synchronizeMultiAxes?: boolean; /** * @docid dxChartOptions.tooltip * @type object * @prevFileNamespace DevExpress.viz * @public */ tooltip?: dxChartTooltip; /** * @docid dxChartOptions.useAggregation * @type boolean * @deprecated dxChartSeriesTypes.CommonSeries.aggregation.enabled * @prevFileNamespace DevExpress.viz * @public */ useAggregation?: boolean; /** * @docid dxChartOptions.valueAxis * @type Object|Array<Object> * @inherits dxChartOptions.commonAxisSettings * @prevFileNamespace DevExpress.viz * @public */ valueAxis?: dxChartValueAxis | Array<dxChartValueAxis>; /** * @docid dxChartOptions.zoomAndPan * @type object * @prevFileNamespace DevExpress.viz * @public */ 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' }; /** * @docid dxChartOptions.zoomingMode * @type Enums.ChartPointerType * @default 'none' * @deprecated dxChartOptions.zoomAndPan * @prevFileNamespace DevExpress.viz * @public */ zoomingMode?: 'all' | 'mouse' | 'none' | 'touch'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxis extends dxChartCommonAxisSettings { /** * @docid dxChartOptions.argumentAxis.aggregateByCategory * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ aggregateByCategory?: boolean; /** * @docid dxChartOptions.argumentAxis.aggregationGroupWidth * @type number * @default undefined * @prevFileNamespace DevExpress.viz * @public */ aggregationGroupWidth?: number; /** * @docid dxChartOptions.argumentAxis.aggregationInterval * @inherits VizTimeInterval * @prevFileNamespace DevExpress.viz * @public */ aggregationInterval?: number | any | 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'; /** * @docid dxChartOptions.argumentAxis.argumentType * @type Enums.ChartDataType * @default undefined * @prevFileNamespace DevExpress.viz * @public */ argumentType?: 'datetime' | 'numeric' | 'string'; /** * @docid dxChartOptions.argumentAxis.axisDivisionFactor * @type number * @default 70 * @prevFileNamespace DevExpress.viz * @public */ axisDivisionFactor?: number; /** * @docid dxChartOptions.argumentAxis.breaks * @type Array<ScaleBreak> * @default undefined * @inherits ScaleBreak * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ breaks?: Array<ScaleBreak>; /** * @docid dxChartOptions.argumentAxis.categories * @type Array<number,string,Date> * @prevFileNamespace DevExpress.viz * @public */ categories?: Array<number | string | Date>; /** * @docid dxChartOptions.argumentAxis.constantLineStyle * @type object * @prevFileNamespace DevExpress.viz * @public */ constantLineStyle?: dxChartArgumentAxisConstantLineStyle; /** * @docid dxChartOptions.argumentAxis.constantLines * @type Array<Object> * @inherits dxChartOptions.commonAxisSettings.constantLineStyle * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ constantLines?: Array<dxChartArgumentAxisConstantLines>; /** * @docid dxChartOptions.argumentAxis.endOnTick * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ endOnTick?: boolean; /** * @docid dxChartOptions.argumentAxis.holidays * @type Array<Date, string>| Array<number> * @default undefined * @prevFileNamespace DevExpress.viz * @public */ holidays?: Array<Date | string> | Array<number>; /** * @docid dxChartOptions.argumentAxis.hoverMode * @type Enums.ArgumentAxisHoverMode * @default 'none' * @prevFileNamespace DevExpress.viz * @public */ hoverMode?: 'allArgumentPoints' | 'none'; /** * @docid dxChartOptions.argumentAxis.label * @type object * @prevFileNamespace DevExpress.viz * @public */ label?: dxChartArgumentAxisLabel; /** * @docid dxChartOptions.argumentAxis.linearThreshold * @type number * @default undefined * @prevFileNamespace DevExpress.viz * @public */ linearThreshold?: number; /** * @docid dxChartOptions.argumentAxis.logarithmBase * @type number * @default 10 * @prevFileNamespace DevExpress.viz * @public */ logarithmBase?: number; /** * @docid dxChartOptions.argumentAxis.max * @type number | datetime | string * @deprecated dxChartOptions.argumentAxis.visualRange * @default undefined * @prevFileNamespace DevExpress.viz * @public */ max?: number | Date | string; /** * @docid dxChartOptions.argumentAxis.min * @type number | datetime | string * @deprecated dxChartOptions.argumentAxis.visualRange * @default undefined * @prevFileNamespace DevExpress.viz * @public */ min?: number | Date | string; /** * @docid dxChartOptions.argumentAxis.minVisualRangeLength * @inherits VizTimeInterval * @default undefined * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ minVisualRangeLength?: number | any | 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'; /** * @docid dxChartOptions.argumentAxis.minorTickCount * @type number * @default undefined * @prevFileNamespace DevExpress.viz * @public */ minorTickCount?: number; /** * @docid dxChartOptions.argumentAxis.minorTickInterval * @inherits VizTimeInterval * @prevFileNamespace DevExpress.viz * @public */ minorTickInterval?: number | any | 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'; /** * @docid dxChartOptions.argumentAxis.position * @type Enums.Position * @default 'bottom' * @prevFileNamespace DevExpress.viz * @public */ position?: 'bottom' | 'left' | 'right' | 'top'; /** * @docid dxChartOptions.argumentAxis.singleWorkdays * @type Array<Date, string>| Array<number> * @default undefined * @prevFileNamespace DevExpress.viz * @public */ singleWorkdays?: Array<Date | string> | Array<number>; /** * @docid dxChartOptions.argumentAxis.strips * @type Array<Object> * @notUsedInTheme * @inherits dxChartOptions.commonAxisSettings.stripStyle * @prevFileNamespace DevExpress.viz * @public */ strips?: Array<dxChartArgumentAxisStrips>; /** * @docid dxChartOptions.argumentAxis.tickInterval * @inherits VizTimeInterval * @prevFileNamespace DevExpress.viz * @public */ tickInterval?: number | any | 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'; /** * @docid dxChartOptions.argumentAxis.title * @type string|object * @prevFileNamespace DevExpress.viz * @public */ title?: dxChartArgumentAxisTitle; /** * @docid dxChartOptions.argumentAxis.type * @type Enums.AxisScaleType * @default undefined * @prevFileNamespace DevExpress.viz * @public */ type?: 'continuous' | 'discrete' | 'logarithmic'; /** * @docid dxChartOptions.argumentAxis.visualRange * @type VizRange | Array<number,string,Date> * @fires BaseWidgetOptions.onOptionChanged * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ visualRange?: VizRange | Array<number | string | Date>; /** * @docid dxChartOptions.argumentAxis.visualRangeUpdateMode * @type Enums.VisualRangeUpdateMode * @default 'auto' * @prevFileNamespace DevExpress.viz * @public */ visualRangeUpdateMode?: 'auto' | 'keep' | 'reset' | 'shift'; /** * @docid dxChartOptions.argumentAxis.wholeRange * @type VizRange | Array<number,string,Date> * @default undefined * @prevFileNamespace DevExpress.viz * @public */ wholeRange?: VizRange | Array<number | string | Date>; /** * @docid dxChartOptions.argumentAxis.workWeek * @type Array<number> * @default [1, 2, 3, 4, 5] * @prevFileNamespace DevExpress.viz * @public */ workWeek?: Array<number>; /** * @docid dxChartOptions.argumentAxis.workdaysOnly * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ workdaysOnly?: boolean; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisConstantLineStyle extends dxChartCommonAxisSettingsConstantLineStyle { /** * @docid dxChartOptions.argumentAxis.constantLineStyle.label * @type object * @prevFileNamespace DevExpress.viz * @public */ label?: dxChartArgumentAxisConstantLineStyleLabel; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisConstantLineStyleLabel extends dxChartCommonAxisSettingsConstantLineStyleLabel { /** * @docid dxChartOptions.argumentAxis.constantLineStyle.label.horizontalAlignment * @type Enums.HorizontalAlignment * @default 'right' * @prevFileNamespace DevExpress.viz * @public */ horizontalAlignment?: 'center' | 'left' | 'right'; /** * @docid dxChartOptions.argumentAxis.constantLineStyle.label.verticalAlignment * @type Enums.VerticalAlignment * @default 'top' * @prevFileNamespace DevExpress.viz * @public */ verticalAlignment?: 'bottom' | 'center' | 'top'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisConstantLines extends dxChartCommonAxisSettingsConstantLineStyle { /** * @docid dxChartOptions.argumentAxis.constantLines.displayBehindSeries * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ displayBehindSeries?: boolean; /** * @docid dxChartOptions.argumentAxis.constantLines.extendAxis * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ extendAxis?: boolean; /** * @docid dxChartOptions.argumentAxis.constantLines.label * @type object * @prevFileNamespace DevExpress.viz * @public */ label?: dxChartArgumentAxisConstantLinesLabel; /** * @docid dxChartOptions.argumentAxis.constantLines.value * @type number | datetime | string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ value?: number | Date | string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisConstantLinesLabel extends dxChartCommonAxisSettingsConstantLineStyleLabel { /** * @docid dxChartOptions.argumentAxis.constantLines.label.horizontalAlignment * @type Enums.HorizontalAlignment * @default 'right' * @prevFileNamespace DevExpress.viz * @public */ horizontalAlignment?: 'center' | 'left' | 'right'; /** * @docid dxChartOptions.argumentAxis.constantLines.label.text * @type string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ text?: string; /** * @docid dxChartOptions.argumentAxis.constantLines.label.verticalAlignment * @type Enums.VerticalAlignment * @default 'top' * @prevFileNamespace DevExpress.viz * @public */ verticalAlignment?: 'bottom' | 'center' | 'top'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisLabel extends dxChartCommonAxisSettingsLabel { /** * @docid dxChartOptions.argumentAxis.label.customizeHint * @type function(argument) * @type_function_param1 argument:object * @type_function_param1_field1 value:Date|Number|string * @type_function_param1_field2 valueText:string * @type_function_return string * @prevFileNamespace DevExpress.viz * @public */ customizeHint?: ((argument: { value?: Date | number | string, valueText?: string }) => string); /** * @docid dxChartOptions.argumentAxis.label.customizeText * @type function(argument) * @type_function_param1 argument:object * @type_function_param1_field1 value:Date|Number|string * @type_function_param1_field2 valueText:string * @type_function_return string * @notUsedInTheme * @prevFileNamespace DevExpress.viz * @public */ customizeText?: ((argument: { value?: Date | number | string, valueText?: string }) => string); /** * @docid dxChartOptions.argumentAxis.label.format * @extends CommonVizFormat * @prevFileNamespace DevExpress.viz * @public */ format?: format; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisStrips extends dxChartCommonAxisSettingsStripStyle { /** * @docid dxChartOptions.argumentAxis.strips.color * @type string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ color?: string; /** * @docid dxChartOptions.argumentAxis.strips.endValue * @type number | datetime | string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ endValue?: number | Date | string; /** * @docid dxChartOptions.argumentAxis.strips.label * @type object * @prevFileNamespace DevExpress.viz * @public */ label?: dxChartArgumentAxisStripsLabel; /** * @docid dxChartOptions.argumentAxis.strips.startValue * @type number | datetime | string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ startValue?: number | Date | string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisStripsLabel extends dxChartCommonAxisSettingsStripStyleLabel { /** * @docid dxChartOptions.argumentAxis.strips.label.text * @type string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ text?: string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartArgumentAxisTitle extends dxChartCommonAxisSettingsTitle { /** * @docid dxChartOptions.argumentAxis.title.text * @type string * @default undefined * @prevFileNamespace DevExpress.viz * @public */ text?: string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartCommonAxisSettings { /** * @docid dxChartOptions.commonAxisSettings.allowDecimals * @type boolean * @default undefined * @prevFileNamespace DevExpress.viz * @public */ allowDecimals?: boolean; /** * @docid dxChartOptions.commonAxisSettings.breakStyle * @type object * @prevFileNamespace DevExpress.viz * @public */ breakStyle?: { color?: string, line?: 'straight' | 'waved', width?: number }; /** * @docid dxChartOptions.commonAxisSettings.color * @type string * @default '#767676' * @prevFileNamespace DevExpress.viz * @public */ color?: string; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle * @type object * @prevFileNamespace DevExpress.viz * @public */ constantLineStyle?: dxChartCommonAxisSettingsConstantLineStyle; /** * @docid dxChartOptions.commonAxisSettings.discreteAxisDivisionMode * @type Enums.DiscreteAxisDivisionMode * @default 'betweenLabels' * @prevFileNamespace DevExpress.viz * @public */ discreteAxisDivisionMode?: 'betweenLabels' | 'crossLabels'; /** * @docid dxChartOptions.commonAxisSettings.endOnTick * @type boolean * @default undefined * @prevFileNamespace DevExpress.viz * @public */ endOnTick?: boolean; /** * @docid dxChartOptions.commonAxisSettings.grid * @type object * @prevFileNamespace DevExpress.viz * @public */ grid?: { color?: string, opacity?: number, visible?: boolean, width?: number }; /** * @docid dxChartOptions.commonAxisSettings.inverted * @type boolean * @default false * @prevFileNamespace DevExpress.viz * @public */ inverted?: boolean; /** * @docid dxChartOptions.commonAxisSettings.label * @type object * @prevFileNamespace DevExpress.viz * @public */ label?: dxChartCommonAxisSettingsLabel; /** * @docid dxChartOptions.commonAxisSettings.maxValueMargin * @type number * @default undefined * @prevFileNamespace DevExpress.viz * @public */ maxValueMargin?: number; /** * @docid dxChartOptions.commonAxisSettings.minValueMargin * @type number * @default undefined * @prevFileNamespace DevExpress.viz * @public */ minValueMargin?: number; /** * @docid dxChartOptions.commonAxisSettings.minorGrid * @type object * @prevFileNamespace DevExpress.viz * @public */ minorGrid?: { color?: string, opacity?: number, visible?: boolean, width?: number }; /** * @docid dxChartOptions.commonAxisSettings.minorTick * @type object * @prevFileNamespace DevExpress.viz * @public */ minorTick?: { color?: string, length?: number, opacity?: number, shift?: number, visible?: boolean, width?: number }; /** * @docid dxChartOptions.commonAxisSettings.opacity * @type number * @default undefined * @prevFileNamespace DevExpress.viz * @public */ opacity?: number; /** * @docid dxChartOptions.commonAxisSettings.placeholderSize * @type number * @default null * @prevFileNamespace DevExpress.viz * @public */ placeholderSize?: number; /** * @docid dxChartOptions.commonAxisSettings.stripStyle * @type object * @prevFileNamespace DevExpress.viz * @public */ stripStyle?: dxChartCommonAxisSettingsStripStyle; /** * @docid dxChartOptions.commonAxisSettings.tick * @type object * @prevFileNamespace DevExpress.viz * @public */ tick?: { color?: string, length?: number, opacity?: number, shift?: number, visible?: boolean, width?: number }; /** * @docid dxChartOptions.commonAxisSettings.title * @type object * @prevFileNamespace DevExpress.viz * @public */ title?: dxChartCommonAxisSettingsTitle; /** * @docid dxChartOptions.commonAxisSettings.valueMarginsEnabled * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ valueMarginsEnabled?: boolean; /** * @docid dxChartOptions.commonAxisSettings.visible * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ visible?: boolean; /** * @docid dxChartOptions.commonAxisSettings.width * @type number * @default 1 * @prevFileNamespace DevExpress.viz * @public */ width?: number; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartCommonAxisSettingsConstantLineStyle { /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.color * @type string * @default '#000000' * @prevFileNamespace DevExpress.viz * @public */ color?: string; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.dashStyle * @type Enums.DashStyle * @default 'solid' * @prevFileNamespace DevExpress.viz * @public */ dashStyle?: 'dash' | 'dot' | 'longDash' | 'solid'; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.label * @type object * @prevFileNamespace DevExpress.viz * @public */ label?: dxChartCommonAxisSettingsConstantLineStyleLabel; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.paddingLeftRight * @type number * @default 10 * @prevFileNamespace DevExpress.viz * @public */ paddingLeftRight?: number; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.paddingTopBottom * @type number * @default 10 * @prevFileNamespace DevExpress.viz * @public */ paddingTopBottom?: number; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.width * @type number * @default 1 * @prevFileNamespace DevExpress.viz * @public */ width?: number; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartCommonAxisSettingsConstantLineStyleLabel { /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.label.font * @type Font * @default '#767676' [prop](color) * @prevFileNamespace DevExpress.viz * @public */ font?: Font; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.label.position * @type Enums.RelativePosition * @default 'inside' * @prevFileNamespace DevExpress.viz * @public */ position?: 'inside' | 'outside'; /** * @docid dxChartOptions.commonAxisSettings.constantLineStyle.label.visible * @type boolean * @default true * @prevFileNamespace DevExpress.viz * @public */ visible?: boolean; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxChartCommonAxisSettingsLabel