@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
54 lines (53 loc) • 2.07 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { drawing } from '@progress/kendo-drawing';
import { NoteLine, NotePosition, SeriesNoteVisualArgs } from '../../common/property-types.js';
import { SeriesNotesIcon } from './notes.icon.interface.js';
import { SeriesNotesLabel } from './notes.label.interface.js';
/**
* @hidden
*/
export interface SeriesNotes {
/**
* The line of the series notes.
*/
line?: NoteLine;
/**
* The position of the series note.
*
* The available options are:
* - `"top"`—The note is positioned on the top.
* - `"bottom"`—The note is positioned on the bottom.
* - `"left"`—The note is positioned on the left.
* - `"right"`—The note is positioned on the right.
*/
position?: NotePosition;
/**
* A function for creating a custom visual for the notes.
*
* The available argument fields are:
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
* - `options`—The note options.
* - `createVisual`—A function that can be used to get the default visual.
* - `category`—The category of the note point.
* - `dataItem`—The `dataItem` of the note point.
* - `value`—The value of the note point.
* - `sender`—The Chart instance.
* - `series`—The series of the note point.
* - `text`—The note text.
*/
visual?: (e: SeriesNoteVisualArgs) => drawing.Element;
/**
* The icon of the notes.
*/
icon?: SeriesNotesIcon;
/**
* The label of the notes.
*/
label?: SeriesNotesLabel;
}