Altair EEvision 2025.1 APIs
    Preparing search index...

    Interface CreateButtonOptions

    Options for creating a button in the toolbar or the 'More' menu.

    interface CreateButtonOptions {
        className: string | string[];
        disabled: boolean;
        icon: string;
        id: string;
        location: HTMLElement | ButtonLocation;
        text: string;
        title: string;
        onclick(event: MouseEvent): unknown;
    }
    Index

    Properties

    className disabled icon id location text title

    Methods

    onclick

    Properties

    className: string | string[]

    CSS class(es) for the button.

    disabled: boolean

    If true, the button is in disabled state.

    icon: string

    Icon that should appear in the button.

    id: string

    The DOM ID for the button.

    location: HTMLElement | ButtonLocation

    The location where the button should appear: left, middle, or right toolbar or 'More' menu.

    text

    text: string

    Text label for the button.

    title: string

    Tooltip for the button.

    Methods

    • Function to be called when the user clicks on the button.

      Parameters

      • event: MouseEvent

      Returns unknown

    Settings

    Member Visibility

    On This Page

    Properties
    Methods