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

    Class SettingsWidget

    Base class for widgets of type StandardWidget displayed in the viewport

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Content: () => Element = SettingsWidgetContent

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

    ContextProvider: (props: WidgetContextProviderProps) => Element = ...

    React context provider around content Called internally by the widget renderer method.

    Type declaration

    ExtraContent: FunctionComponent = ...

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

    Header: () => Element = SettingsWidgetHeader

    React Component displaying the header of the widget. Called internally by the widget renderer method.

    id: string = ...
    ignoreLastPosition: boolean = false
    isStandardWidget: true
    signals: {
        onUpdateRect: ViewerSignal<(...args: any[]) => any>;
        onUpdateRectContent: ViewerSignal<(...args: any[]) => any>;
    } = ...
    type: keyof ViewerWidgetRegistry = 'Settings'
    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

    • get zIndex(): WidgetZIndex

      Returns WidgetZIndex

    • set zIndex(value: WidgetZIndex): void

      Parameters

      Returns void

    Methods

    • Returns void

    • Returns void

    • Returns the list of settings tabs to display inside the settings widget. By default, returns all tabs defined in the ViewportContentRegistry.

      Note: it is safe to call react hooks inside this function

      Returns SettingsWidgetTab[]

    • 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

    • Put back the widget to its original height before minimization

      Returns void

    • Parameters

      • saveConfig: boolean = true

      Returns void