@trumpf/ux.utils
    Preparing search index...

    Interface WidgetConfiguration

    interface WidgetConfiguration {
        description?: string;
        getFilterSettingProvider?: (
            options: WidgetFilterSettingProviderConfig,
        ) => WidgetFilterSettingProviderType;
        getMenuProvider?: (
            options: WidgetMenuProviderConfig,
        ) => WidgetMenuProviderType;
        gridMaxW?: number;
        gridMinW?: number;
        gridW?: number;
        minWidth?: number;
        props?: Record<string, any>;
        thumbnail?: string;
        title?: string;
        [key: string]: any;
    }

    Hierarchy

    • Record<string, any>
      • WidgetConfiguration

    Indexable

    • [key: string]: any
    Index

    Properties

    description? getFilterSettingProvider? getMenuProvider? gridMaxW? gridMinW? gridW? minWidth? props? thumbnail? title?

    Properties

    description?: string

    Optional description to be displayed in the widget drawer

    getFilterSettingProvider?: (
        options: WidgetFilterSettingProviderConfig,
    ) => WidgetFilterSettingProviderType

    Optional filter setting provider

    getMenuProvider?: (options: WidgetMenuProviderConfig) => WidgetMenuProviderType

    Optional menu provider

    gridMaxW?: number

    Optional maximum column span in the dashboard grid (1-12)

    gridMinW?: number

    Optional minimum column span in the dashboard grid (1-12)

    gridW?: number

    Optional default column span in the dashboard grid (1-12)

    minWidth?: number

    Optional minimum width in pixels

    use gridMinW instead

    props?: Record<string, any>

    Optional attributes/props that are passed to the widget

    thumbnail?: string

    Optional thumbnail image to be displayed in the widget drawer

    title?: string

    Optional title for the widget header

    Settings

    Member Visibility

    On This Page

    Properties