/**-----------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { drawing } from '@progress/kendo-drawing';
import { PlotBandLabelVisualArgs } from '../common/property-types';
import { Border } from './border.interface';
import { Margin } from './margin.interface';
import { Padding } from './padding.interface';
/**
 * Specifies the appearance configuration for the plot band label.
 */
export interface PlotBandLabel {
    /**
     * Specifies the horizontal alignment of the label text.
     *
     * By default, the label is aligned to the left.
     *
     * Use `center` for center positioning, `right` for positioning on the right side, or `left` for positioning on the left side.
     */
    align?: 'center' | 'right' | 'left';
    /**
     * Specifies the background color of the label. Accepts a valid CSS color string, including hex and rgb.
     */
    background?: string;
    /**
     * Specifies the border of the label.
     */
    border?: Border;
    /**
     * Specifies the color of the plot band label text.
     * Accepts a valid [CSS `color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
     * configuration string, including hex and rgb.
     */
    color?: string;
    /**
     * Specifies the font of the plot band label text.
     * Accepts a valid [CSS `font`](https://developer.mozilla.org/en-US/docs/Web/CSS/font)
     * configuration string.
     */
    font?: string;
    /**
     * Specifies the margin of the label. A numeric value sets all margins.
     */
    margin?: Margin | number;
    /**
     * Specifies the padding of the label. A numeric value sets all paddings.
     */
    padding?: Padding | number;
    /**
     * Specifies the vertical position of the label inside the plot band.
     *
     * By default, the label is aligned to the top.
     *
     * Use `bottom` for positioning at the bottom, `center` for center positioning, or `top` for positioning at the top.
     */
    position?: 'bottom' | 'center' | 'top';
    /**
     * Specifies the rotation angle of the label. By default, the label is not rotated.
     */
    rotation?: number;
    /**
     * Specifies the text of the label.
     *
     * You can split the text into multiple lines by using line feed characters ("\n").
     */
    text?: string;
    /**
     * Determines whether to display the plot band label.
     * By default, the plot band labels are not displayed.
     */
    visible?: boolean;
    /**
     * Specifies a function that can be used to create a custom visual for the label.
     */
    visual?: (e: PlotBandLabelVisualArgs) => drawing.Element;
}
