@progress/kendo-angular-charts
Version:
Kendo UI Charts for Angular - A comprehensive package for creating beautiful and interactive data visualization. Every chart type, stock charts, and sparklines are included.
59 lines (58 loc) • 2.83 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 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 { Border, HighlightLine, HighlightVisualArgs, HighlightToggleArgs } from '../../common/property-types';
import { MarkersHighlight } from './markers-highlight.interface';
/**
* Represents the configuration options of the series highlight.
*/
export interface SeriesHighlight {
/**
* Specifies the border of the highlighted Chart series.
* Computes the color automatically from the base point color.
* This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
* `"donut"`, `"bubble"`, `"pie"`, `"candlestick"`, or `"ohlc"`.
*/
border?: Border;
/**
* Specifies the highlight color. Accepts a valid CSS color string, including HEX and RGB.
* This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
*/
color?: string;
/**
* Specifies the line of the highlighted Chart series.
* Computes the color automatically from the base point color.
* This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
*/
line?: HighlightLine;
/**
* Specifies the opacity of the highlighted points.
* This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"pie"`, or `"donut"`.
*/
opacity?: number;
/**
* Specifies the opacity of the series when another series is highlighted.
*/
inactiveOpacity?: number;
/**
* Specifies the appearance of the highlighted point markers.
* This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"line"`, `"area"`, `"scatter"`, `"scatterLine"`, or `"rangeArea"`.
*/
markers?: MarkersHighlight;
/**
* Specifies a function for handling the toggling of the points highlight.
*/
toggle?: (e: HighlightToggleArgs) => void;
/**
* Determines whether the Chart highlights the series when the user hovers over it with the mouse.
* When set to `true`, the Chart highlights the series when the user hovers over it with the mouse.
* By default, the highlighting of the Chart series is enabled.
*/
visible?: boolean;
/**
* Specifies a function for setting custom visuals for the point highlights.
*/
visual?: (e: HighlightVisualArgs) => drawing.Element;
}