Open Pioneer Trails Packages
    Preparing search index...

    Interface TocProps

    Props supported by the Toc component.

    interface TocProps {
        autoShowParents?: boolean;
        basemapSwitcherProps?: Omit<BasemapSwitcherProps, "mapId">;
        collapsibleGroups?: boolean;
        initiallyCollapsed?: boolean;
        map?: MapModel;
        onDisposed?: (event: TocDisposedEvent) => void;
        onReady?: (event: TocReadyEvent) => void;
        showBasemapSwitcher?: boolean;
        showTools?: boolean;
        toolsConfig?: ToolsConfig;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoShowParents? basemapSwitcherProps? collapsibleGroups? initiallyCollapsed? map? onDisposed? onReady? showBasemapSwitcher? showTools? toolsConfig?

    Properties

    autoShowParents?: boolean

    Show the parent layers when a child layer is made visible.

    Defaults to true.

    basemapSwitcherProps?: Omit<BasemapSwitcherProps, "mapId">

    Properties for the embedded basemap switcher.

    Property mapId is not applied (the basemap switcher uses the same map as the toc).

    collapsibleGroups?: boolean

    If true, groups in the toc can be collapsed and expanded. This property should only be true if the map actually contains layer groups.

    Defaults to false.

    initiallyCollapsed?: boolean

    If true groups in the toc are collapsed initially.

    Defaults to false. If collapsibleGroups is false this property should also be false. Otherwise, only the top level layers will appear in the toc.

    map?: MapModel

    The map model to use.

    onDisposed?: (event: TocDisposedEvent) => void

    Callback that is triggered once when the Toc is disposed and unmounted.

    onReady?: (event: TocReadyEvent) => void

    Callback that is triggered once when the Toc is initialized. The Toc API can be accessed by the api property of the TocReadyEvent.

    showBasemapSwitcher?: boolean

    Defines whether the basemap switcher is shown in the toc.

    Defaults to true.

    showTools?: boolean

    Defines whether the tool component is shown in the toc.

    Defaults to false.

    toolsConfig?: ToolsConfig

    Properties for the embedded tool component.

    Settings

    Member Visibility

    On This Page

    Properties