devextreme/viz/gauges/base_gauge.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

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

import {
    PaletteType,
    PaletteExtensionModeType
} from '../palette';

import {
    template
} from '../../core/templates/template';

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

import BaseWidget, {
    BaseWidgetLoadingIndicator,
    BaseWidgetOptions,
    BaseWidgetTooltip,
    Font
} from '../core/base_widget';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeOptions<T = BaseGauge> extends BaseWidgetOptions<T> {
    /** Specifies animation options. */
    animation?: BaseGaugeAnimation;
    /** Specifies the color of the parent page element. */
    containerBackgroundColor?: string;
    /** Configures the loading indicator. */
    loadingIndicator?: BaseGaugeLoadingIndicator;
    /** A function that is executed when a tooltip becomes hidden. */
    onTooltipHidden?: ((e: { component?: T, element?: dxElement, model?: any, target?: any }) => any);
    /** A function that is executed when a tooltip appears. */
    onTooltipShown?: ((e: { component?: T, element?: dxElement, model?: any, target?: any }) => any);
    /** Specifies options of the gauge's range container. */
    rangeContainer?: BaseGaugeRangeContainer;
    /** Specifies options of the gauge's scale. */
    scale?: BaseGaugeScale;
    /** Specifies a set of subvalues to be designated by the subvalue indicators. */
    subvalues?: Array<number>;
    /** Configures tooltips. */
    tooltip?: BaseGaugeTooltip;
    /** Specifies the main value on a gauge. */
    value?: number;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeAnimation {
    /** Determines how long animation runs. */
    duration?: number;
    /** Specifies the animation easing mode. */
    easing?: 'easeOutCubic' | 'linear';
    /** Indicates whether or not animation is enabled. */
    enabled?: boolean;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeLoadingIndicator extends BaseWidgetLoadingIndicator {
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeRangeContainer {
    /** 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;
    /** Specifies the palette to be used for colorizing ranges in the range container. */
    palette?: Array<string> | PaletteType;
    /** Specifies what to do with colors in the palette when their number is less than the number of ranges in the range container. */
    paletteExtensionMode?: PaletteExtensionModeType;
    /** An array of objects representing ranges contained in the range container. */
    ranges?: Array<{ color?: string, endValue?: number, startValue?: number }>;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeScale {
    /** Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only. */
    allowDecimals?: boolean;
    /** Specifies an array of custom minor ticks. */
    customMinorTicks?: Array<number>;
    /** Specifies an array of custom major ticks. */
    customTicks?: Array<number>;
    /** Specifies the end value for the scale of the gauge. */
    endValue?: number;
    /** Specifies common options for scale labels. */
    label?: BaseGaugeScaleLabel;
    /** Specifies options of the gauge's minor ticks. */
    minorTick?: { color?: string, length?: number, opacity?: number, visible?: boolean, width?: number };
    /** Specifies an interval between minor ticks. */
    minorTickInterval?: number;
    /** Specifies the minimum distance between two neighboring major ticks in pixels. */
    scaleDivisionFactor?: number;
    /** Specifies the start value for the scale of the gauge. */
    startValue?: number;
    /** Specifies options of the gauge's major ticks. */
    tick?: { color?: string, length?: number, opacity?: number, visible?: boolean, width?: number };
    /** Specifies an interval between major ticks. */
    tickInterval?: number;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeScaleLabel {
    /** Specifies a callback function that returns the text to be displayed in scale labels. */
    customizeText?: ((scaleValue: { value?: number, valueText?: string }) => string);
    /** Specifies font options for the text displayed in the scale labels of the gauge. */
    font?: Font;
    /** Formats a value before it is displayed in a scale label. Accepts only numeric formats. */
    format?: format;
    /** Decides how to arrange scale labels when there is not enough space to keep all of them. */
    overlappingBehavior?: 'hide' | 'none';
    /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */
    useRangeColors?: boolean;
    /** Specifies whether or not scale labels are visible on the gauge. */
    visible?: boolean;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface BaseGaugeTooltip extends BaseWidgetTooltip {
    /** Specifies a custom template for a tooltip. */
    contentTemplate?: template | ((scaleValue: { value?: number, valueText?: string }, element: dxElement) => string | Element | JQuery);
    /** Allows you to change the appearance of specified tooltips. */
    customizeTooltip?: ((scaleValue: { value?: number, valueText?: string }) => any);
    /**  */
    interactive?: boolean;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
/** A gauge widget. */
export type BaseGauge = dxBaseGauge;
/** Warning! This type is used for internal purposes. Do not import it directly. */
export class dxBaseGauge extends BaseWidget {
    constructor(element: Element, options?: BaseGaugeOptions)
    constructor(element: JQuery, options?: BaseGaugeOptions)
    /** Gets subvalues. */
    subvalues(): Array<number>;
    /** Updates subvalues. */
    subvalues(subvalues: Array<number>): void;
    /** Gets the main value. */
    value(): number;
    /** Updates the main value. */
    value(value: number): void;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface CommonIndicator {
    /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */
    arrowLength?: number;
    /** 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 radius small enough for the indicator to begin adapting. */
    beginAdaptingAtRadius?: number;
    /** Specifies a color of the indicator. */
    color?: string;
    /** Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation option is "vertical". */
    horizontalOrientation?: 'left' | 'right';
    /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */
    indentFromCenter?: number;
    /** Specifies the indicator length. */
    length?: number;
    /** Specifies the distance between the indicator and the invisible scale line. */
    offset?: number;
    /** Sets the palette to be used to colorize indicators differently. */
    palette?: Array<string> | PaletteType;
    /** 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 range bar size for an indicator of the rangeBar type. */
    size?: number;
    /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */
    spindleGapSize?: number;
    /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */
    spindleSize?: number;
    /** Specifies the appearance of the text displayed in an indicator of the rangeBar type. */
    text?: { customizeText?: ((indicatedValue: { value?: number, valueText?: string }) => string), font?: Font, format?: format, indent?: number };
    /** Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation option is "horizontal". */
    verticalOrientation?: 'bottom' | 'top';
    /** Specifies the width of an indicator in pixels. */
    width?: number;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export type GaugeIndicatorType = 'circle' | 'rangeBar' | 'rectangle' | 'rectangleNeedle' | 'rhombus' | 'textCloud' | 'triangleMarker' | 'triangleNeedle' | 'twoColorNeedle';
/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface GaugeIndicator extends CommonIndicator {
    /** Specifies the type of gauge indicators. */
    type?: GaugeIndicatorType;
}