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

    Interface RowButtonTableAction

    An action that is displayed as a button in the row of all table item.

    interface RowButtonTableAction {
        icon: string;
        id: string;
        label: string;
        priority?: number;
        provideDisplayState(
            dataTable: DataTable,
            rowItem: TableItem,
        ): Partial<TableActionDisplayState>;
        tooltip: string;
        trigger(actionContext: RowActionContext): Promise<void>;
        uiType: "button";
    }

    Hierarchy (View Summary)

    Index

    Properties

    icon id label priority? tooltip uiType

    Methods

    provideDisplayState? trigger

    Properties

    icon: string

    Icon of the button that will be rendered in the table row *

    id: string

    ID used to identify this action.

    label: string

    Label that might be rendered on a button beside or instead of the icon. *

    priority?: number

    optional flag of actions used as source of ordering. *

    tooltip: string

    Tooltip that is displayed, when hovering the button. *

    uiType: "button"

    Type of action that describes how it is rendered, e.g. as a button *

    Methods

    • Actions can optionally provide a display state that controls if this action is visible or enabled for a specific row.

      Parameters

      • dataTable: DataTable

        the table that requests the display state.

      • rowItem: TableItem

        the row item for which the state is requested.

      Returns Partial<TableActionDisplayState>

    • Runs the action code.

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods