Interface RailHandle

interface RailHandle {
    el: HTMLElement;
    closeFlyout(): void;
    collapsed(): boolean;
    cycleMagnet(): MagnetMode;
    destroy(): void;
    drawLocked(): boolean;
    favorites(): string[];
    flyoutOpen(): boolean;
    isFavorite(id: string): boolean;
    magnetMode(): MagnetMode;
    openGroup(groupId: string, viaKeyboard?: boolean): void;
    prefs(): RailPrefs;
    refresh(): void;
    restorePrefs(prefs: unknown): void;
    setCollapsed(on: boolean): void;
    setDrawLock(on: boolean): void;
    setMagnetMode(mode: MagnetMode): void;
    setStayMode(on: boolean): void;
    stayMode(): boolean;
    sync(tool: null | string): void;
    toggleFavorite(id: string, on?: boolean): void;
}

Properties

el

Methods

closeFlyout collapsed? cycleMagnet destroy drawLocked favorites flyoutOpen isFavorite magnetMode openGroup prefs refresh restorePrefs setCollapsed? setDrawLock setMagnetMode setStayMode stayMode sync toggleFavorite

Properties

Readonlyel

el: HTMLElement

Methods

closeFlyout

Optionalcollapsed

  • collapsed(): boolean

  • Whether the rail is folded away behind its tab. Optional because a host may hand mountMobile a handle of its own, written before the fold.

    Returns boolean

cycleMagnet

destroy

drawLocked

favorites

flyoutOpen

isFavorite

magnetMode

openGroup

  • openGroup(groupId: string, viaKeyboard?: boolean): void

  • Open a group's flyout beside its button.

    Parameters

    • groupId: string
    • OptionalviaKeyboard: boolean

    Returns void

prefs

refresh

  • refresh(): void

  • Re-read the controller for the controls block (selection, history).

    Returns void

restorePrefs

OptionalsetCollapsed

  • setCollapsed(on: boolean): void

  • Fold the rail away, leaving its tab, or bring it back. Optional, as collapsed.

    Parameters

    • on: boolean

    Returns void

setDrawLock

  • setDrawLock(on: boolean): void

  • The double-click hold: one tool kept armed until something leaves it.

    Parameters

    • on: boolean

    Returns void

setMagnetMode

setStayMode

stayMode

sync

  • sync(tool: null | string): void

  • Reflect the armed tool on the buttons. The controller's draw:tool event drives it; a host may call it too.

    Parameters

    • tool: null | string

    Returns void

toggleFavorite

  • toggleFavorite(id: string, on?: boolean): void

  • Parameters

    • id: string
    • Optionalon: boolean

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods