ag-charts-types/dist/types/src/chart/bandHighlightOptions.d.ts

Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue

import type { AgColorType } from '../series/cartesian/commonOptions';
import type { CssColor, Opacity, PixelSize } from './types';
export interface AgBandHighlightOptions {
    /** Whether to show the band highlight. */
    enabled?: boolean;
    /** The colour of the stroke for the lines. */
    stroke?: CssColor;
    /** The width in pixels of the stroke for the lines. */
    strokeWidth?: PixelSize;
    /** The opacity of the stroke for the lines. */
    strokeOpacity?: Opacity;
    /** Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels. */
    lineDash?: PixelSize[];
    /** The initial offset of the dashed line in pixels. */
    lineDashOffset?: PixelSize;
    /** The colour to use for the fill of the band. */
    fill?: AgColorType;
    /** The opacity of the fill for the band. */
    fillOpacity?: Opacity;
}