scale label

Specifies common options for scale labels.

Type: Object

Scale labels represent textual values for major scale ticks. The label object exposes properties that allow you to specify custom text for scale labels and properties to change the text font.

Show Example:
jQuery

In this example, the text of the scale labels is customized using the customizeText option. In addition, the color and size options of the scale label text are changed.

<div id="circularGaugeContainer" style="height:400px;max-width:400px;margin:0px auto"></div>
$(function () {
    $("#circularGaugeContainer").dxCircularGauge({
        scale: {
            startValue: 0,
            endValue: 100,
            label: {
                customizeText: function (label) {
                    return label.valueText + ' mph';
                },
                font: {
                    color: 'dodgerblue',
                    size: 14
                }
            }
        },
        value: 32
    });
});

customizeText

Specifies a callback function that returns the text to be displayed in scale labels.

Type: function(scaleValue)
Function parameters:
scaleValue: Object
Defines a scale value.
Object structure:
value: Number
Specifies the scale value represented by a label.
valueText: String
Specifies the value with applied formatting if the format option is set.
Return Value: String
The text to be displayed by a scale label.
Cannot be used in themes.

When implementing a callback function for this property, use the scale value to be displayed in a label. This value can be accessed using the fields of the object that is passed as the function's parameter. Alternatively, you can use the this object within the function. This object has the same structure as the object passed as a parameter.

For general information on data formatting, refer to the Data Formatting topic.

View Demo

Show Example:
jQuery

In this example, the text of the scale labels is customized using the customizeText option.

<div id="circularGaugeContainer" style="height:400px;max-width:400px;margin:0px auto"></div>
$(function () {
    $("#circularGaugeContainer").dxCircularGauge({
        rangeContainer: { backgroundColor: 'palegreen' },
        scale: {
            startValue: 0,
            endValue: 100,
            label: {
                customizeText: function (label) {
                    return label.valueText + ' mph';
                }
            }
        },
        value: 32
    });
});

font

Specifies font options for the text displayed in the scale labels of the gauge.

Type: Object

Show Example:
jQuery

In this example, font options of the scale labels are changed.

<div id="circularGaugeContainer" style="height:400px;max-width:400px;margin:0px auto"></div>
$(function () {
    $("#circularGaugeContainer").dxCircularGauge({
        rangeContainer: { backgroundColor: 'turquoise' },
        scale: {
            startValue: 0,
            endValue: 100,
            label: {
                font: {
                    color: 'dodgerblue',
                    size: 14,
                    weight: 700,
                    family: 'Zapf-Chancery, cursive'
                }
            }
        },
        value: 32
    });
});

format

Specifies a format for the text displayed in scale labels.

Type: Format
Default Value: undefined
See Also
  • format - provides a comprehensive overview of formatting capabilities. Note that only numeric subset of the predefined formats can be used.
  • Data Formatting - shows how to apply formatting to various widget elements.
Show Example:
jQuery

In this example, the text of the scale labels is displayed in a percent format.

<div id="circularGaugeContainer" style="height:400px;max-width:400px;margin:0px auto"></div>
$(function () {
    $("#circularGaugeContainer").dxCircularGauge({
        rangeContainer: { backgroundColor: 'steelblue' },
        scale: {
            startValue: 0,
            endValue: 1,
            label: {
                format: 'percent'
            }
        },
        value: 0.86
    });
});

indentFromTick

Specifies the spacing between scale labels and ticks.

Type: Number
Default Value: 10

Show Example:
jQuery

In this example, the scale labels are indented from the scale ticks by 20 pixels.

<div id="circularGaugeContainer" style="height:400px;max-width:400px;margin:0px auto"></div>
$(function () {
    $("#circularGaugeContainer").dxCircularGauge({
        rangeContainer: { backgroundColor: 'wheat' },
        scale: {
            startValue: 0,
            endValue: 100,
            label: {
                indentFromTick: 20
            }
        },
        value: 32
    });
});

overlappingBehavior

Specifies the overlap resolving options to be applied to scale labels.

Type: Object

precision

Deprecated

Use the scale | label | format | precision option instead.

Specifies a precision for the formatted value displayed in the scale labels.

Type: Number
Default Value: undefined

useRangeColors

Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container.

Type: Boolean
Default Value: false

To paint all scale labels in a single color, you can use the color option of the font object. Alternatively, you can paint scale labels similarly to ranges in the range container. For this purpose, assign true to the useRangeColors option.

visible

Specifies whether or not scale labels are visible on the gauge.

Type: Boolean
Default Value: true

Show Example:
jQuery

Change the visibility of the scale labels by toggling the check box under the gauge.

<div id="circularGaugeContainer" style="height:400px;max-width:400px;margin:0px auto"></div>
<div id="checkboxContainer" style="height:20px;width:300px;margin:0px auto;font-family:'Trebuchet MS',Arial,sans-serif;font-size:14px;text-align:center">
    <input type="checkbox" id="visibleScaleLabelsCheckbox" checked> Show Scale Labels
</div>

$(function () {
    $("#circularGaugeContainer").dxCircularGauge({
        rangeContainer: { backgroundColor: 'steelblue' },
        scale: {
            startValue: 0,
            endValue: 1,
            label: {
                visible: true
            }
        },
        value: 0.43
    });

    $('#visibleScaleLabelsCheckbox').change(function () {
        var gauge = $('#circularGaugeContainer').dxCircularGauge('instance');
        gauge.option({
            scale: {
                label: { visible: this.checked }
            }
        });
    });
});