map.apps Bundle APIs 4.20.0
    Preparing search index...

    Interface BaseActionDefinition

    Properties shared by all action definitions.

    interface BaseActionDefinition {
        id: string;
        isVisibleForItem(item: TocItem): boolean | Promise<boolean>;
        label?: string;
        type: ActionType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id label? type

    Methods

    isVisibleForItem?

    Properties

    id: string

    This action's unique id.

    label?: string

    A textual label (or title) for this action.

    type: ActionType

    The type of this action.

    Methods

    • Returns true if the action shall be available for the given item. Should return false otherwise.

      Note that this method may be asynchronous (i.e. return a Promise<boolean>).

      Parameters

      Returns boolean | Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods