ViewportOverlayApi<T>

Defines methods for managing viewport overlays in Graphite Grid.

Type parameters

Type parameter
`T`

Properties

Name
hideHeaderOverlay
Type
() => void
Description
Hides the header overlay if it is currently visible.
Name
hideRowOverlay
Type
() => void
Description
Hides the row overlay if it is currently visible.
Name
hideViewportOverlay
Type
() => void
Description
Hides the viewport overlay if it is currently visible.
Name
setHeaderOverlayRenderer
Type
(renderer: null | OverlayFunction<T>) => void
Description
Sets the renderer function for the header overlay.
Name
setRowOverlayRenderer
Type
(renderer: null | OverlayFunction<T>) => void
Description
Sets the renderer function for the row overlay.
Name
setViewportOverlayRenderer
Type
(renderer: null | OverlayFunction<T>) => void
Description
Sets the renderer function for the viewport overlay.
Name
showHeaderOverlay
Type
() => void
Description
Displays the header overlay. Will only be shown if a valid header overlay component is set in the grid.
Name
showRowOverlay
Type
() => void
Description
Displays the row overlay. Will only be shown if a valid row overlay component is set in the grid.
Name
showViewportOverlay
Type
() => void
Description
Displays the viewport overlay. Will only be shown if a valid viewport overlay component is set in the grid.
Name
toggleHeaderOverlay
Type
() => void
Description
Toggles the visibility of the header overlay.
Name
toggleRowOverlay
Type
() => void
Description
Toggles the visibility of the row overlay.
Name
toggleViewportOverlay
Type
() => void
Description
Toggles the visibility of the viewport overlay.