Interface CustomMarkContextMenuEvent

An event which is raised when an embedded custom context menu item is clicked.

interface CustomMarkContextMenuEvent {
    sheet: Sheet;
    worksheet: Worksheet;
    getContextMenuId(): string;
    getSelectedMarksAsync(): Promise<MarksCollection>;
}

Hierarchy (View Summary)

TableauWorksheetEvent
- CustomMarkContextMenuEvent

Index

Methods

getContextMenuId getSelectedMarksAsync

Properties

sheet worksheet

Methods

getContextMenuId

getContextMenuId(): string
Returns string
Id of clicked embedded menu item.
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:77

getSelectedMarksAsync

getSelectedMarksAsync(): Promise<MarksCollection>
Returns Promise<MarksCollection>
The collection of Marks that were selected.
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:81

Properties

`Readonly`sheet

sheet: Sheet

Returns

The sheet which was the source of this event.

`Readonly`worksheet

worksheet: Worksheet

Returns

The worksheet which was the source of this event.