import { XYComponentConfigInterface } from '../../core/xy-component/config'; import { AxisType } from '../axis/types'; import { UnovisText } from '../../types/text'; import { PlotlineLabelPosition, PlotlineLabelOrientation, PlotlineLineStylePresets } from './types'; export interface PlotlineConfigInterface extends Partial> { /** * Color of the plotline. * Uses CSS variable: `--vis-plotline-color`. * * @default 'var(--vis-plotline-color)' */ color?: string; /** * Line width in pixels. * Uses CSS variable: `--vis-plotline-width`. * * @default 2 */ lineWidth?: number; /** * Plotline direction type. * Should be either `AxisType.X` or `AxisType.Y`. * * @default AxisType.Y */ axis?: AxisType | string; /** * Value to draw the plotline at. * * @default 0 */ value?: number | null | undefined; /** * Duration of the animation in milliseconds. * * @default 300 */ duration?: number; /** * Line style of the plotline. * Can be a named preset or an array of numbers representing `stroke-dasharray`. * Uses CSS variable: `--vis-plotline-dasharray`. * * @default PlotlineLineStylePresets.Solid */ lineStyle?: PlotlineLineStylePresets | number[]; /** * Label to display on the plotline. * 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 plotline. * * @default PlotlineLabelPosition.TopRight */ labelPosition?: PlotlineLabelPosition; /** * Horizontal offset of the label in pixels. * * @default 14 */ labelOffsetX?: number; /** * Vertical offset of the label in pixels. * * @default 14 */ labelOffsetY?: number; /** * Orientation of the label: horizontal or vertical. * * @default PlotlineLabelOrientation.Horizontal */ labelOrientation?: PlotlineLabelOrientation; /** * Color of the label text. * Uses CSS variable: `--vis-plotline-label-color`. * * @default 'var(--vis-plotline-label-color)' */ labelColor?: string; /** * Font size of the label text in pixels. * Uses CSS variable: `--vis-plotline-label-font-size`. * * @default 'var(--vis-plotline-label-font-size)' */ labelSize?: number; } export declare const PlotlineDefaultConfig: PlotlineConfigInterface;