@progress/kendo-react-charts/option-types/series-defaults/notes.interface.d.ts

React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package

/**
 * @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, SeriesNoteVisualArgs } from '../../common/property-types.js';
import { SeriesDefaultsNotesIcon } from './notes.icon.interface.js';
import { SeriesDefaultsNotesLabel } from './notes.label.interface.js';
/**
 * @hidden
 */
export interface SeriesDefaultsNotes {
    /**
     * The line of the notes.
     */
    line?: NoteLine;
    /**
     * 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 for getting 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?: SeriesDefaultsNotesIcon;
    /**
     * The label of the notes.
     */
    label?: SeriesDefaultsNotesLabel;
}