;
}
/** This section describes the methods that can be used in code to manipulate the Point object. */
export interface PolarPoint extends BasePoint {
series: PolarSeries;
}
export interface Strip {
/** Specifies a color for a strip. */
color?: string;
/** An object that defines the label configuration options of a strip. */
label?: {
/** Specifies the text displayed in a strip. */
text?: string;
};
/** Specifies a start value for a strip. */
startValue?: any;
/** Specifies an end value for a strip. */
endValue?: any;
}
export interface BaseSeriesConfigLabel {
/** Specifies a format for arguments displayed by point labels. */
argumentFormat?: string;
/** Specifies a precision for formatted point arguments displayed in point labels. */
argumentPrecision?: number;
/** Specifies a background color for point labels. */
backgroundColor?: string;
/** Specifies border options for point labels. */
border?: viz.core.DashedBorder;
/** Specifies connector options for series point labels. */
connector?: {
/** Specifies the color of label connectors. */
color?: string;
/** Indicates whether or not label connectors are visible. */
visible?: boolean;
/** Specifies the width of label connectors. */
width?: number;
};
/** Specifies a callback function that returns the text to be displayed by point labels. */
customizeText?: (pointInfo: Object) => string;
/** Specifies font options for the text displayed in point labels. */
font?: viz.core.Font;
/** Specifies a format for the text displayed by point labels. */
format?: string;
position?: string;
/** Specifies a precision for formatted point values displayed in point labels. */
precision?: number;
/** Specifies the angle used to rotate point labels from their initial position. */
rotationAngle?: number;
/** Specifies the visibility of point labels. */
visible?: boolean;
}
export interface SeriesConfigLabel extends BaseSeriesConfigLabel {
/** Specifies whether or not to show a label when the point has a zero value. */
showForZeroValues?: boolean;
}
export interface ChartSeriesConfigLabel extends SeriesConfigLabel {
/** Specifies how to align point labels relative to the corresponding data points that they represent. */
alignment?: string;
/** Specifies how to shift point labels horizontally from their initial positions. */
horizontalOffset?: number;
/** Specifies how to shift point labels vertically from their initial positions. */
verticalOffset?: number;
/** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */
percentPrecision?: number;
}
export interface BaseCommonSeriesConfig {
/** Specifies the data source field that provides arguments for series points. */
argumentField?: string;
axis?: string;
/** An object defining the label configuration options for a series in the dxChart widget. */
label?: ChartSeriesConfigLabel;
/** Specifies border options for point labels. */
border?: viz.core.DashedBorder;
/** Specifies a series color. */
color?: string;
/** Specifies the dash style of the series' line. */
dashStyle?: string;
hoverMode?: string;
hoverStyle?: {
/** An object defining the border options for a hovered series. */
border?: viz.core.DashedBorder;
/** Sets a color for a series when it is hovered over.
*/
color?: string;
/** Specifies the dash style for the line in a hovered series. */
dashStyle?: string;
hatching?: viz.core.Hatching;
/** Specifies the width of a line in a hovered series. */
width?: number;
};
/** Specifies whether a chart ignores null data points or not. */
ignoreEmptyPoints?: boolean;
/** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */
maxLabelCount?: number;
/** Specifies the minimal length of a displayed bar in pixels. */
minBarSize?: number;
/** Specifies opacity for a series. */
opacity?: number;
/** Specifies the series elements to highlight when the series is selected. */
selectionMode?: string;
selectionStyle?: {
/** An object defining the border options for a selected series. */
border?: viz.core.DashedBorder;
/** Sets a color for a series when it is selected. */
color?: string;
/** Specifies the dash style for the line in a selected series. */
dashStyle?: string;
hatching?: viz.core.Hatching;
/** Specifies the width of a line in a selected series. */
width?: number;
};
/** Specifies whether or not to show the series in the chart's legend. */
showInLegend?: boolean;
/** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */
stack?: string;
/** Specifies the name of the data source field that provides data about a point. */
tagField?: string;
/** Specifies the data source field that provides values for series points. */
valueField?: string;
/** Specifies the visibility of a series. */
visible?: boolean;
/** Specifies a line width. */
width?: number;
/** Configures error bars. */
valueErrorBar?: {
/** Specifies whether error bars must be displayed in full or partially. */
displayMode?: string;
/** Specifies the data field that provides data for low error values. */
lowValueField?: string;
/** Specifies the data field that provides data for high error values. */
highValueField?: string;
/** Specifies how error bar values must be calculated. */
type?: string;
/** Specifies the value to be used for generating error bars. */
value?: number;
/** Specifies the color of error bars. */
color?: string;
/** Specifies the opacity of error bars. */
opacity?: number;
/** Specifies the length of the lines that indicate the error bar edges. */
edgeLength?: number;
/** Specifies the width of the error bar line. */
lineWidth?: number;
};
}
export interface CommonPointOptions {
/** Specifies border options for points in the line and area series. */
border?: viz.core.Border;
/** Specifies the points color. */
color?: string;
/** Specifies what series points to highlight when a point is hovered over. */
hoverMode?: string;
/** An object defining configuration options for a hovered point. */
hoverStyle?: {
/** An object defining the border options for a hovered point. */
border?: viz.core.Border;
/** Sets a color for a point when it is hovered over. */
color?: string;
/** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */
size?: number;
};
/** Specifies what series points to highlight when a point is selected. */
selectionMode?: string;
/** An object defining configuration options for a selected point. */
selectionStyle?: {
/** An object defining the border options for a selected point. */
border?: viz.core.Border;
/** Sets a color for a point when it is selected.
*/
color?: string;
/** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */
size?: number;
};
/** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */
size?: number;
/** Specifies a symbol for presenting points of the line and area series. */
symbol?: string;
visible?: boolean;
}
export interface ChartCommonPointOptions extends CommonPointOptions {
/** An object specifying the parameters of an image that is used as a point marker. */
image?: {
/** Specifies the height of an image that is used as a point marker. */
height?: any;
/** Specifies a URL leading to the image to be used as a point marker. */
url?: any;
/** Specifies the width of an image that is used as a point marker. */
width?: any;
};
}
export interface PolarCommonPointOptions extends CommonPointOptions {
/** An object specifying the parameters of an image that is used as a point marker. */
image?: {
/** Specifies the height of an image that is used as a point marker. */
height?: number;
/** Specifies a URL leading to the image to be used as a point marker. */
url?: string;
/** Specifies the width of an image that is used as a point marker. */
width?: number;
};
}
/** An object that defines configuration options for chart series. */
export interface CommonSeriesConfig extends BaseCommonSeriesConfig {
/** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */
closeValueField?: string;
/** Specifies a radius for bar corners. */
cornerRadius?: number;
/** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */
highValueField?: string;
/** Specifies the color for the body (rectangle) of a _candleStick_ series. */
innerColor?: string;
/** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */
lowValueField?: string;
/** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */
openValueField?: string;
/** Specifies the pane that will be used to display a series. */
pane?: string;
/** An object defining configuration options for points in line-, scatter- and area-like series. */
point?: ChartCommonPointOptions;
/** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */
rangeValue1Field?: string;
/** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */
rangeValue2Field?: string;
/** Specifies reduction options for the stock or candleStick series. */
reduction?: {
/** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */
color?: string;
/** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */
level?: string;
};
/** Specifies the data source field that defines the size of bubbles. */
sizeField?: string;
}
export interface CommonSeriesSettings extends CommonSeriesConfig {
/** An object that specifies configuration options for all series of the area type in the chart.
*/
area?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _bar_ type in the chart. */
bar?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the bubble type in the chart. */
bubble?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */
candlestick?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */
fullstackedarea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */
fullstackedsplinearea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */
fullstackedbar?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */
fullstackedline?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */
fullstackedspline?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _line_ type in the chart. */
line?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */
rangearea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */
rangebar?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _scatter_ type in the chart. */
scatter?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _spline_ type in the chart. */
spline?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */
splinearea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */
stackedarea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */
stackedsplinearea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */
stackedbar?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */
stackedline?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */
stackedspline?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */
steparea?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */
stepline?: CommonSeriesConfig;
/** An object that specifies configuration options for all series of the _stock_ type in the chart. */
stock?: CommonSeriesConfig;
/** Sets a series type. */
type?: string;
}
export interface SeriesConfig extends CommonSeriesConfig {
/** Specifies the name that identifies the series. */
name?: string;
/** Specifies data about a series. */
tag?: any;
/** Sets the series type. */
type?: string;
}
/** An object that defines configuration options for polar chart series. */
export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig {
/** Specifies whether or not to close the chart by joining the end point with the first point. */
closed?: boolean;
label?: SeriesConfigLabel;
point?: PolarCommonPointOptions;
}
export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig {
/** An object that specifies configuration options for all series of the area type in the chart. */
area?: CommonPolarSeriesConfig;
/** An object that specifies configuration options for all series of the _bar_ type in the chart. */
bar?: CommonPolarSeriesConfig;
/** An object that specifies configuration options for all series of the _line_ type in the chart. */
line?: CommonPolarSeriesConfig;
/** An object that specifies configuration options for all series of the _scatter_ type in the chart. */
scatter?: CommonPolarSeriesConfig;
/** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */
stackedbar?: CommonPolarSeriesConfig;
/** Sets a series type. */
type?: string;
}
export interface PolarSeriesConfig extends CommonPolarSeriesConfig {
/** Specifies the name that identifies the series. */
name?: string;
/** Specifies data about a series. */
tag?: any;
/** Sets the series type. */
type?: string;
}
export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel {
/** Specifies how to shift labels from their initial position in a radial direction in pixels. */
radialOffset?: number;
/** Specifies a precision for the percentage values displayed in labels. */
percentPrecision?: number;
}
/** An object that defines configuration options for chart series. */
export interface CommonPieSeriesConfig {
/** Specifies the data source field that provides arguments for series points. */
argumentField?: string;
/** Specifies the required type for series arguments. */
argumentType?: string;
/** An object defining the series border configuration options. */
border?: viz.core.DashedBorder;
/** Specifies a series color. */
color?: string;
/** Specifies the chart elements to highlight when a series is hovered over. */
hoverMode?: string;
/** An object defining configuration options for a hovered series. */
hoverStyle?: {
/** An object defining the border options for a hovered series. */
border?: viz.core.DashedBorder;
/** Sets a color for the series when it is hovered over. */
color?: string;
/** Specifies the hatching options to be applied when a point is hovered over. */
hatching?: viz.core.Hatching;
};
/**
* Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type.
* @deprecated use the 'innerRadius' option instead
*/
innerRadius?: number;
/** An object defining the label configuration options. */
label?: PieSeriesConfigLabel;
/** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */
maxLabelCount?: number;
/** Specifies a minimal size of a displayed pie segment. */
minSegmentSize?: number;
/**
* Specifies the direction in which the dxPieChart series points are located.
* @deprecated use the 'segmentsDirection' option instead
*/
segmentsDirection?: string;
/** Specifies the chart elements to highlight when the series is selected.
*/
selectionMode?: string;
/** An object defining configuration options for the series when it is selected. */
selectionStyle?: {
/** An object defining the border options for a selected series. */
border?: viz.core.DashedBorder;
/** Sets a color for a series when it is selected. */
color?: string;
/** Specifies the hatching options to be applied when a point is selected. */
hatching?: viz.core.Hatching;
};
/** Specifies chart segment grouping options. */
smallValuesGrouping?: {
/** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */
groupName?: string;
/** Specifies the segment grouping mode. */
mode?: string;
/** Specifies a threshold for segment values. */
threshold?: number;
/** Specifies how many segments must not be grouped. */
topCount?: number;
};
/**
* Specifies a start angle for a pie chart in arc degrees.
* @deprecated use the 'startAngle' option instead
*/
startAngle?: number;
/** Specifies the name of the data source field that provides data about a point.
*/
tagField?: string;
/** Specifies the data source field that provides values for series points. */
valueField?: string;
}
export interface CommonPieSeriesSettings extends CommonPieSeriesConfig {
/**
* Specifies the type of the pie chart series.
* @deprecated use the 'type' option instead
*/
type?: string;
}
export interface PieSeriesConfig extends CommonPieSeriesConfig {
/**
* Sets the series type.
* @deprecated use the 'type' option instead
*/
type?: string;
/** Specifies the name that identifies the series. */
name?: string;
/** Specifies data about a series. */
tag?: any;
}
export interface SeriesTemplate {
/** Specifies a callback function that returns a series object with individual series settings. */
customizeSeries?: (seriesName: string) => SeriesConfig;
/** Specifies a data source field that represents the series name. */
nameField?: string;
}
export interface PolarSeriesTemplate {
/** Specifies a callback function that returns a series object with individual series settings. */
customizeSeries?: (seriesName: string) => PolarSeriesConfig;
/** Specifies a data source field that represents the series name. */
nameField?: string;
}
export interface ChartCommonConstantLineLabel {
/** Specifies font options for a constant line label. */
font?: viz.core.Font;
/** Specifies the position of the constant line label relative to the chart plot. */
position?: string;
/** Indicates whether or not to display labels for the axis constant lines. */
visible?: boolean;
}
export interface PolarCommonConstantLineLabel {
/** Indicates whether or not to display labels for the axis constant lines. */
visible?: boolean;
/** Specifies font options for a constant line label. */
font?: viz.core.Font;
}
export interface ConstantLineStyle {
/** Specifies a color for a constant line. */
color?: string;
/** Specifies a dash style for a constant line. */
dashStyle?: string;
/** Specifies a constant line width in pixels. */
width?: number;
}
export interface ChartCommonConstantLineStyle extends ConstantLineStyle {
/** An object defining constant line label options. */
label?: ChartCommonConstantLineLabel;
/** Specifies the space between the constant line label and the left/right side of the constant line. */
paddingLeftRight?: number;
/** Specifies the space between the constant line label and the top/bottom side of the constant line. */
paddingTopBottom?: number;
}
export interface PolarCommonConstantLineStyle extends ConstantLineStyle {
/** An object defining constant line label options. */
label?: PolarCommonConstantLineLabel;
}
export interface CommonAxisLabel {
/** Specifies font options for axis labels. */
font?: viz.core.Font;
/** Specifies the spacing between an axis and its labels in pixels. */
indentFromAxis?: number;
/** Indicates whether or not axis labels are visible. */
visible?: boolean;
}
export interface ChartCommonAxisLabel extends CommonAxisLabel {
/** Specifies the label's position relative to the tick (grid line). */
alignment?: string;
/** Specifies the overlap resolving algorithm to be applied to axis labels. */
overlappingBehavior?: {
/** Specifies how to arrange axis labels. */
mode?: string;
/** Specifies the angle used to rotate axis labels. */
rotationAngle?: number;
/** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */
staggeringSpacing?: number;
};
}
export interface PolarCommonAxisLabel extends CommonAxisLabel {
/** Specifies the overlap resolving algorithm to be applied to axis labels. */
overlappingBehavior?: string;
}
export interface CommonAxisTitle {
/** Specifies font options for an axis title. */
font?: viz.core.Font;
/** Specifies a margin for an axis title in pixels. */
margin?: number;
}
export interface BaseCommonAxisSettings {
/** Specifies the color of the line that represents an axis. */
color?: string;
/** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */
discreteAxisDivisionMode?: string;
/** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */
grid?: {
/** Specifies a color for grid lines. */
color?: string;
/** Specifies an opacity for grid lines. */
opacity?: number;
/** Indicates whether or not the grid lines of an axis are visible. */
visible?: boolean;
/** Specifies the width of grid lines. */
width?: number;
};
/** Specifies the options of the minor grid. */
minorGrid?: {
/** Specifies a color for the lines of the minor grid. */
color?: string;
/** Specifies an opacity for the lines of the minor grid. */
opacity?: number;
/** Indicates whether the minor grid is visible or not. */
visible?: boolean;
/** Specifies a width for the lines of the minor grid. */
width?: number;
};
/** Indicates whether or not an axis is inverted. */
inverted?: boolean;
/** Specifies the opacity of the line that represents an axis. */
opacity?: number;
/** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */
setTicksAtUnitBeginning?: boolean;
/** An object defining the configuration options for axis ticks. */
tick?: {
/** Specifies ticks color. */
color?: string;
/** Specifies tick opacity. */
opacity?: number;
/** Indicates whether or not ticks are visible on an axis. */
visible?: boolean;
/** Specifies tick width. */
width?: number;
/** Specifies tick length. */
length?: number;
};
/** Specifies the options of the minor ticks. */
minorTick?: {
/** Specifies a color for the minor ticks. */
color?: string;
/** Specifies an opacity for the minor ticks. */
opacity?: number;
/** Indicates whether or not the minor ticks are displayed on an axis. */
visible?: boolean;
/** Specifies minor tick width. */
width?: number;
/** Specifies minor tick length. */
length?: number;
};
/** Indicates whether or not the line that represents an axis in a chart is visible. */
visible?: boolean;
/** Specifies the width of the line that represents an axis in the chart. */
width?: number;
}
export interface ChartCommonAxisSettings extends BaseCommonAxisSettings {
/** Specifies the appearance of all the widget's constant lines. */
constantLineStyle?: ChartCommonConstantLineStyle;
/** An object defining the label configuration options that are common for all axes in the dxChart widget. */
label?: ChartCommonAxisLabel;
/** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */
maxValueMargin?: number;
/** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */
minValueMargin?: number;
/** Specifies, in pixels, the space reserved for an axis. */
placeholderSize?: number;
/** An object defining configuration options for strip style. */
stripStyle?: {
/** An object defining the configuration options for a strip label style. */
label?: {
/** Specifies font options for a strip label. */
font?: viz.core.Font;
/** Specifies the label's position on a strip. */
horizontalAlignment?: string;
/** Specifies a label's position on a strip. */
verticalAlignment?: string;
};
/** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */
paddingLeftRight?: number;
/** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */
paddingTopBottom?: number;
};
/** An object defining the title configuration options that are common for all axes in the dxChart widget. */
title?: CommonAxisTitle;
/** Indicates whether or not to display series with indents from axis boundaries. */
valueMarginsEnabled?: boolean;
}
export interface PolarCommonAxisSettings extends BaseCommonAxisSettings {
/** Specifies the appearance of all the widget's constant lines. */
constantLineStyle?: PolarCommonConstantLineStyle;
/** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */
label?: PolarCommonAxisLabel;
/** An object defining configuration options for strip style. */
stripStyle?: {
/** An object defining the configuration options for a strip label style. */
label?: {
/** Specifies font options for a strip label. */
font?: viz.core.Font;
};
};
}
export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel {
/** Specifies the horizontal alignment of a constant line label. */
horizontalAlignment?: string;
/** Specifies the vertical alignment of a constant line label. */
verticalAlignment?: string;
/** Specifies the text to be displayed in a constant line label. */
text?: string;
}
export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel {
/** Specifies the text to be displayed in a constant line label. */
text?: string;
}
export interface AxisLabel {
/** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */
customizeHint?: (argument: { value: any; valueText: string }) => string;
/** Specifies a callback function that returns the text to be displayed in value axis labels. */
customizeText?: (argument: { value: any; valueText: string }) => string;
/** Specifies a format for the text displayed by axis labels. */
format?: string;
/** Specifies a precision for the formatted value displayed in the axis labels. */
precision?: number;
}
export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { }
export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { }
export interface AxisTitle extends CommonAxisTitle {
/** Specifies the text for the value axis title. */
text?: string;
}
export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle {
/** An object defining constant line label options. */
label?: ChartConstantLineLabel;
}
export interface ChartConstantLine extends ChartConstantLineStyle {
/** An object defining constant line label options. */
label?: ChartConstantLineLabel;
/** Specifies a value to be displayed by a constant line. */
value?: any;
}
export interface PolarConstantLine extends PolarCommonConstantLineStyle {
/** An object defining constant line label options. */
label?: PolarConstantLineLabel;
/** Specifies a value to be displayed by a constant line. */
value?: any;
}
export interface Axis {
/** Specifies a coefficient for dividing the value axis. */
axisDivisionFactor?: number;
/** Specifies the order in which discrete values are arranged on the value axis. */
categories?: Array;
/** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */
logarithmBase?: number;
/** Specifies an interval between axis ticks/grid lines. */
tickInterval?: any;
/** Specifies the interval between minor ticks. */
minorTickInterval?: any;
/** Specifies the number of minor ticks between two neighboring major ticks. */
minorTickCount?: number;
/** Specifies the required type of the value axis. */
type?: string;
/** Specifies the pane on which the current value axis will be displayed. */
pane?: string;
/** Specifies options for value axis strips. */
strips?: Array;
}
export interface ChartAxis extends ChartCommonAxisSettings, Axis {
/** Defines an array of the value axis constant lines. */
constantLines?: Array;
/** Specifies the appearance options for the constant lines of the value axis. */
constantLineStyle?: ChartCommonConstantLineStyle;
/** Specifies options for value axis labels. */
label?: ChartAxisLabel;
/** Specifies the maximum value on the value axis. */
max?: any;
/** Specifies the minimum value on the value axis. */
min?: any;
/** Specifies the position of the value axis on a chart. */
position?: string;
/** Specifies the title for a value axis. */
title?: AxisTitle;
}
export interface PolarAxis extends PolarCommonAxisSettings, Axis {
/** Defines an array of the value axis constant lines. */
constantLines?: Array;
/** Specifies options for value axis labels. */
label?: PolarAxisLabel;
}
export interface ArgumentAxis {
/** Specifies the desired type of axis values. */
argumentType?: string;
/** Specifies the elements that will be highlighted when the argument axis is hovered over. */
hoverMode?: string;
}
export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { }
export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis {
/** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */
startAngle?: number;
/** Specifies whether or not to display the first point at the angle specified by the startAngle option. */
firstPointOnStartAngle?: boolean;
/** Specifies the value to be used as the origin for the argument axis. */
originValue?: number;
/** Specifies the period of the argument values in the data source. */
period?: number;
}
export interface ValueAxis {
/** Specifies the name of the value axis. */
name?: string;
/** Specifies whether or not to indicate a zero value on the value axis. */
showZero?: boolean;
/** Specifies the desired type of axis values. */
valueType?: string;
}
export interface ChartValueAxis extends ChartAxis, ValueAxis {
/** Specifies the spacing, in pixels, between multiple value axes in a chart. */
multipleAxesSpacing?: number;
/** Specifies the value by which the chart's value axes are synchronized. */
synchronizedValue?: number;
}
export interface PolarValueAxis extends PolarAxis, ValueAxis {
/** Indicates whether to display series with indents from axis boundaries. */
valueMarginsEnabled?: boolean;
/** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */
maxValueMargin?: number;
/** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */
minValueMargin?: number;
tick?: {
visible?: boolean;
}
}
export interface CommonPane {
/** Specifies a background color in a pane. */
backgroundColor?: string;
/** Specifies the border options of a chart's pane. */
border?: PaneBorder;
}
export interface Pane extends CommonPane {
/** Specifies the name of a pane. */
name?: string;
}
export interface PaneBorder extends viz.core.DashedBorderWithOpacity {
/** Specifies the bottom border's visibility state in a pane. */
bottom?: boolean;
/** Specifies the left border's visibility state in a pane. */
left?: boolean;
/** Specifies the right border's visibility state in a pane. */
right?: boolean;
/** Specifies the top border's visibility state in a pane. */
top?: boolean;
}
export interface ChartAnimation extends viz.core.Animation {
/** Specifies the maximum series point count in the chart that the animation supports. */
maxPointCountSupported?: number;
}
export interface BaseChartTooltip extends viz.core.Tooltip {
/** Specifies a format for arguments of the chart's series points. */
argumentFormat?: string;
/** Specifies a precision for formatted arguments displayed in tooltips. */
argumentPrecision?: number;
/** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */
percentPrecision?: number;
}
export interface BaseChartOptions extends viz.core.BaseWidgetOptions {
/** Specifies adaptive layout options. */
adaptiveLayout?: {
/** Specifies the width of the widget that is small enough for the layout to begin adapting. */
width?: number;
/** Specifies the height of the widget that is small enough for the layout to begin adapting. */
height?: number;
/** Specifies whether or not point labels can be hidden when the layout is adapting. */
keepLabels?: boolean;
};
/** Specifies animation options. */
animation?: ChartAnimation;
/** Specifies a callback function that returns an object with options for a specific point label. */
customizeLabel?: (labelInfo: Object) => Object;
/** Specifies a callback function that returns an object with options for a specific point. */
customizePoint?: (pointInfo: Object) => Object;
/** Specifies a data source for the chart. */
dataSource?: any;
/** Specifies the appearance of the loading indicator. */
loadingIndicator?: viz.core.LoadingIndicator;
/** Specifies options of a dxChart's (dxPieChart's) legend. */
legend?: core.BaseLegend;
/** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */
margin?: viz.core.Margins;
/** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */
palette?: any;
/** A handler for the done event. */
onDone?: (e: {
component: BaseChart;
element: Element;
}) => void;
/** A handler for the pointClick event. */
onPointClick?: any;
/** A handler for the pointHoverChanged event. */
onPointHoverChanged?: (e: {
component: BaseChart;
element: Element;
target: TPoint;
}) => void;
/** A handler for the pointSelectionChanged event. */
onPointSelectionChanged?: (e: {
component: BaseChart;
element: Element;
target: TPoint;
}) => void;
/** Specifies whether a single point or multiple points can be selected in the chart. */
pointSelectionMode?: string;
/** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */
redrawOnResize?: boolean;
/** Specifies options for the dxChart and dxPieChart widget series. */
series?: any;
/** Specifies the size of the widget in pixels. */
size?: viz.core.Size;
/** Specifies a title for the chart. */
title?: viz.core.Title;
/** Specifies tooltip options. */
tooltip?: BaseChartTooltip;
/** A handler for the tooltipShown event. */
onTooltipShown?: (e: {
component: BaseChart;
element: Element;
target: BasePoint;
}) => void;
/** A handler for the tooltipHidden event. */
onTooltipHidden?: (e: {
component: BaseChart;
element: Element;
target: BasePoint;
}) => void;
}
/** A base class for all chart widgets included in the ChartJS library. */
export class BaseChart extends viz.core.BaseWidget {
/** Deselects the chart's selected series. The series is displayed in an initial style. */
clearSelection(): void;
/** Gets the current size of the widget. */
getSize(): { width: number; height: number };
/** Returns an array of all series in the chart. */
getAllSeries(): Array;
/** Gets a series within the chart's series collection by the specified name (see the name option). */
getSeriesByName(seriesName: string): BaseSeries;
/** Gets a series within the chart's series collection by its position number. */
getSeriesByPos(seriesIndex: number): BaseSeries;
/** Displays the loading indicator. */
showLoadingIndicator(): void;
/** Conceals the loading indicator. */
hideLoadingIndicator(): void;
/** Hides all widget tooltips. */
hideTooltip(): void;
/** Redraws a widget. */
render(renderOptions?: {
force?: boolean;
animate?: boolean;
asyncSeriesRendering?: boolean;
}): void;
}
export interface AdvancedLegend extends core.BaseLegend {
/** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */
customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string;
/** Specifies a callback function that returns the text to be displayed by legend items.
*/
customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string;
/** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */
hoverMode?: string;
}
export interface AdvancedOptions extends BaseChartOptions {
/** A handler for the argumentAxisClick event. */
onArgumentAxisClick?: any;
/** Specifies the color of the parent page element. */
containerBackgroundColor?: string;
/** An object providing options for managing data from a data source. */
dataPrepareSettings?: {
/** Specifies whether or not to validate the values from a data source. */
checkTypeForAllData?: boolean;
/** Specifies whether or not to convert the values from a data source into the data type of an axis. */
convertToAxisDataType?: boolean;
/** Specifies how to sort the series points. */
sortingMethod?: any;
};
/** A handler for the legendClick event. */
onLegendClick?: any;
/** A handler for the seriesClick event. */
onSeriesClick?: any;
/** A handler for the seriesHoverChanged event. */
onSeriesHoverChanged?: (e: {
component: BaseChart;
element: Element;
target: TSeries;
}) => void;
/** A handler for the seriesSelectionChanged event. */
onSeriesSelectionChanged?: (e: {
component: BaseChart;
element: Element;
target: TSeries;
}) => void;
/** Specifies whether a single series or multiple series can be selected in the chart. */
seriesSelectionMode?: string;
/** Specifies how the chart must behave when series point labels overlap. */
resolveLabelOverlapping?: string;
/** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */
equalBarWidth?: boolean;
/** Specifies a common bar width as a percentage from 0 to 1. */
barWidth?: number;
}
export interface Legend extends AdvancedLegend {
/** Specifies whether the legend is located outside or inside the chart's plot. */
position?: string;
}
export interface ChartTooltip extends BaseChartTooltip {
/** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */
location?: string;
/** Specifies the kind of information to display in a tooltip. */
shared?: boolean;
}
export interface dxChartOptions extends AdvancedOptions {
adaptiveLayout?: {
keepLabels?: boolean;
};
/** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */
synchronizeMultiAxes?: boolean;
/** Specifies whether or not to filter the series points depending on their quantity. */
useAggregation?: boolean;
/** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */
adjustOnZoom?: boolean;
/** Specifies argument axis options for the dxChart widget. */
argumentAxis?: ChartArgumentAxis;
/** An object defining the configuration options that are common for all axes of the dxChart widget. */
commonAxisSettings?: ChartCommonAxisSettings;
/** An object defining the configuration options that are common for all panes in the dxChart widget. */
commonPaneSettings?: CommonPane;
/** An object defining the configuration options that are common for all series of the dxChart widget. */
commonSeriesSettings?: CommonSeriesSettings;
/** An object that specifies the appearance options of the chart crosshair. */
crosshair?: {
/** Specifies a color for the crosshair lines. */
color?: string;
/** Specifies a dash style for the crosshair lines. */
dashStyle?: string;
/** Specifies whether to enable the crosshair or not. */
enabled?: boolean;
/** Specifies the opacity of the crosshair lines. */
opacity?: number;
/** Specifies the width of the crosshair lines. */
width?: number;
/** Specifies the appearance of the horizontal crosshair line. */
horizontalLine?: CrosshaierWithLabel;
/** Specifies the appearance of the vertical crosshair line. */
verticalLine?: CrosshaierWithLabel;
/** Specifies the options of the crosshair labels. */
label?: {
/** Specifies a color for the background of the crosshair labels. */
backgroundColor?: string;
/** Specifies whether the crosshair labels are visible or not. */
visible?: boolean;
/** Specifies font options for the text of the crosshair labels. */
font?: viz.core.Font;
/** Specifies the format of the values displayed by crosshair labels. */
format?: string;
/** Specifies a precision for formatted values. */
precision?: number;
/** Customizes the text displayed by the crosshair labels. */
customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string;
}
};
/** Specifies a default pane for the chart's series. */
defaultPane?: string;
/** Specifies a coefficient determining the diameter of the largest bubble. */
maxBubbleSize?: number;
/** Specifies the diameter of the smallest bubble measured in pixels. */
minBubbleSize?: number;
/** Defines the dxChart widget's pane(s). */
panes?: Array;
/** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */
rotated?: boolean;
/** Specifies the options of a chart's legend. */
legend?: Legend;
/** Specifies options for dxChart widget series. */
series?: Array;
/** Defines options for the series template. */
seriesTemplate?: SeriesTemplate;
/** Specifies tooltip options. */
tooltip?: ChartTooltip;
/** Specifies value axis options for the dxChart widget. */
valueAxis?: Array;
/** Enables scrolling in your chart. */
scrollingMode?: string;
/** Enables zooming in your chart. */
zoomingMode?: string;
/** Specifies the settings of the scroll bar. */
scrollBar?: {
/** Specifies whether the scroll bar is visible or not. */
visible?: boolean;
/** Specifies the spacing between the scroll bar and the chart's plot in pixels. */
offset?: number;
/** Specifies the color of the scroll bar. */
color?: string;
/** Specifies the width of the scroll bar in pixels. */
width?: number;
/** Specifies the opacity of the scroll bar. */
opacity?: number;
/** Specifies the position of the scroll bar in the chart. */
position?: string;
};
}
/** A widget used to embed charts into HTML JS applications. */
export class dxChart extends BaseChart {
constructor(element: JQuery, options?: dxChartOptions);
constructor(element: Element, options?: dxChartOptions);
/** Sets the specified start and end values for the chart's argument axis. */
zoomArgument(startValue: any, endValue: any): void;
}
interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity {
/** Configures the label that belongs to the horizontal crosshair line. */
label?: {
/** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */
backgroundColor?: string;
/** Specifies whether the label of the horizontal crosshair line is visible or not. */
visible?: boolean;
/** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */
font?: viz.core.Font;
/** Specifies the format of the values displayed by crosshair labels. */
format?: string;
/** Specifies a precision for formatted values. */
precision?: number;
/** Customizes the text displayed by the crosshair label that accompany the horizontal line. */
customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string;
}
}
export interface PolarChartTooltip extends BaseChartTooltip {
/** Specifies the kind of information to display in a tooltip. */
shared?: boolean;
}
export interface dxPolarChartOptions extends AdvancedOptions {
/** Specifies adaptive layout options. */
adaptiveLayout?: {
width?: number;
height?: number;
/** Specifies whether or not point labels can be hidden when the layout is adapting. */
keepLabels?: boolean;
};
/** Indicates whether or not to display a "spider web". */
useSpiderWeb?: boolean;
/** Specifies argument axis options for the dxPolarChart widget. */
argumentAxis?: PolarArgumentAxis;
/** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */
commonAxisSettings?: PolarCommonAxisSettings;
/** An object defining the configuration options that are common for all series of the dxPolarChart widget. */
commonSeriesSettings?: CommonPolarSeriesSettings;
/** Specifies the options of a chart's legend. */
legend?: AdvancedLegend;
/** Specifies options for dxPolarChart widget series. */
series?: Array;
/** Defines options for the series template. */
seriesTemplate?: PolarSeriesTemplate;
/** Specifies tooltip options. */
tooltip?: PolarChartTooltip;
/** Specifies value axis options for the dxPolarChart widget. */
valueAxis?: PolarValueAxis;
}
/** A chart widget displaying data in a polar coordinate system. */
export class dxPolarChart extends BaseChart {
constructor(element: JQuery, options?: dxPolarChartOptions);
constructor(element: Element, options?: dxPolarChartOptions);
}
export interface PieLegend extends core.BaseLegend {
/** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */
hoverMode?: string;
/** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */
customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string;
/** Specifies a callback function that returns the text to be displayed by a legend item. */
customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string;
}
export interface dxPieChartOptions extends BaseChartOptions {
/** Specifies adaptive layout options. */
adaptiveLayout?: {
/** Specifies whether or not point labels can be hidden when the layout is adapting. */
keepLabels?: boolean;
};
/** Specifies dxPieChart legend options. */
legend?: PieLegend;
/** Specifies options for the series of the dxPieChart widget. */
series?: Array;
/** Specifies the diameter of the pie. */
diameter?: number;
/** Specifies the direction that the pie chart segments will occupy. */
segmentsDirection?: string;
/** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */
startAngle?: number;
/** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */
innerRadius?: number;
/** A handler for the legendClick event. */
onLegendClick?: any;
/** Specifies how a chart must behave when series point labels overlap. */
resolveLabelOverlapping?: string;
/** An object defining the configuration options that are common for all series of the dxPieChart widget. */
commonSeriesSettings?: CommonPieSeriesSettings;
/** Specifies the type of the pie chart series. */
type?: string;
}
/** A circular chart widget for HTML JS applications. */
export class dxPieChart extends BaseChart {
constructor(element: JQuery, options?: dxPieChartOptions);
constructor(element: Element, options?: dxPieChartOptions);
/**
* Provides access to the dxPieChart series.
* @deprecated ..\..\BaseChart\3 Methods\getAllSeries().md
*/
getSeries(): PieSeries;
}
}
interface JQuery {
dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery;
dxChart(methodName: string, ...params: any[]): any;
dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart;
dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery;
dxPieChart(methodName: string, ...params: any[]): any;
dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart;
dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery;
dxPolarChart(methodName: string, ...params: any[]): any;
dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart;
}
declare namespace DevExpress.viz.gauges {
export interface BaseRangeContainer {
/** Specifies a range container's background color. */
backgroundColor?: string;
/** Specifies the offset of the range container from an invisible scale line in pixels. */
offset?: number;
/** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */
palette?: any;
/** An array of objects representing ranges contained in the range container. */
ranges?: Array<{ startValue: number; endValue: number; color: string }>;
/** Specifies a color of a range. */
color?: string;
/** Specifies an end value of a range. */
endValue?: number;
/** Specifies a start value of a range. */
startValue?: number;
}
export interface ScaleTick {
/** Specifies the color of the scale's minor ticks. */
color?: string;
/**
* Specifies an array of custom minor ticks.
* @deprecated ..\customMinorTicks.md
*/
customTickValues?: Array;
/** Specifies the length of the scale's minor ticks. */
length?: number;
/**
* Indicates whether automatically calculated minor ticks are visible or not.
* @deprecated This functionality in not more available
*/
showCalculatedTicks?: boolean;
/**
* Specifies an interval between minor ticks.
* @deprecated ..\minorTickInterval.md
*/
tickInterval?: number;
/** Indicates whether scale minor ticks are visible or not. */
visible?: boolean;
/** Specifies the width of the scale's minor ticks. */
width?: number;
}
export interface ScaleMajorTick extends ScaleTick {
/**
* Specifies whether or not to expand the current major tick interval if labels overlap each other.
* @deprecated ..\label\overlappingBehavior\useAutoArrangement.md
*/
useTicksAutoArrangement?: boolean;
}
export interface ScaleMinorTick extends ScaleTick {
/** Specifies the opacity of the scale's minor ticks. */
opacity?: number;
}
export interface BaseScaleLabel {
/** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */
useRangeColors?: boolean;
/** Specifies a callback function that returns the text to be displayed in scale labels. */
customizeText?: (scaleValue: { value: number; valueText: string }) => string;
/** Specifies the overlap resolving options to be applied to scale labels. */
overlappingBehavior?: {
/** Specifies whether or not to expand the current major tick interval if labels overlap each other. */
useAutoArrangement?: boolean;
/** Specifies what label to hide in case of overlapping. */
hideFirstOrLast?: string;
};
/** Specifies font options for the text displayed in the scale labels of the gauge. */
font?: viz.core.Font;
/** Specifies a format for the text displayed in scale labels. */
format?: string;
/** Specifies a precision for the formatted value displayed in the scale labels. */
precision?: number;
/** Specifies whether or not scale labels are visible on the gauge. */
visible?: boolean;
}
export interface BaseScale {
/** Specifies the end value for the scale of the gauge. */
endValue?: number;
/**
* Specifies whether or not to hide the first scale label.
* @deprecated This functionality in not more available
*/
hideFirstLabel?: boolean;
/**
* Specifies whether or not to hide the first major tick on the scale.
* @deprecated This functionality in not more available
*/
hideFirstTick?: boolean;
/**
* Specifies whether or not to hide the last scale label.
* @deprecated This functionality in not more available
*/
hideLastLabel?: boolean;
/**
* Specifies whether or not to hide the last major tick on the scale.
* @deprecated This functionality in not more available
*/
hideLastTick?: boolean;
/** Specifies an interval between major ticks. */
tickInterval?: number;
/** Specifies an interval between minor ticks. */
minorTickInterval?: number;
/** Specifies an array of custom major ticks. */
customTicks?: Array;
/** Specifies an array of custom minor ticks. */
customMinorTicks?: Array;
/** Specifies common options for scale labels. */
label?: BaseScaleLabel;
/**
* Specifies options of the gauge's major ticks.
* @deprecated ..\tick\tick.md
*/
majorTick?: ScaleMajorTick;
/** Specifies options of the gauge's major ticks. */
tick?: {
/** Specifies the color of the scale's major ticks. */
color?: string;
/** Specifies the length of the scale's major ticks. */
length?: number;
/** Indicates whether scale major ticks are visible or not. */
visible?: boolean;
/** Specifies the width of the scale's major ticks. */
width?: number;
/** Specifies the opacity of the scale's major ticks. */
opacity?: number;
};
/** Specifies options of the gauge's minor ticks. */
minorTick?: ScaleMinorTick;
/** Specifies the start value for the scale of the gauge. */
startValue?: number;
}
export interface BaseValueIndicator {
/** Specifies the type of subvalue indicators. */
type?: string;
/** Specifies the background color for the indicator of the rangeBar type. */
backgroundColor?: string;
/** Specifies the base value for the indicator of the rangeBar type. */
baseValue?: number;
/** Specifies a color of the indicator. */
color?: string;
/** Specifies the range bar size for an indicator of the rangeBar type. */
size?: number;
text?: {
/** Specifies a callback function that returns the text to be displayed in an indicator. */
customizeText?: (indicatedValue: { value: number; valueText: string }) => string;
font?: viz.core.Font;
/** Specifies a format for the text displayed in an indicator. */
format?: string;
/** Specifies the range bar's label indent in pixels. */
indent?: number;
/** Specifies a precision for the formatted value displayed by an indicator. */
precision?: number;
};
offset?: number;
length?: number;
width?: number;
/** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */
arrowLength?: number;
/** Sets the array of colors to be used for coloring subvalue indicators. */
palette?: Array;
/** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */
indentFromCenter?: number;
/** Specifies the second color for the indicator of the twoColorNeedle type. */
secondColor?: string;
/** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */
secondFraction?: number;
/** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */
spindleSize?: number;
/** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */
spindleGapSize?: number;
/** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */
horizontalOrientation?: string;
/** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */
verticalOrientation?: string;
}
export interface SharedGaugeOptions {
/** Specifies animation options. */
animation?: viz.core.Animation;
/** Specifies the appearance of the loading indicator. */
loadingIndicator?: viz.core.LoadingIndicator;
/** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */
redrawOnResize?: boolean;
/** Specifies the size of the widget in pixels. */
size?: viz.core.Size;
/**
* Specifies a subtitle for the widget.
* @deprecated ..\..\..\BaseGauge\1 Configuration\title\subtitle\subtitle.md
*/
subtitle?: {
/**
* Specifies font options for the subtitle.
* @deprecated ..\..\title\subtitle\font\font.md
*/
font?: viz.core.Font;
/**
* Specifies a text for the subtitle.
* @deprecated ..\title\subtitle\text.md
*/
text?: string;
};
/** Specifies a title for a gauge. */
title?: {
/** Specifies font options for the title. */
font?: viz.core.Font;
/**
* Specifies a title's position on the gauge.
* @deprecated basegaugeoptions_title_verticalAlignment and basegaugeoptions_title_horizontalAlignment
*/
position?: string;
/** Specifies the distance between the title and surrounding gauge elements in pixels. */
margin?: viz.core.Margins;
/** Specifies the height of the space reserved for the title. */
placeholderSize?: number;
/** Specifies the gauge title's position in the vertical direction. */
verticalAlignment?: string;
/** Specifies the gauge title's horizontal position. */
horizontalAlignment?: string;
/** Specifies text for the title. */
text?: string;
/** Specifies a subtitle for the widget. */
subtitle?: {
/** Specifies font options for the subtitle. */
font?: viz.core.Font;
/** Specifies text for the subtitle. */
text?: string;
}
};
/** Specifies options for gauge tooltips. */
tooltip?: viz.core.Tooltip;
/** A handler for the tooltipShown event. */
onTooltipShown?: (e: {
component: dxBaseGauge;
element: Element;
target: {};
}) => void;
/** A handler for the tooltipHidden event. */
onTooltipHidden?: (e: {
component: dxBaseGauge;
element: Element;
target: {};
}) => void;
}
export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions {
/** Specifies the color of the parent page element. */
containerBackgroundColor?: string;
/** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */
margin?: viz.core.Margins;
/** Specifies options of the gauge's range container. */
rangeContainer?: BaseRangeContainer;
/** Specifies a gauge's scale options. */
scale?: BaseScale;
/** Specifies the appearance options of subvalue indicators. */
subvalueIndicator?: BaseValueIndicator;
/** Specifies a set of subvalues to be designated by the subvalue indicators. */
subvalues?: Array;
/** Specifies the main value on a gauge. */
value?: number;
/** Specifies the appearance options of the value indicator. */
valueIndicator?: BaseValueIndicator;
}
/** A gauge widget. */
export class dxBaseGauge extends viz.core.BaseWidget {
/** Displays the loading indicator. */
showLoadingIndicator(): void;
/** Conceals the loading indicator. */
hideLoadingIndicator(): void;
/** Redraws a widget. */
render(): void;
/** Returns the main gauge value. */
value(): number;
/** Updates a gauge value. */
value(value: number): void;
/** Returns an array of gauge subvalues. */
subvalues(): Array;
/** Updates gauge subvalues. */
subvalues(subvalues: Array): void;
}
export interface LinearRangeContainer extends BaseRangeContainer {
/** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */
horizontalOrientation?: string;
/** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */
verticalOrientation?: string;
/** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */
width?: any;
/** Specifies an end width of a range container. */
end?: number;
/** Specifies a start width of a range container. */
start?: number;
}
export interface LinearScaleLabel extends BaseScaleLabel {
/** Specifies the spacing between scale labels and ticks. */
indentFromTick?: number;
}
export interface LinearScale extends BaseScale {
/** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */
horizontalOrientation?: string;
label?: LinearScaleLabel;
/** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */
verticalOrientation?: string;
}
export interface dxLinearGaugeOptions extends BaseGaugeOptions {
/** Specifies the options required to set the geometry of the dxLinearGauge widget. */
geometry?: {
/** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */
orientation?: string;
};
/** Specifies gauge range container options. */
rangeContainer?: LinearRangeContainer;
scale?: LinearScale;
}
/** A widget that represents a gauge with a linear scale. */
export class dxLinearGauge extends dxBaseGauge {
constructor(element: JQuery, options?: dxLinearGaugeOptions);
constructor(element: Element, options?: dxLinearGaugeOptions);
}
export interface CircularRangeContainer extends BaseRangeContainer {
/** Specifies the orientation of the range container in the dxCircularGauge widget. */
orientation?: string;
/** Specifies the range container's width in pixels. */
width?: number;
}
export interface CircularScaleLabel extends BaseScaleLabel {
/** Specifies the spacing between scale labels and ticks. */
indentFromTick?: number;
}
export interface CircularScale extends BaseScale {
label?: CircularScaleLabel;
/** Specifies the orientation of scale ticks. */
orientation?: string;
}
export interface dxCircularGaugeOptions extends BaseGaugeOptions {
/** Specifies the options required to set the geometry of the dxCircularGauge widget. */
geometry?: {
/** Specifies the end angle of the circular gauge's arc. */
endAngle?: number;
/** Specifies the start angle of the circular gauge's arc. */
startAngle?: number;
};
/** Specifies gauge range container options. */
rangeContainer?: CircularRangeContainer;
scale?: CircularScale;
}
/** A widget that represents a gauge with a circular scale. */
export class dxCircularGauge extends dxBaseGauge {
constructor(element: JQuery, options?: dxCircularGaugeOptions);
constructor(element: Element, options?: dxCircularGaugeOptions);
}
export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions {
/** Specifies a color for the remaining segment of the bar's track. */
backgroundColor?: string;
/** Specifies a distance between bars in pixels. */
barSpacing?: number;
/** Specifies a base value for bars. */
baseValue?: number;
/** Specifies an end value for the gauge's invisible scale. */
endValue?: number;
/** Defines the shape of the gauge's arc. */
geometry?: {
/** Specifies the end angle of the bar gauge's arc. */
endAngle?: number;
/** Specifies the start angle of the bar gauge's arc. */
startAngle?: number;
};
/** Specifies the options of the labels that accompany gauge bars. */
label?: {
/** Specifies a color for the label connector text. */
connectorColor?: string;
/** Specifies the width of the label connector in pixels. */
connectorWidth?: number;
/** Specifies a callback function that returns a text for labels. */
customizeText?: (barValue: { value: number; valueText: string }) => string;
/** Specifies font options for bar labels. */
font?: viz.core.Font;
/** Specifies a format for bar labels. */
format?: string;
/** Specifies the distance between the upper bar and bar labels in pixels. */
indent?: number;
/** Specifies a precision for the formatted value displayed by labels. */
precision?: number;
/** Specifies whether bar labels appear on a gauge or not. */
visible?: boolean;
};
/** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */
palette?: string;
/** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */
relativeInnerRadius?: number;
/** Specifies a start value for the gauge's invisible scale. */
startValue?: number;
/** Specifies the array of values to be indicated on a bar gauge. */
values?: Array;
}
/** A circular bar widget. */
export class dxBarGauge extends viz.core.BaseWidget {
constructor(element: JQuery, options?: dxBarGaugeOptions);
constructor(element: Element, options?: dxBarGaugeOptions);
/** Displays the loading indicator. */
showLoadingIndicator(): void;
/** Conceals the loading indicator. */
hideLoadingIndicator(): void;
/** Redraws the widget. */
render(): void;
/** Returns an array of gauge values. */
values(): Array;
/** Updates the values displayed by a gauge. */
values(values: Array): void;
}
}
interface JQuery {
dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery;
dxLinearGauge(methodName: string, ...params: any[]): any;
dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge;
dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery;
dxCircularGauge(methodName: string, ...params: any[]): any;
dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge;
dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery;
dxBarGauge(methodName: string, ...params: any[]): any;
dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge;
}
declare namespace DevExpress.viz.rangeSelector {
export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions {
/** Specifies the options for the range selector's background. */
background?: {
/** Specifies the background color for the dxRangeSelector. */
color?: string;
/** Specifies image options. */
image?: {
/** Specifies a location for the image in the background of a range selector. */
location?: string;
/** Specifies the image's URL. */
url?: string;
};
/** Indicates whether or not the background (background color and/or image) is visible. */
visible?: boolean;
};
/** Specifies a title for the range selector. */
title?: viz.core.Title;
/** Specifies the dxRangeSelector's behavior options. */
behavior?: {
/** Indicates whether or not you can swap sliders. */
allowSlidersSwap?: boolean;
/** Indicates whether or not animation is enabled. */
animationEnabled?: boolean;
/** Specifies when to call the onSelectedRangeChanged function. */
callSelectedRangeChanged?: string;
/** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */
manualRangeSelectionEnabled?: boolean;
/** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */
moveSelectedRangeByClick?: boolean;
/** Indicates whether to snap a slider to ticks. */
snapToTicks?: boolean;
};
/** Specifies the options required to display a chart as the range selector's background. */
chart?: {
/** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */
bottomIndent?: number;
/** An object defining the common configuration options for the chart’s series. */
commonSeriesSettings?: viz.charts.CommonSeriesSettings;
/** An object providing options for managing data from a data source. */
dataPrepareSettings?: {
/** Specifies whether or not to validate values from a data source. */
checkTypeForAllData?: boolean;
/** Specifies whether or not to convert the values from a data source into the data type of an axis. */
convertToAxisDataType?: boolean;
/** Specifies how to sort series points. */
sortingMethod?: any;
};
/** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */
equalBarWidth?: boolean;
/** Specifies a common bar width as a percentage from 0 to 1. */
barWidth?: number;
/** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */
palette?: any;
/** An object defining the chart’s series. */
series?: Array;
/** Defines options for the series template. */
seriesTemplate?: viz.charts.SeriesTemplate;
/** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */
topIndent?: number;
/** Specifies whether or not to filter the series points depending on their quantity. */
useAggregation?: boolean;
/** Specifies options for the chart's value axis. */
valueAxis?: {
/** Indicates whether or not the chart's value axis must be inverted. */
inverted?: boolean;
/** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */
logarithmBase?: number;
/** Specifies the maximum value of the chart's value axis. */
max?: number;
/** Specifies the minimum value of the chart's value axis. */
min?: number;
/** Specifies the type of the value axis. */
type?: string;
/** Specifies the desired type of axis values. */
valueType?: string;
};
};
/** Specifies the color of the parent page element. */
containerBackgroundColor?: string;
/** Specifies a data source for the scale values and for the chart at the background. */
dataSource?: any;
/** Specifies the data source field that provides data for the scale. */
dataSourceField?: string;
/** Specifies the appearance of the loading indicator. */
loadingIndicator?: viz.core.LoadingIndicator;
/** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */
margin?: viz.core.Margins;
/** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */
redrawOnResize?: boolean;
/** Specifies options of the range selector's scale. */
scale?: {
/** Specifies the scale's end value. */
endValue?: any;
/** Specifies common options for scale labels. */
label?: {
/** Specifies a callback function that returns the text to be displayed in scale labels. */
customizeText?: (scaleValue: { value: any; valueText: string; }) => string;
/** Specifies font options for the text displayed in the range selector's scale labels. */
font?: viz.core.Font;
/** Specifies a format for the text displayed in scale labels. */
format?: string;
/** Specifies a precision for the formatted value displayed in the scale labels. */
precision?: number;
/** Specifies a spacing between scale labels and the background bottom edge. */
topIndent?: number;
/** Specifies whether or not the scale's labels are visible. */
visible?: boolean;
};
/** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */
logarithmBase?: number;
/**
* Specifies an interval between major ticks.
* @deprecated ..\tickInterval\tickInterval.md
*/
majorTickInterval?: any;
/** Specifies an interval between axis ticks. */
tickInterval?: any;
/** Specifies options for the date-time scale's markers. */
marker?: {
/** Defines the options that can be set for the text that is displayed by the scale markers. */
label?: {
/** Specifies a callback function that returns the text to be displayed in scale markers. */
customizeText?: (markerValue: { value: any; valueText: string }) => string;
/** Specifies a format for the text displayed in scale markers. */
format?: string;
};
/** Specifies the height of the marker's separator. */
separatorHeight?: number;
/** Specifies the space between the marker label and the marker separator. */
textLeftIndent?: number;
/** Specifies the space between the marker's label and the top edge of the marker's separator. */
textTopIndent?: number;
/** Specified the indent between the marker and the scale lables. */
topIndent?: number;
/** Indicates whether scale markers are visible. */
visible?: boolean;
};
/** Specifies the maximum range that can be selected. */
maxRange?: any;
/** Specifies the number of minor ticks between neighboring major ticks. */
minorTickCount?: number;
/** Specifies an interval between minor ticks. */
minorTickInterval?: any;
/** Specifies the minimum range that can be selected. */
minRange?: any;
/** Specifies the height of the space reserved for the scale in pixels. */
placeholderHeight?: number;
/** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */
setTicksAtUnitBeginning?: boolean;
/** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */
showCustomBoundaryTicks?: boolean;
/**
* Indicates whether or not to show minor ticks on the scale.
* @deprecated minorTick\visible.md
*/
showMinorTicks?: boolean;
/** Specifies the scale's start value. */
startValue?: any;
/** Specifies options defining the appearance of scale ticks. */
tick?: {
/** Specifies the color of scale ticks (both major and minor ticks). */
color?: string;
/** Specifies the opacity of scale ticks (both major and minor ticks). */
opacity?: number;
/** Specifies the width of the scale's ticks (both major and minor ticks). */
width?: number;
};
/** Specifies options of the range selector's minor ticks. */
minorTick?: {
/** Specifies the color of the scale's minor ticks. */
color?: string;
/** Specifies the opacity of the scale's minor ticks. */
opacity?: number;
/** Specifies the width of the scale's minor ticks. */
width?: number;
/** Indicates whether scale minor ticks are visible or not. */
visible?: boolean;
};
/** Specifies the type of the scale. */
type?: string;
/** Specifies whether or not to expand the current tick interval if labels overlap each other. */
useTicksAutoArrangement?: boolean;
/** Specifies the type of values on the scale. */
valueType?: string;
/** Specifies the order of arguments on a discrete scale. */
categories?: Array;
};
/** Specifies the range to be selected when displaying the dxRangeSelector. */
selectedRange?: {
/** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */
startValue?: any;
/** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */
endValue?: any;
};
/** Specifies the color of the selected range. */
selectedRangeColor?: string;
/** Range selector's indent options. */
indent?: {
/** Specifies range selector's left indent. */
left?: number;
/** Specifies range selector's right indent. */
right?: number;
};
/** A handler for the selectedRangeChanged event. */
onSelectedRangeChanged?: (e: {
startValue: any;
endValue: any;
component: dxRangeSelector;
element: Element;
}) => void;
/** Specifies range selector shutter options. */
shutter?: {
/** Specifies shutter color. */
color?: string;
/** Specifies the opacity of the color of shutters. */
opacity?: number;
};
/** Specifies in pixels the size of the dxRangeSelector widget. */
size?: viz.core.Size;
/** Specifies the appearance of the range selector's slider handles. */
sliderHandle?: {
/** Specifies the color of the slider handles. */
color?: string;
/** Specifies the opacity of the slider handles. */
opacity?: number;
/** Specifies the width of the slider handles. */
width?: number;
};
/** Defines the options of the range selector slider markers. */
sliderMarker?: {
/** Specifies the color of the slider markers. */
color?: string;
/** Specifies a callback function that returns the text to be displayed by slider markers. */
customizeText?: (scaleValue: { value: any; valueText: any; }) => string;
/** Specifies font options for the text displayed by the range selector slider markers. */
font?: viz.core.Font;
/** Specifies a format for the text displayed in slider markers. */
format?: string;
/** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */
invalidRangeColor?: string;
/**
* Specifies the empty space between the marker's border and the marker’s text.
* @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead
*/
padding?: number;
/** Specifies the empty space between the marker's top and bottom borders and the marker's text. */
paddingTopBottom?: number;
/** Specifies the empty space between the marker's left and right borders and the marker's text. */
paddingLeftRight?: number;
/** Specifies the placeholder height of the slider marker. */
placeholderHeight?: number;
/**
* Specifies in pixels the height and width of the space reserved for the range selector slider markers.
* @deprecated Use the 'placeholderHeight' and 'indent' options instead
*/
placeholderSize?: {
/** Specifies the height of the placeholder for the left and right slider markers. */
height?: number;
/** Specifies the width of the placeholder for the left and right slider markers. */
width?: {
/** Specifies the width of the left slider marker's placeholder. */
left?: number;
/** Specifies the width of the right slider marker's placeholder. */
right?: number;
};
};
/** Specifies a precision for the formatted value displayed in slider markers. */
precision?: number;
/** Indicates whether or not the slider markers are visible. */
visible?: boolean;
};
}
/** A widget that allows end users to select a range of values on a scale. */
export class dxRangeSelector extends viz.core.BaseWidget {
constructor(element: JQuery, options?: dxRangeSelectorOptions);
constructor(element: Element, options?: dxRangeSelectorOptions);
/** Displays the loading indicator. */
showLoadingIndicator(): void;
/** Conceals the loading indicator. */
hideLoadingIndicator(): void;
/** Redraws a widget. */
render(skipChartAnimation?: boolean): void;
/** Returns the currently selected range. */
getSelectedRange(): { startValue: any; endValue: any; };
/** Sets a specified range. */
setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void;
}
}
interface JQuery {
dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery;
dxRangeSelector(methodName: string, ...params: any[]): any;
dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector;
}
declare namespace DevExpress.viz.map {
/** This section describes the fields and methods that can be used in code to manipulate the Layer object. */
export interface MapLayer {
/** The name of the layer. */
name: string;
/** The layer index in the layers array. */
index: number;
/** The layer type. Can be "area", "line" or "marker". */
type: string;
/** The type of the layer elements. */
elementType: string;
/** Gets all layer elements. */
getElements(): Array;
/** Deselects all layer elements. */
clearSelection(): void;
}
/** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */
export interface MapLayerElement {
/** The parent layer of the layer element. */
layer: MapLayer;
/** Gets the layer element coordinates. */
coordinates(): Object;
/** Sets the value of an attribute. */
attribute(name: string, value: any): void;
/** Gets the value of an attribute. */
attribute(name: string): any;
/** Gets the selection state of the layer element. */
selected(): boolean;
/** Sets the selection state of the layer element. */
selected(state: boolean): void;
/** Applies the layer element settings and updates element appearance. */
applySettings(settings: any): void;
}
/**
* This section describes the fields and methods that can be used in code to manipulate the Area object.
* @deprecated Use the "Layer Element" instead
*/
export interface Area {
/**
* Contains the element type.
* @deprecated ..\..\Layer\2 Fields\type.md
*/
type: string;
/**
* Return the value of an attribute.
* @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md
*/
attribute(name: string): any;
/**
* Provides information about the selection state of an area.
* @deprecated Use the "selected()" method of the Layer Element
*/
selected(): boolean;
/**
* Sets a new selection state for an area.
* @deprecated Use the "selected(state)" method of the Layer Element
*/
selected(state: boolean): void;
/**
* Applies the area settings specified as a parameter and updates the area appearance.
* @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md
*/
applySettings(settings: any): void;
}
/**
* This section describes the fields and methods that can be used in code to manipulate the Markers object.
* @deprecated Use the "Layer Element" instead
*/
export interface Marker {
/**
* Contains the descriptive text accompanying the map marker.
* @deprecated Get the text with the "attribute" method (using the "layers.label.dataField" value)
*/
text: string;
/**
* Contains the type of the element.
* @deprecated ..\..\Layer\2 Fields\type.md
*/
type: string;
/**
* Contains the URL of an image map marker.
* @deprecated Get the url with the "attribute" method (using the "layers.dataField" value)
*/
url: string;
/**
* Contains the value of a bubble map marker.
* @deprecated Get the value with the "attribute" method (using the "layers.dataField" value)
*/
value: number;
/**
* Contains the values of a pie map marker.
* @deprecated Get the values with the "attribute" method (using the "layers.dataField" value)
*/
values: Array;
/**
* Returns the value of an attribute.
* @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md
*/
attribute(name: string): any;
/**
* Returns the coordinates of a specific marker.
* @deprecated ..\..\Layer Element\3 Methods\coordinates().md
*/
coordinates(): Array;
/**
* Provides information about the selection state of a marker.
* @deprecated Use the "selected()" method of the Layer Element
*/
selected(): boolean;
/**
* Sets a new selection state for a marker.
* @deprecated Use the "selected(state)" method of the Layer Element
*/
selected(state: boolean): void;
/**
* Applies the marker settings specified as a parameter and updates marker appearance.
* @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md
*/
applySettings(settings: any): void;
}
export interface MapLayerSettings {
/** Specifies the layer name. */
name?: string;
/** Specifies layer type. */
type?: string;
/** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */
elementType?: string;
/** Specifies a data source for the layer. */
data?: any;
/** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */
borderWidth?: number;
/** Specifies a color for the border of the layer elements. */
borderColor?: string;
/** Specifies a color for layer elements. */
color?: string;
/** Specifies a color for the border of the layer element when it is hovered over. */
hoveredBorderColor?: string;
/** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */
hoveredBorderWidth?: number;
/** Specifies a color for a layer element when it is hovered over. */
hoveredColor?: string;
/** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */
selectedBorderWidth?: number;
/** Specifies a color for the border of the layer element when it is selected. */
selectedBorderColor?: string;
/** Specifies a color for the layer element when it is selected. */
selectedColor?: string;
/** Specifies the layer opacity (from 0 to 1). */
opacity?: number;
/** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */
size?: number;
/** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */
minSize?: number;
/** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */
maxSize?: number;
/** Specifies whether or not to change the appearance of a layer element when it is hovered over. */
hoverEnabled?: boolean;
/** Specifies whether single or multiple map elements can be selected on a vector map. */
selectionMode?: string;
/** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */
palette?: any;
/** Specifies the number of colors in a palette. */
paletteSize?: number;
/** Allows you to paint layer elements with similar attributes in the same color. */
colorGroups?: Array;
/** Specifies the field that provides data to be used for coloring of layer elements. */
colorGroupingField?: string;
/** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */
sizeGroups?: Array;
/** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */
sizeGroupingField?: string;
/** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */
dataField?: string;
/** Specifies the function that customizes each layer element individually. */
customize?: (eleemnts: Array) => void;
/** Specifies marker label options. */
label?: {
/** The name of the data attribute containing marker texts. */
dataField?: string;
/** Enables marker labels. */
enabled?: boolean;
/** Specifies font options for marker labels. */
font?: viz.core.Font;
};
}
export interface AreaSettings {
/**
* Specifies the width of the area border in pixels.
* @deprecated ..\layers\borderWidth.md
*/
borderWidth?: number;
/**
* Specifies a color for the area border.
* @deprecated ..\layers\borderColor.md
*/
borderColor?: string;
/**
* Specifies a color for an area.
* @deprecated ..\layers\color.md
*/
color?: string;
/**
* Specifies the function that customizes each area individually.
* @deprecated ..\layers\customize.md
*/
customize?: (areaInfo: Area) => AreaSettings;
/**
* Specifies a color for the area border when the area is hovered over.
* @deprecated ..\layers\hoveredBorderColor.md
*/
hoveredBorderColor?: string;
/**
* Specifies the pixel-measured width of the area border when the area is hovered over.
* @deprecated ..\layers\hoveredBorderWidth.md
*/
hoveredBorderWidth?: number;
/**
* Specifies a color for an area when this area is hovered over.
* @deprecated ..\layers\hoveredColor.md
*/
hoveredColor?: string;
/**
* Specifies whether or not to change the appearance of an area when it is hovered over.
* @deprecated ..\layers\hoverEnabled.md
*/
hoverEnabled?: boolean;
/**
* Configures area labels.
* @deprecated ..\..\layers\label\label.md
*/
label?: {
/**
* Specifies the data field that provides data for area labels.
* @deprecated ..\..\layers\label\dataField.md
*/
dataField?: string;
/**
* Enables area labels.
* @deprecated ..\..\layers\label\enabled.md
*/
enabled?: boolean;
/**
* Specifies font options for area labels.
* @deprecated ..\..\..\layers\label\font\font.md
*/
font?: viz.core.Font;
};
/**
* Specifies the name of the palette or a custom range of colors to be used for coloring a map.
* @deprecated ..\layers\palette.md
*/
palette?: any;
/**
* Specifies the number of colors in a palette.
* @deprecated ..\layers\paletteSize.md
*/
paletteSize?: number;
/**
* Allows you to paint areas with similar attributes in the same color.
* @deprecated ..\layers\colorGroups.md
*/
colorGroups?: Array;
/**
* Specifies the field that provides data to be used for coloring areas.
* @deprecated ..\layers\colorGroupingField.md
*/
colorGroupingField?: string;
/**
* Specifies a color for the area border when the area is selected.
* @deprecated ..\layers\selectedBorderColor.md
*/
selectedBorderColor?: string;
/**
* Specifies a color for an area when this area is selected.
* @deprecated ..\layers\selectedColor.md
*/
selectedColor?: string;
/**
* Specifies the pixel-measured width of the area border when the area is selected.
* @deprecated ..\layers\selectedBorderWidth.md
*/
selectedBorderWidth?: number;
/**
* Specifies whether single or multiple areas can be selected on a vector map.
* @deprecated ..\layers\selectionMode.md
*/
selectionMode?: string;
}
export interface MarkerSettings {
/**
* Specifies a color for the marker border.
* @deprecated ..\layers\borderColor.md
*/
borderColor?: string;
/**
* Specifies the width of the marker border in pixels.
* @deprecated ..\layers\borderWidth.md
*/
borderWidth?: number;
/**
* Specifies a color for a marker of the dot or bubble type.
* @deprecated ..\layers\color.md
*/
color?: string;
/**
* Specifies the function that customizes each marker individually.
* @deprecated ..\layers\customize.md
*/
customize?: (markerInfo: Marker) => MarkerSettings;
/**
* Specifies the pixel-measured width of the marker border when the marker is hovered over.
* @deprecated ..\layers\hoveredBorderWidth.md
*/
hoveredBorderWidth?: number;
/**
* Specifies a color for the marker border when the marker is hovered over.
* @deprecated ..\layers\hoveredBorderColor.md
*/
hoveredBorderColor?: string;
/**
* Specifies a color for a marker of the dot or bubble type when this marker is hovered over.
* @deprecated ..\layers\hoveredColor.md
*/
hoveredColor?: string;
/**
* Specifies whether or not to change the appearance of a marker when it is hovered over.
* @deprecated ..\layers\hoverEnabled.md
*/
hoverEnabled?: boolean;
/**
* Specifies marker label options.
* @deprecated ..\..\layers\label\label.md
*/
label?: {
/**
* Enables marker labels.
* @deprecated ..\..\layers\label\enabled.md
*/
enabled?: boolean;
/**
* Specifies font options for marker labels.
* @deprecated ..\..\..\layers\label\font\font.md
*/
font?: viz.core.Font;
};
/**
* Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type.
* @deprecated ..\layers\maxSize.md
*/
maxSize?: number;
/**
* Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type.
* @deprecated ..\layers\minSize.md
*/
minSize?: number;
/**
* Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type.
* @deprecated ..\layers\opacity.md
*/
opacity?: number;
/**
* Specifies the pixel-measured width of the marker border when the marker is selected.
* @deprecated ..\layers\selectedBorderWidth.md
*/
selectedBorderWidth?: number;
/**
* Specifies a color for the marker border when the marker is selected.
* @deprecated ..\layers\selectedBorderColor.md
*/
selectedBorderColor?: string;
/**
* Specifies a color for a marker of the dot or bubble type when this marker is selected.
* @deprecated ..\layers\selectedColor.md
*/
selectedColor?: string;
/**
* Specifies whether a single or multiple markers can be selected on a vector map.
* @deprecated ..\layers\selectionMode.md
*/
selectionMode?: string;
/**
* Specifies the size of markers. Setting this option makes sense for any type of marker except bubble.
* @deprecated ..\layers\size.md
*/
size?: number;
/**
* Specifies the type of markers to be used on the map.
* @deprecated ..\layers\elementType.md
*/
type?: string;
/**
* Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type.
* @deprecated ..\layers\palette.md
*/
palette?: any;
/**
* Allows you to paint markers with similar attributes in the same color.
* @deprecated ..\layers\colorGroups.md
*/
colorGroups?: Array;
/**
* Specifies the field that provides data to be used for coloring markers.
* @deprecated ..\layers\colorGroupingField.md
*/
colorGroupingField?: string;
/**
* Allows you to display bubbles with similar attributes in the same size.
* @deprecated ..\layers\sizeGroups.md
*/
sizeGroups?: Array;
/**
* Specifies the field that provides data to be used for sizing bubble markers.
* @deprecated ..\layers\sizeGroupingField.md
*/
sizeGroupingField?: string;
}
export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions {
/**
* An object specifying options for the map areas.
* @deprecated Use the 'layers' option instead
*/
areaSettings?: AreaSettings;
/** Specifies the options for the map background. */
background?: {
/** Specifies a color for the background border. */
borderColor?: string;
/** Specifies a color for the background. */
color?: string;
};
/** Specifies options for dxVectorMap widget layers. */
layers?: Array;
/** Specifies the map projection. */
projection?: Object;
/** Specifies the positioning of a map in geographical coordinates. */
bounds?: Array;
/** Specifies the options of the control bar. */
controlBar?: {
/** Specifies a color for the outline of the control bar elements. */
borderColor?: string;
/** Specifies a color for the inner area of the control bar elements. */
color?: string;
/** Specifies whether or not to display the control bar. */
enabled?: boolean;
/** Specifies the margin of the control bar in pixels. */
margin?: number;
/** Specifies the position of the control bar. */
horizontalAlignment?: string;
/** Specifies the position of the control bar. */
verticalAlignment?: string;
/** Specifies the opacity of the Control_Bar. */
opacity?: number;
};
/** Specifies the appearance of the loading indicator. */
loadingIndicator?: viz.core.LoadingIndicator;
/**
* Specifies a data source for the map area.
* @deprecated Use the 'layers.data' option instead
*/
mapData?: any;
/**
* Specifies a data source for the map markers.
* @deprecated Use the 'layers.data' option instead
*/
markers?: any;
/**
* An object specifying options for the map markers.
* @deprecated Use the 'layers' option instead
*/
markerSettings?: MarkerSettings;
/** Specifies the size of the dxVectorMap widget. */
size?: viz.core.Size;
/** Specifies a title for the vector map. */
title?: viz.core.Title;
/** Specifies tooltip options. */
tooltip?: viz.core.Tooltip;
/** Configures map legends. */
legends?: Array