;
- }
- /** 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?: any;
- /**
* Specifies a precision for formatted point arguments displayed in point labels.
* @deprecated Use the series | label | argumentFormat | precision instead.
*/
- 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?: any;
- position?: string;
- /**
* Specifies a precision for formatted point values displayed in point labels.
* @deprecated Use the series | label | format | precision option instead.
*/
- 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 labels for points with zero value. Applies only to bar-like series. */
- showForZeroValues?: boolean;
- }
- export interface ChartSeriesConfigLabel extends SeriesConfigLabel {
- /** Aligns point labels in relation to their points. */
- alignment?: string;
- /** Along with verticalOffset, shifts point labels from their initial positions. */
- horizontalOffset?: number;
- /** Along with horizontalOffset, shifts point labels from their initial positions. */
- verticalOffset?: number;
- /**
* Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series.
* @deprecated Use the series | label | format | percentPrecision instead.
*/
- percentPrecision?: number;
- }
- export interface BaseCommonSeriesConfig {
- /** Specifies the data source field that provides arguments for series points. */
- argumentField?: string;
- axis?: string;
- label?: ChartSeriesConfigLabel;
- border?: viz.core.DashedBorder;
- /** Specifies a series color. */
- color?: string;
- /** Specifies the dash style of the series' line. */
- dashStyle?: string;
- hoverMode?: string;
- hoverStyle?: {
- 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 series elements to be highlighted when a user selects a point. */
- selectionMode?: string;
- selectionStyle?: {
- 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 {
- /** Substitutes the standard point symbols with an image. */
- image?: {
- /** Specifies the height of the image used instead of a point marker. */
- height?: any;
- /** Specifies the URL of 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 which data source field provides close values for points of a financial series. */
- closeValueField?: string;
- /** Makes bars look rounded. Applies only to bar-like series. */
- cornerRadius?: number;
- /** Specifies which data source field provides high values for points of a financial series. */
- highValueField?: string;
- /** Specifies a filling color for the body of a series point that visualizes a non-reduced value. Applies only to candlestick series. */
- innerColor?: string;
- /** Specifies which data source field provides low values for points of a financial series. */
- lowValueField?: string;
- /** Specifies which data source field provides open values for points of a financial series. */
- openValueField?: string;
- /** Specifies which pane the series should belong to. Accepts the name of the pane. */
- pane?: string;
- point?: ChartCommonPointOptions;
- /** Coupled with the rangeValue2Field option, specifies which data source field provides values for a range-like series. */
- rangeValue1Field?: string;
- /** Coupled with the rangeValue1Field option, specifies which data source field provides values for a range-like series. */
- rangeValue2Field?: string;
- /** Specifies reduction options for financial series. */
- reduction?: {
- /** Specifies a color for the points whose price has decreased in comparison to the price of the previous point. */
- color?: string;
- /** Specifies whether high, low, open or close prices of points should be compared. */
- level?: string;
- };
- /** Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series. */
- sizeField?: string;
- }
- export interface CommonSeriesSettings extends CommonSeriesConfig {
- /** Defines common settings for all area series. */
- area?: CommonSeriesConfig;
- /** Defines common settings for all bar series. */
- bar?: CommonSeriesConfig;
- /** Defines common settings for all bubble series. */
- bubble?: CommonSeriesConfig;
- /** Defines common settings for all candlestick series. */
- candlestick?: CommonSeriesConfig;
- /** Defines common settings for all full-stacked area series. */
- fullstackedarea?: CommonSeriesConfig;
- /** Defines common settings for all full-stacked spline area series. */
- fullstackedsplinearea?: CommonSeriesConfig;
- /** Defines common settings for all full-stacked bar series. */
- fullstackedbar?: CommonSeriesConfig;
- /** Defines common settings for all full-stacked line series. */
- fullstackedline?: CommonSeriesConfig;
- /** Defines common settings for all full-stacked spline series. */
- fullstackedspline?: CommonSeriesConfig;
- /** Defines common settings for all line series. */
- line?: CommonSeriesConfig;
- /** Defines common settings for all range area series. */
- rangearea?: CommonSeriesConfig;
- /** Defines common settings for all range bar series. */
- rangebar?: CommonSeriesConfig;
- /** Defines common settings for all scatter series. */
- scatter?: CommonSeriesConfig;
- /** Defines common settings for all spline series. */
- spline?: CommonSeriesConfig;
- /** Defines common settings for all spline area series. */
- splinearea?: CommonSeriesConfig;
- /** Defines common settings for all stacked area series. */
- stackedarea?: CommonSeriesConfig;
- /** Defines common settings for all stacked spline area series. */
- stackedsplinearea?: CommonSeriesConfig;
- /** Defines common settings for all stacked bar series. */
- stackedbar?: CommonSeriesConfig;
- /** Defines common settings for all stacked line series. */
- stackedline?: CommonSeriesConfig;
- /** Defines common settings for all stacked spline series. */
- stackedspline?: CommonSeriesConfig;
- /** Defines common settings for all step area series. */
- steparea?: CommonSeriesConfig;
- /** Defines common settings for all step line series. */
- stepline?: CommonSeriesConfig;
- /** Defines common settings for all stock series. */
- stock?: CommonSeriesConfig;
- /** Specifies the type of the series. */
- 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.
* @deprecated Use the series | label | format | percentPrecision instead.
*/
- 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 PieChart 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 constant line labels. */
- font?: viz.core.Font;
- /** Specifies the position of constant line labels on the chart plot. */
- position?: string;
- /** Makes constant line labels visible. */
- 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 {
- /** Configures constant line labels. */
- label?: ChartCommonConstantLineLabel;
- /** Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label. */
- paddingLeftRight?: number;
- /** Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label. */
- paddingTopBottom?: number;
- }
- 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 {
- /** Aligns axis labels in relation to ticks. */
- alignment?: string;
- /** Decides how to arrange axis labels when there is not enough space to keep all of them. */
- overlappingBehavior?: {
- /** Decides how to arrange axis labels when there is not enough space to keep all of them. */
- mode?: string;
- /** Specifies the rotation angle of axis labels. Applies only if the mode option is "rotate". */
- rotationAngle?: number;
- /** Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if the mode option is "stagger". */
- 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 the axis title. */
- font?: viz.core.Font;
- /** Adds a pixel-measured empty space between the axis title and axis labels. */
- 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 PolarChart 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 {
- /** Configures the appearance of all constant lines in the widget. */
- constantLineStyle?: ChartCommonConstantLineStyle;
- /** Configures axis labels. */
- label?: ChartCommonAxisLabel;
- /** Controls the empty space between the maximum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */
- maxValueMargin?: number;
- /** Controls the empty space between the minimum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */
- minValueMargin?: number;
- /** Reserves a pixel-measured space for the axis. */
- placeholderSize?: number;
- /** Configures the appearance of strips. */
- stripStyle?: {
- /** Configures the appearance of strip labels. */
- label?: {
- /** Specifies font options for strip labels. */
- font?: viz.core.Font;
- /** Aligns strip labels in the horizontal direction. */
- horizontalAlignment?: string;
- /** Aligns strip labels in the vertical direction. */
- verticalAlignment?: string;
- };
- /** Generates a pixel-measured empty space between the left/right border of a strip and the strip label. */
- paddingLeftRight?: number;
- /** Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label. */
- paddingTopBottom?: number;
- };
- /** Configures axis titles. */
- title?: CommonAxisTitle;
- /** Adds an empty space between the axis and the minimum and maximum series points. */
- 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 PolarChart 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 {
- /** Aligns constant line labels in the horizontal direction. */
- horizontalAlignment?: string;
- /** Aligns constant line labels in the vertical direction. */
- verticalAlignment?: string;
- /** Specifies the text of a constant line label. By default, equals to the value of the constant line. */
- 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?: any;
- /**
* Specifies a precision for the formatted value displayed in the axis labels.
* @deprecated Use the valueAxis | label | format | precision option instead.
*/
- precision?: number;
- }
- export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { }
- export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { }
- export interface AxisTitle extends CommonAxisTitle {
- /** Specifies the text of the axis title. */
- text?: string;
- }
- export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle {
- /** Specifies the appearance of the labels of those constant lines that belong to the value axis. */
- label?: ChartConstantLineLabel;
- }
- export interface ChartConstantLine extends ChartConstantLineStyle {
- /** Configures the constant line label. */
- label?: ChartConstantLineLabel;
- /** Specifies the value indicated by a constant line. Setting this option is necessary. */
- 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;
- /** Binds the value axis to a pane. */
- pane?: string;
- /** Specifies options for value axis strips. */
- strips?: Array;
- }
- export interface ChartAxis extends ChartCommonAxisSettings, Axis {
- /** Declares a collection of constant lines belonging to the value axis. */
- constantLines?: Array;
- /** Specifies the appearance of those constant lines that belong to the value axis. */
- constantLineStyle?: ChartCommonConstantLineStyle;
- /** Configures the labels of the value axis. */
- label?: ChartAxisLabel;
- /** Coupled with the min option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */
- max?: any;
- /** Coupled with the max option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */
- min?: any;
- /** Relocates the value axis. */
- position?: string;
- /** Configures the axis title. */
- title?: any;
- }
- 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 {
- /** Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart. */
- multipleAxesSpacing?: number;
- /** Synchronizes two or more value axes with each other at a specific value. */
- 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 the color of the pane's background. */
- backgroundColor?: string;
- /** Configures the pane border. */
- border?: PaneBorder;
- }
- export interface Pane extends CommonPane {
- /** Specifies the name of the pane. */
- name?: string;
- }
- export interface PaneBorder extends viz.core.DashedBorderWithOpacity {
- /** Shows/hides the bottom border of the pane. Applies only when the border | visible option is true. */
- bottom?: boolean;
- /** Shows/hides the left border of the pane. Applies only when the border | visible option is true. */
- left?: boolean;
- /** Shows/hides the right border of the pane. Applies only when the border | visible option is true. */
- right?: boolean;
- /** Shows/hides the top border of the pane. Applies only when the border | visible option is true. */
- top?: boolean;
- }
- export interface ChartAnimation extends viz.core.Animation {
- /** Specifies how many series points the widget should have before the animation will be disabled. */
- maxPointCountSupported?: number;
- }
- export interface BaseChartTooltip extends viz.core.Tooltip {
- /** Specifies a format for arguments of the chart's series points. */
- argumentFormat?: any;
- /**
* Specifies a precision for formatted arguments displayed in tooltips.
* @deprecated Use the tooltip | argumentFormat | precision option instead.
*/
- argumentPrecision?: number;
- /**
* Specifies a precision for a percent value displayed in tooltips for stacked series and PieChart series.
* @deprecated Use the tooltip | format | percentPrecision option instead.
*/
- percentPrecision?: number;
- }
- export interface BaseChartOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions {
- /** Specifies adaptive layout options. */
- adaptiveLayout?: {
- /** Specifies the widget's width small enough for the layout to begin adapting. */
- width?: number;
- /** Specifies the widget's height small enough for the layout to begin adapting. */
- height?: number;
- /** Specifies whether or not point labels should be kept when the layout is adapting. */
- keepLabels?: boolean;
- };
- /** Specifies animation options. */
- animation?: ChartAnimation;
- /** Customizes the appearance of an individual point label. */
- customizeLabel?: (pointInfo: Object) => Object;
- /** Customizes the appearance of an individual series point. */
- customizePoint?: (pointInfo: Object) => Object;
- /** Specifies the origin of data for the widget. */
- dataSource?: any;
- /** Specifies options of a Chart's (PieChart's) legend. */
- legend?: core.BaseLegend;
- /** 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 options for the Chart and PieChart widget series. */
- series?: any;
- /** Configures tooltips. */
- 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 implements viz.core.LoadingIndicatorMethods {
- /** 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;
- /** Returns the DataSource instance. */
- getDataSource(): DevExpress.data.DataSource;
- /** Hides all widget tooltips. */
- hideTooltip(): void;
- showLoadingIndicator(): void;
- hideLoadingIndicator(): 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;
- /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */
- negativesAsZeroes?: boolean;
- }
- 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 series point or on its edge. Applies to bar-like and bubble series only. */
- location?: string;
- /** Specifies the kind of information to display in a tooltip. */
- shared?: boolean;
- }
- export interface dxChartOptions extends AdvancedOptions {
- /** 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;
- /** Specifies whether or not to adjust the value axis when zooming the widget. */
- adjustOnZoom?: boolean;
- /** Configures the argument axis. */
- argumentAxis?: ChartArgumentAxis;
- /** Defines common settings for both the argument and value axis in a chart. */
- commonAxisSettings?: ChartCommonAxisSettings;
- /** Defines common settings for all panes in a chart. */
- commonPaneSettings?: CommonPane;
- /** Specifies settings common for all series in the chart. */
- commonSeriesSettings?: CommonSeriesSettings;
- /** Configures the crosshair feature. */
- crosshair?: {
- /** Specifies the color of the crosshair lines. */
- color?: string;
- /** Specifies the dash style of the crosshair lines. */
- dashStyle?: string;
- /** Enables the crosshair. */
- enabled?: boolean;
- /** Specifies how transparent the crosshair lines should be. */
- opacity?: number;
- /** Specifies the width of the crosshair lines. */
- width?: number;
- /** Configures the horizontal crosshair line individually. */
- horizontalLine?: CrosshairWithLabel;
- /** Configures the vertical crosshair line individually. */
- verticalLine?: CrosshairWithLabel;
- /** Configures the crosshair labels. */
- label?: {
- /** Paints the background of the crosshair labels. */
- backgroundColor?: string;
- /** Makes the crosshair labels visible. Applies only if the crosshair feature is enabled. */
- visible?: boolean;
- /** Specifies font options for the crosshair labels. */
- font?: viz.core.Font;
- /** Formats the point value/argument before it will be displayed in the crosshair label. */
- format?: any;
- /**
* Specifies a precision for formatted values.
* @deprecated Use the crosshair | label | format | precision option instead.
*/
- precision?: number;
- /** Customizes the text displayed by the crosshair labels. */
- customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string;
- }
- };
- /** Specifies which pane should be used by default. */
- 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;
- /** Declares a collection of panes. */
- panes?: Array;
- /** Swaps the axes around making the value axis horizontal and the argument axis vertical. */
- rotated?: boolean;
- /** Specifies the options of a chart's legend. */
- legend?: Legend;
- /** A handler for the zoomStart event. */
- onZoomStart?: (e: {
- component: BaseChart;
- element: Element;
- }) => void;
- /** A handler for the zoomEnd event. */
- onZoomEnd?: (e: {
- component: BaseChart;
- element: Element;
- rangeStart: any;
- rangeEnd: any;
- }) => void;
- /** Specifies options for Chart widget series. */
- series?: Array;
- /** Defines options for the series template. */
- seriesTemplate?: SeriesTemplate;
- tooltip?: ChartTooltip;
- /** Configures the value axis. */
- 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;
- };
- }
- interface CrosshairWithLabel extends viz.core.DashedBorderWithOpacity {
- /** Configures the label that belongs to the horizontal crosshair line. */
- label?: {
- /** Paints the background of the label that belongs to the horizontal crosshair line. */
- backgroundColor?: string;
- /** Makes the label of the horizontal crosshair line visible. Applies only if the crosshair feature is enabled and the horizontal line is visible. */
- visible?: boolean;
- /** Specifies font options for the label of the horizontal crosshair line. */
- font?: viz.core.Font;
- /** Formats the point value before it will be displayed in the crosshair label. */
- format?: any;
- /**
* Specifies a precision for formatted values.
* @deprecated Use the crosshair | horizontalLine | label | format | precision option instead.
*/
- precision?: number;
- /** Customizes the text displayed by the label that belongs to the horizontal crosshair 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;
- };
- /** Indicates whether or not to display a "spider web". */
- useSpiderWeb?: boolean;
- /** Specifies argument axis options for the PolarChart widget. */
- argumentAxis?: PolarArgumentAxis;
- /** An object defining the configuration options that are common for all axes of the PolarChart widget. */
- commonAxisSettings?: PolarCommonAxisSettings;
- /** An object defining the configuration options that are common for all series of the PolarChart widget. */
- commonSeriesSettings?: CommonPolarSeriesSettings;
- /** Specifies the options of a chart's legend. */
- legend?: AdvancedLegend;
- /** Specifies options for PolarChart widget series. */
- series?: Array;
- /** Defines options for the series template. */
- seriesTemplate?: PolarSeriesTemplate;
- tooltip?: PolarChartTooltip;
- /** Specifies value axis options for the PolarChart widget. */
- valueAxis?: PolarValueAxis;
- }
- 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?: {
- keepLabels?: boolean;
- };
- /** Specifies PieChart legend options. */
- legend?: PieLegend;
- /** Specifies options for the series of the PieChart 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 PieChart widget. */
- commonSeriesSettings?: CommonPieSeriesSettings;
- /** Specifies the type of the pie chart series. */
- type?: string;
- }
-}
-declare module DevExpress.viz {
- /** A widget providing charts of various types for web applications. */
- export class dxChart extends DevExpress.viz.charts.BaseChart {
- constructor(element: JQuery, options?: DevExpress.viz.charts.dxChartOptions);
- constructor(element: Element, options?: DevExpress.viz.charts.dxChartOptions);
- /** Sets the specified start and end values for the chart's argument axis. */
- zoomArgument(startValue: any, endValue: any): void;
- }
- /** A circular chart widget for web applications. */
- export class dxPieChart extends DevExpress.viz.charts.BaseChart {
- constructor(element: JQuery, options?: DevExpress.viz.charts.dxPieChartOptions);
- constructor(element: Element, options?: DevExpress.viz.charts.dxPieChartOptions);
- /**
* Provides access to the PieChart series.
* @deprecated Use the getAllSeries() method instead.
*/
- getSeries(): DevExpress.viz.charts.PieSeries;
- }
- /** A chart widget displaying data in a polar coordinate system. */
- export class dxPolarChart extends DevExpress.viz.charts.BaseChart {
- constructor(element: JQuery, options?: DevExpress.viz.charts.dxPolarChartOptions);
- constructor(element: Element, options?: DevExpress.viz.charts.dxPolarChartOptions);
- }
-}
-declare module 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 Use the scale | customMinorTicks option instead.
*/
- 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 feature is no longer available.
*/
- showCalculatedTicks?: boolean;
- /**
* Specifies an interval between minor ticks.
* @deprecated Use the scale | minorTickInterval option instead.
*/
- 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 Use the overlappingBehavior | useAutoArrangement option instead.
*/
- 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?: any;
- /**
* Specifies a precision for the formatted value displayed in the scale labels.
* @deprecated Use the scale | label | format | precision option instead.
*/
- 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 feature is no longer available.
*/
- hideFirstLabel?: boolean;
- /**
* Specifies whether or not to hide the first major tick on the scale.
* @deprecated This feature is no longer available.
*/
- hideFirstTick?: boolean;
- /**
* Specifies whether or not to hide the last scale label.
* @deprecated This feature is no longer available.
*/
- hideLastLabel?: boolean;
- /**
* Specifies whether or not to hide the last major tick on the scale.
* @deprecated This feature is no longer 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 Use the tick option instead.
*/
- 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?: any;
- /** Specifies the range bar's label indent in pixels. */
- indent?: number;
- /**
* Specifies a precision for the formatted value displayed by an indicator.
* @deprecated Use the text | format | precision option instead.
*/
- 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?: any;
- /** 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 LinearGauge widget. */
- horizontalOrientation?: string;
- /** Specifies the orientation of the rangeBar indicator on a horizontally oriented LinearGauge widget. */
- verticalOrientation?: string;
- }
- export interface SharedGaugeOptions extends viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions {
- /** Specifies animation options. */
- animation?: viz.core.Animation;
- /**
* Specifies a subtitle for the widget.
* @deprecated Use the title | subtitle option instead.
*/
- subtitle?: {
- /**
* Specifies font options for the subtitle.
* @deprecated Use the title | subtitle | font option instead.
*/
- font?: viz.core.Font;
- /**
* Specifies a text for the subtitle.
* @deprecated Use the title | subtitle | text option instead.
*/
- text?: string;
- };
- /** Configures 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 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 implements viz.core.LoadingIndicatorMethods {
- showLoadingIndicator(): void;
- hideLoadingIndicator(): 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 LinearGauge widget. */
- horizontalOrientation?: string;
- /** Specifies the orientation of a range container on a horizontally oriented LinearGauge widget. */
- verticalOrientation?: string;
- /** Specifies the width of the range container's start and end boundaries in the LinearGauge 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 LinearGauge widget. */
- horizontalOrientation?: string;
- label?: LinearScaleLabel;
- /** Specifies the orientation of scale ticks on a horizontally oriented LinearGauge widget. */
- verticalOrientation?: string;
- }
- export interface dxLinearGaugeOptions extends BaseGaugeOptions {
- /** Specifies the options required to set the geometry of the LinearGauge widget. */
- geometry?: {
- /** Indicates whether to display the LinearGauge widget vertically or horizontally. */
- orientation?: string;
- };
- /** Specifies gauge range container options. */
- rangeContainer?: LinearRangeContainer;
- scale?: LinearScale;
- }
- export interface CircularRangeContainer extends BaseRangeContainer {
- /** Specifies the orientation of the range container in the CircularGauge 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 CircularGauge 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;
- }
- 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?: any;
- /** Specifies the distance between the upper bar and bar labels in pixels. */
- indent?: number;
- /**
* Specifies a precision for the formatted value displayed by labels.
* @deprecated Use the label | format | precision option instead.
*/
- 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?: any;
- /** 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;
- }
-}
-declare module DevExpress.viz {
- /** A widget that represents a gauge with a linear scale. */
- export class dxLinearGauge extends DevExpress.viz.gauges.dxBaseGauge {
- constructor(element: JQuery, options?: DevExpress.viz.gauges.dxLinearGaugeOptions);
- constructor(element: Element, options?: DevExpress.viz.gauges.dxLinearGaugeOptions);
- }
- /** A widget that represents a gauge with a circular scale. */
- export class dxCircularGauge extends DevExpress.viz.gauges.dxBaseGauge {
- constructor(element: JQuery, options?: DevExpress.viz.gauges.dxCircularGaugeOptions);
- constructor(element: Element, options?: DevExpress.viz.gauges.dxCircularGaugeOptions);
- }
- /** A circular bar widget. */
- export class dxBarGauge extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods {
- constructor(element: JQuery, options?: DevExpress.viz.gauges.dxBarGaugeOptions);
- constructor(element: Element, options?: DevExpress.viz.gauges.dxBarGaugeOptions);
- showLoadingIndicator(): void;
- hideLoadingIndicator(): void;
- /** Returns an array of gauge values. */
- values(): Array;
- /** Updates the values displayed by a gauge. */
- values(values: Array): void;
- }
-}
-declare module DevExpress.viz.rangeSelector {
- export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions {
- /** Specifies the options for the range selector's background. */
- background?: {
- /** Specifies the background color for the RangeSelector. */
- 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 the RangeSelector'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.
* @deprecated Use the callValueChanged option instead.
*/
- callSelectedRangeChanged?: string;
- /** Specifies when to call the onValueChanged function. */
- callValueChanged?: 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;
- /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */
- negativesAsZeroes?: boolean;
- /** 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;
- /** Configures the chart 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 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?: any;
- /**
* Specifies a precision for the formatted value displayed in the scale labels.
* @deprecated Use the scale | label | format | precision option instead.
*/
- 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 Use the tickInterval option instead.
*/
- 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?: any;
- };
- /** 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 Use the minorTick | visible option instead.
*/
- 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 RangeSelector.
* @deprecated Use the value option instead.
*/
- selectedRange?: {
- /** Specifies the start value of the range to be selected when displaying the RangeSelector widget on a page. */
- startValue?: any;
- /** Specifies the end value of the range to be selected when displaying the RangeSelector widget on a page. */
- endValue?: any;
- };
- /** The selected range, initial or current. */
- value?: Array;
- /** 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.
* @deprecated Use the onValueChanged option instead.
*/
- onSelectedRangeChanged?: (e: {
- startValue: any;
- endValue: any;
- component: dxRangeSelector;
- element: Element;
- }) => void;
- /** A handler for the valueChanged event. */
- onValueChanged?: (e: {
- value: Array;
- previousValue: Array;
- 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 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?: any;
- /** 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.
* @deprecated Use the sliderMarker | format | precision option instead.
*/
- precision?: number;
- /** Indicates whether or not the slider markers are visible. */
- visible?: boolean;
- };
- }
-}
-declare module DevExpress.viz {
- /** A widget that allows end users to select a range of values on a scale. */
- export class dxRangeSelector extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods {
- constructor(element: JQuery, options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions);
- constructor(element: Element, options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions);
- showLoadingIndicator(): void;
- hideLoadingIndicator(): void;
- /** Redraws a widget. */
- render(skipChartAnimation?: boolean): void;
- /**
* Returns the currently selected range.
* @deprecated Use the getValue() method instead.
*/
- getSelectedRange(): { startValue: any; endValue: any; };
- /**
* Sets a specified range.
* @deprecated Use the setValue(value) method instead.
*/
- setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void;
- /** Gets the currently selected range. */
- getValue(): Array;
- /** Selects a specific range. */
- setValue(value: Array): void;
- /** Returns the DataSource instance. */
- getDataSource(): DevExpress.data.DataSource;
- }
-}
-declare module 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;
- /** Returns the DataSource instance. */
- getDataSource(): DevExpress.data.DataSource;
- }
- /** 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 Use the Layer | type instead.
*/
- type: string;
- /**
* Return the value of an attribute.
* @deprecated Use the Layer Element | attribute(name, value) method instead.
*/
- attribute(name: string): any;
- /**
* Provides information about the selection state of an area.
* @deprecated Use the Layer Element | selected() method instead.
*/
- selected(): boolean;
- /**
* Sets a new selection state for an area.
* @deprecated Use the Layer Element | selected(state) method instead.
*/
- selected(state: boolean): void;
- /**
* Applies the area settings specified as a parameter and updates the area appearance.
* @deprecated Use the Layer Element | applySettings(settings) method instead.
*/
- 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 using the Layer Element | attribute(name) method. The name parameter value for text is set at the dataField option.
*/
- text: string;
- /**
* Contains the type of the element.
* @deprecated Use the Layer | type instead.
*/
- type: string;
- /**
* Contains the URL of an image map marker.
* @deprecated Get the image URL using the Layer Element | attribute(name) method. The name parameter value for the image URL is set at the dataField option.
*/
- url: string;
- /**
* Contains the value of a bubble map marker.
* @deprecated Get the bubble value using the Layer Element | attribute(name) method. The name parameter for the bubble value is set at the dataField option.
*/
- value: number;
- /**
* Contains the values of a pie map marker.
* @deprecated Get the pie values using the Layer Element | attribute(name) method. The name parameter for pie values is set at the dataField option.
*/
- values: Array;
- /**
* Returns the value of an attribute.
* @deprecated Use the Layer Element | attribute(name, value) method instead.
*/
- attribute(name: string): any;
- /**
* Returns the coordinates of a specific marker.
* @deprecated Use the Layer Element | coordinates() method instead.
*/
- coordinates(): Array;
- /**
* Provides information about the selection state of a marker.
* @deprecated Use the Layer Element | selected() method instead.
*/
- selected(): boolean;
- /**
* Sets a new selection state for a marker.
* @deprecated Use the Layer Element | selected(state) method instead.
*/
- selected(state: boolean): void;
- /**
* Applies the marker settings specified as a parameter and updates marker appearance.
* @deprecated Use the Layer Element | applySettings(settings) method instead.
*/
- 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. */
- dataSource?: 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 source 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 Use the layers | borderWidth option instead.
*/
- borderWidth?: number;
- /**
* Specifies a color for the area border.
* @deprecated Use the layers | borderColor option instead.
*/
- borderColor?: string;
- /**
* Specifies a color for an area.
* @deprecated Use the layers | color option instead.
*/
- color?: string;
- /**
* Specifies the function that customizes each area individually.
* @deprecated Use the layers | customize option instead.
*/
- customize?: (areaInfo: Area) => AreaSettings;
- /**
* Specifies a color for the area border when the area is hovered over.
* @deprecated Use the layers | hoveredBorderColor option instead.
*/
- hoveredBorderColor?: string;
- /**
* Specifies the pixel-measured width of the area border when the area is hovered over.
* @deprecated Use the layers | hoveredBorderWidth option instead.
*/
- hoveredBorderWidth?: number;
- /**
* Specifies a color for an area when this area is hovered over.
* @deprecated Use the layers | hoveredColor option instead.
*/
- hoveredColor?: string;
- /**
* Specifies whether or not to change the appearance of an area when it is hovered over.
* @deprecated Use the layers | hoverEnabled option instead.
*/
- hoverEnabled?: boolean;
- /**
* Configures area labels.
* @deprecated Use the layers | label option instead.
*/
- label?: {
- /**
* Specifies the data field that provides data for area labels.
* @deprecated Use the layers | label | dataField option instead.
*/
- dataField?: string;
- /**
* Enables area labels.
* @deprecated Use the layers | label | enabled option instead.
*/
- enabled?: boolean;
- /**
* Specifies font options for area labels.
* @deprecated Use the layers | label | font option instead.
*/
- font?: viz.core.Font;
- };
- /**
* Specifies the name of the palette or a custom range of colors to be used for coloring a map.
* @deprecated Use the layers | palette option instead.
*/
- palette?: any;
- /**
* Specifies the number of colors in a palette.
* @deprecated Use the layers | paletteSize option instead.
*/
- paletteSize?: number;
- /**
* Allows you to paint areas with similar attributes in the same color.
* @deprecated Use the layers | colorGroups option instead.
*/
- colorGroups?: Array;
- /**
* Specifies the field that provides data to be used for coloring areas.
* @deprecated Use the layers | colorGroupingField option instead.
*/
- colorGroupingField?: string;
- /**
* Specifies a color for the area border when the area is selected.
* @deprecated Use the layers | selectedBorderColor option instead.
*/
- selectedBorderColor?: string;
- /**
* Specifies a color for an area when this area is selected.
* @deprecated Use the layers | selectedColor option instead.
*/
- selectedColor?: string;
- /**
* Specifies the pixel-measured width of the area border when the area is selected.
* @deprecated Use the layers | selectedBorderWidth option instead.
*/
- selectedBorderWidth?: number;
- /**
* Specifies whether single or multiple areas can be selected on a vector map.
* @deprecated Use the layers | selectionMode option instead.
*/
- selectionMode?: string;
- }
- export interface MarkerSettings {
- /**
* Specifies a color for the marker border.
* @deprecated Use the layers | borderColor option instead.
*/
- borderColor?: string;
- /**
* Specifies the width of the marker border in pixels.
* @deprecated Use the layers | borderWidth option instead.
*/
- borderWidth?: number;
- /**
* Specifies a color for a marker of the dot or bubble type.
* @deprecated Use the layers | color option instead.
*/
- color?: string;
- /**
* Specifies the function that customizes each marker individually.
* @deprecated Use the layers | customize option instead.
*/
- customize?: (markerInfo: Marker) => MarkerSettings;
- /**
* Specifies the pixel-measured width of the marker border when the marker is hovered over.
* @deprecated Use the layers | hoveredBorderWidth option instead.
*/
- hoveredBorderWidth?: number;
- /**
* Specifies a color for the marker border when the marker is hovered over.
* @deprecated Use the layers | hoveredBorderColor option instead.
*/
- hoveredBorderColor?: string;
- /**
* Specifies a color for a marker of the dot or bubble type when this marker is hovered over.
* @deprecated Use the layers | hoveredColor option instead.
*/
- hoveredColor?: string;
- /**
* Specifies whether or not to change the appearance of a marker when it is hovered over.
* @deprecated Use the layers | hoverEnabled option instead.
*/
- hoverEnabled?: boolean;
- /**
* Specifies marker label options.
* @deprecated Use the layers | label option instead.
*/
- label?: {
- /**
* Enables marker labels.
* @deprecated Use the layers | label | enabled option instead.
*/
- enabled?: boolean;
- /**
* Specifies font options for marker labels.
* @deprecated Use the layers | label | font option instead.
*/
- 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 Use the layers | maxSize option instead.
*/
- 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 Use the layers | minSize option instead.
*/
- minSize?: number;
- /**
* Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type.
* @deprecated Use the layers | opacity option instead.
*/
- opacity?: number;
- /**
* Specifies the pixel-measured width of the marker border when the marker is selected.
* @deprecated Use the layers | selectedBorderWidth option instead.
*/
- selectedBorderWidth?: number;
- /**
* Specifies a color for the marker border when the marker is selected.
* @deprecated Use the layers | selectedBorderColor option instead.
*/
- selectedBorderColor?: string;
- /**
* Specifies a color for a marker of the dot or bubble type when this marker is selected.
* @deprecated Use the layers | selectedColor option instead.
*/
- selectedColor?: string;
- /**
* Specifies whether a single or multiple markers can be selected on a vector map.
* @deprecated Use the layers | selectionMode option instead.
*/
- selectionMode?: string;
- /**
* Specifies the size of markers. Setting this option makes sense for any type of marker except bubble.
* @deprecated Use the layers | size option instead.
*/
- size?: number;
- /**
* Specifies the type of markers to be used on the map.
* @deprecated Use the layers | elementType option instead.
*/
- 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 Use the layers | palette option instead.
*/
- palette?: any;
- /**
* Allows you to paint markers with similar attributes in the same color.
* @deprecated Use the layers | colorGroups option instead.
*/
- colorGroups?: Array;
- /**
* Specifies the field that provides data to be used for coloring markers.
* @deprecated Use the layers | colorGroupingField option instead.
*/
- colorGroupingField?: string;
- /**
* Allows you to display bubbles with similar attributes in the same size.
* @deprecated Use the layers | sizeGroups option instead.
*/
- sizeGroups?: Array;
- /**
* Specifies the field that provides data to be used for sizing bubble markers.
* @deprecated Use the layers | sizeGroupingField option instead.
*/
- sizeGroupingField?: string;
- }
- export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions {
- /**
* An object specifying options for the map areas.
* @deprecated Use the "area" type element of the layers array.
*/
- 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 VectorMap 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 a data source for the map area.
* @deprecated Use the layers | dataSource option instead.
*/
- mapData?: any;
- /**
* Specifies a data source for the map markers.
* @deprecated Use the layers | dataSource option instead.
*/
- markers?: any;
- /**
* An object specifying options for the map markers.
* @deprecated Use the "marker" type element of the layers array.
*/
- markerSettings?: MarkerSettings;
- /** Configures tooltips. */
- tooltip?: viz.core.Tooltip;
- /** Configures map legends. */
- legends?: Array