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

    Interface StandardWidgetOptions

    StandardWidget Options

    interface StandardWidgetOptions {
        color?: WidgetColor;
        fitContent?: boolean;
        fitDirection?: Direction;
        height?: number;
        ignoreLastPosition?: boolean;
        isDraggable?: boolean;
        isMaximizable?: boolean;
        isMinimizable?: boolean;
        isResizable?: boolean;
        isScrollable?: boolean;
        locked?: boolean;
        maxHeight?: number;
        maxWidth?: number;
        minHeight?: number;
        minWidth?: number;
        size?: WidgetSize;
        useFooter?: boolean;
        variant?: WidgetVariant;
        width?: number;
        x?: number;
        y?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    color? fitContent? fitDirection? height? ignoreLastPosition? isDraggable? isMaximizable? isMinimizable? isResizable? isScrollable? locked? maxHeight? maxWidth? minHeight? minWidth? size? useFooter? variant? width? x? y?

    Properties

    color?: WidgetColor
    fitContent?: boolean

    Whether the widget to automatically resize to fit content (disables manual resize)

    fitDirection?: Direction

    Specifies the automatic resize direction

    height?: number

    height in pixels

    ignoreLastPosition?: boolean

    Whether to ignore the last position of the widget

    isDraggable?: boolean

    Whether the user can drag the widget

    isMaximizable?: boolean

    Whether the user can maximize the widget

    isMinimizable?: boolean

    Whether the user can minimize the widget

    isResizable?: boolean

    Whether the user can resize the widget

    isScrollable?: boolean

    Whether the widget content is scrollable

    locked?: boolean

    Whether to lock the widget. Locking a widget will remove it from the unique count

    maxHeight?: number

    Maximal height in pixels

    maxWidth?: number

    Maximal width in pixels

    minHeight?: number

    Minimal height in pixels

    minWidth?: number

    Minimal width in pixels

    size?: WidgetSize

    Size of the header/footer components

    useFooter?: boolean

    Whether to use a footer component

    variant?: WidgetVariant

    Whether to draw line between the content and header/footer

    width?: number

    width in pixels

    x?: number

    x position in pixels

    y?: number

    y position in pixels

    Settings

    Member Visibility

    On This Page

    Properties