Interface CustomHighlighterProps<Highlighter>

interface CustomHighlighterProps<
    Highlighter extends
        dia.HighlighterView.Options = dia.HighlighterView.Options,
> {
    children?: ReactNode;
    isHidden?: boolean;
    onCreateHighlighter: OnAddHighlighter<Highlighter>;
    options: Highlighter;
}

Type Parameters

Highlighter extends dia.HighlighterView.Options = dia.HighlighterView.Options

Index

Properties

children? isHidden? onCreateHighlighter options

Properties

`Optional` `Readonly`children

children?: ReactNode

Child elements to render inside the highlighter.

`Optional` `Readonly`isHidden

isHidden?: boolean

If the highlighter is disabled or not.

`Readonly`onCreateHighlighter

onCreateHighlighter: OnAddHighlighter<Highlighter>

Callback function should return any highlighter.

Param: cellView

The cell view to which the highlighter is attached.

Param: element

The SVG element to which the highlighter is attached.

Param: highlighterId

The ID of the highlighter.

Param: options

The options for the highlighter.

Returns

The created highlighter.

`Readonly`options

options: Highlighter

This should be memoized