@mendix/extensions-api - v0.9.0
    Preparing search index...

    Interface WidgetValue

    An element is part of a Mendix model and all elements together form the logic of the model. Elements may contain other elements. An element always has a container element, which is its parent. The root of an element tree is always a unit.

    interface WidgetValue {
        $CreationOptions?: unknown;
        $ID: string;
        $Type: "CustomWidgets$WidgetValue";
        $UnitID?: string;
        action: ClientAction;
        attributeRef: null | AttributeRef;
        dataSource: null | DataSource;
        entityRef: null | EntityRef;
        expression: null | string;
        icon: null | Icon;
        image: null | string;
        microflow: null | string;
        nanoflow: null | string;
        objects: WidgetObject[];
        page: null | string;
        primitiveValue: string;
        selection: CustomWidgetSelectionType;
        sourceVariable: null | PageVariable;
        textTemplate: null | ClientTemplate;
        translatableValue: null | Text;
        type: string;
        widgets: Pages.Widget[];
        xPathConstraint: null | string;
        addCustomWidget(
            options: CustomWidgetCreationOptions,
        ): Promise<CustomWidget>;
        addWidgetObject(): Promise<WidgetObject>;
        delete(): void;
        getContainer(): WidgetProperty;
        getCustomWidget(name: string): undefined | CustomWidget;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type $UnitID? action attributeRef dataSource entityRef expression icon image microflow nanoflow objects page primitiveValue selection sourceVariable textTemplate translatableValue type widgets xPathConstraint

    Methods

    addCustomWidget addWidgetObject delete getContainer getCustomWidget

    Properties

    $CreationOptions?: unknown

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "CustomWidgets$WidgetValue"

    The type of the element.

    $UnitID?: string
    action: ClientAction
    attributeRef: null | AttributeRef
    dataSource: null | DataSource
    entityRef: null | EntityRef
    expression: null | string
    icon: null | Icon
    image: null | string
    microflow: null | string
    nanoflow: null | string
    objects: WidgetObject[]

    page

    page: null | string
    primitiveValue: string
    selection: CustomWidgetSelectionType
    sourceVariable: null | PageVariable
    textTemplate: null | ClientTemplate
    translatableValue: null | Text
    type: string
    widgets: Pages.Widget[]
    xPathConstraint: null | string

    Methods

    • Returns void

    Settings

    On This Page

    Properties
    Methods