Interface TocApi

API to control the Toc component imperatively

interface TocApi {
    getItemById(id: string): TocItem | undefined;
    getItemByLayerId(layerId: string): TocItem | undefined;
    getItems(): TocItem[];
}

Index

Methods

getItemById getItemByLayerId getItems

Methods

getItemById

getItemById(id: string): TocItem | undefined
Returns the toc item for the given id.
Parameters
- id: string
Returns TocItem | undefined
- Defined in toc/model/types.ts:11

getItemByLayerId

getItemByLayerId(layerId: string): TocItem | undefined
Returns the item that corresponds with the layerId.
Parameters
- layerId: string
Returns TocItem | undefined
- Defined in toc/model/types.ts:16

getItems

getItems(): TocItem[]
Returns the list of all registered items in the Toc.

Returns TocItem[]
- Defined in toc/model/types.ts:21