@progress/kendo-angular-gauges/types/labels.interface.d.ts

Kendo UI Angular Gauges

/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { Border } from './border.interface';
import { Margin } from './margin.interface';
import { Padding } from './padding.interface';
/**
 * The configuration of the scale labels.
 */
export interface Labels {
    /**
     * The background of the labels.
     * Accepts valid CSS color strings, including hex and rgb.
     */
    background?: string;
    /**
     * The border of the labels.
     */
    border?: Border;
    /**
     * The color of the labels.
     * Accepts valid CSS color strings, including hex and rgb.
     */
    color?: string;
    /**
     * The font of the labels.
     */
    font?: string;
    /**
     * The format that is used to display the labels.
     * Uses the IntlService [`format`]({% slug api_intl_intlservice %}#toc-format) method.
     */
    format?: string;
    /**
     * The margin of the labels.
     */
    margin?: number | Margin;
    /**
     * The padding of the labels.
     */
    padding?: number | Padding;
    /**
     * The function which returns the label content.
     *
     * The available fields in the function argument are:
     *
     * - `value`—The value of the label.
     * @param {any} e - The parameters for the content callback.
     * @returns {string} - Returns the label string that will be displayed.
     */
    content?: (e: any) => string;
    /**
     * The visibility of the labels.
     */
    visible?: boolean;
}