@stereograph/teiaviewer - v18.6.0-dev
    Preparing search index...

    Class WidgetAbstract

    Base class for all widgets displayed in the viewport

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    ExtraContent id ignoreLastPosition Render signals type DragHandleClassName

    Accessors

    fitContent fitDirection isDraggable isLocked isMaximizable isMinimizable isResizable isScrollable maxHeight maxWidth minHeight minWidth zIndex

    Methods

    close dispose maximize minimize setMaxSize setMinSize setPosition setRect setSize unmaximize unminimize updateRect

    Constructors

    Properties

    ExtraContent: FunctionComponent = ...

    React Component displaying the extra content of the widget. Called internally by the widget container method.

    id: string = ...
    ignoreLastPosition: boolean = false
    Render: FunctionComponent<WidgetRenderProps>

    Renders the widget with a react component

    signals: {
        onUpdateRect: ViewerSignal<(...args: any[]) => any>;
        onUpdateRectContent: ViewerSignal<(...args: any[]) => any>;
    } = ...
    type: keyof ViewerWidgetRegistry
    DragHandleClassName: string = ...

    Accessors

    • get fitContent(): boolean

      Returns boolean

    • get fitDirection(): Direction

      Returns Direction

    • get isDraggable(): boolean

      Returns boolean

    • set isDraggable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isLocked(): boolean

      Returns boolean

    • set isLocked(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isMaximizable(): boolean

      Returns boolean

    • set isMaximizable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isMinimizable(): boolean

      Returns boolean

    • set isMinimizable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isResizable(): boolean

      Returns boolean

    • set isResizable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isScrollable(): boolean

      Returns boolean

    • get maxHeight(): number

      Returns number

    • get maxWidth(): number

      Returns number

    • get minHeight(): number

      Returns number

    • get minWidth(): number

      Returns number

    Methods

    • Returns void

    • Returns void

    • Parameters

      • width: number
      • height: number

      Returns void

    • Minimizes the widget with to the given height

      Parameters

      • height: number = 0

        The minimized height

      Returns void

    • Parameters

      • maxWidth: number
      • maxHeight: number

      Returns void

    • Parameters

      • minWidth: number
      • minHeight: number

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • saveConfig: boolean = true

      Returns void

    • Sets the widget size

      Parameters

      • width: number
      • height: number

      Returns void

    • Returns void

    • Put back the widget to its original height before minimization

      Returns void

    • Parameters

      • saveConfig: boolean = true

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods