Interface SheetLayersEntry

Layers a plugin adds to sheets, through DefaultSheetLayersRegistry.

interface SheetLayersEntry {
    key: string;
    layers: ReactNode;
    sheets?: SheetLayersFilter;
    surface?: "all" | SheetSurface | readonly SheetSurface[];
}

Properties

key: string

Identifies the entry, for ISheetLayersRegistry.unregister. Case-insensitive.

layers: ReactNode

The layers: one grid child or an array of them, each rooted in a Layer and each with its own key, as in a sheet's layers.

The sheets whose surfaces get the layers. Omitted, every sheet's do.

surface?: "all" | SheetSurface | readonly SheetSurface[]

The surfaces the layers are rendered on. A layer on more than one reads which it is on with useGridSurface.

'cells'