Type Alias SetToolOptions

Options for GradumEventManager.setTool, controlling the side effects of making a tool current beyond the assignment itself.

type SetToolOptions = {
    select?: boolean;
    activate?: boolean;
    setAsNoAction?: boolean;
}

Properties

select?: boolean

Whether to visually select the tool on every toolbar showing it.

activate?: boolean

Whether to fire the tool's activation callback.

setAsNoAction?: boolean

Whether the tool also becomes the one used for ClickMode.none. Defaults to true when the click mode is ClickMode.left.