Interface ISheetLayersRegistry

Adds layers to every sheet of every workbook element.

interface ISheetLayersRegistry {
register(entry: SheetLayersEntry, replace?: boolean): () => void;
unregister(key: string): boolean;
}

Index

Methods

register unregister

Methods

register

register(entry: SheetLayersEntry, replace?: boolean): () => void
Add layers to every sheet surface the entry names, for as long as it is registered.
Parameters
- entry: SheetLayersEntry
  The layers, and where they go.
- Optionalreplace: boolean
  Whether to replace an entry with the same key. Without it, a second entry with the same key throws.
Returns () => void
A function that removes this registration. It does nothing once the key is unregistered or registered again by someone else.
Default Value
```
false
```

unregister

unregister(key: string): boolean
Remove an entry's layers from every sheet.
Parameters
- key: string
  The entry's key.
Returns boolean
Whether the entry was registered.