import { XYComponentConfigInterface } from '../../core/xy-component/config';
import { AxisType } from '../axis/types';
import { UnovisText } from '../../types/text';
import { PlotbandLabelOrientation, PlotbandLabelPosition } from './types';

export interface PlotbandConfigInterface<Datum> extends Partial<XYComponentConfigInterface<Datum>> {
    /**
     * Fill color of the plotband.
     * Accepts any valid CSS color string.
     *
     * @default 'var(--vis-plotband-color)'
     */
    color?: string;
    /** Axis to draw the plotband on.
     *  @default AxisType.Y
     */
    axis?: AxisType;
    /** Start coordinate for the plotband.
     *  @default 0
     */
    from?: number | null | undefined;
    /** End coordinate for the plotband.
     *  @default 0
     */
    to?: number | null | undefined;
    /**
     * Duration of the animation in milliseconds.
     *
     * @default 300
     */
    duration?: number;
    /**
     * Label to display on the plotband.
     * Accepts a plain string (use `\n` for line breaks), or one or more `UnovisText` blocks
     * for styled multi-line labels. Font size, color and font family set on a text block
     * take priority over the `labelSize` and `labelColor` options.
     *
     * @default undefined
     */
    labelText?: string | UnovisText | UnovisText[];
    /** Position of the label relative to the plotband area (e.g., 'top-left-outside').
     *  Can be customized with a string.
     *  @default PlotbandLabelPosition.TopLeftOutside
     */
    labelPosition?: PlotbandLabelPosition;
    /** Horizontal offset (in pixels) for positioning the label.
     *  @default 14
     */
    labelOffsetX?: number;
    /** Vertical offset (in pixels) for positioning the label.
     *  @default 14
     */
    labelOffsetY?: number;
    /** Orientation of the label text.
     *  @default PlotbandLabelOrientation.Horizontal
     */
    labelOrientation?: PlotbandLabelOrientation;
    /** Optional color for the label text */
    labelColor?: string;
    /**
     * Font size (in pixels) for the label text.
     * Uses the CSS variable `--vis-plotband-label-font-size` by default, which resolves to `12px`.
     *
     * @default 12
     */
    labelSize?: number;
}
export declare const PlotbandDefaultConfig: PlotbandConfigInterface<unknown>;