@umbraco-cms/backoffice

    Interface UmbPropertyDatasetContext

    A property dataset context, represents the data of a set of properties. This can take form as many, so to list a few:

    • A specific variant of content.
    • Content that does not vary.
    • A block.
    • A DataType configuration.
    • A property editor that hosts a set of properties.

    The base type of this holds a Name and some Properties. Some might be enriches with Variant Info, like culture and segment. Others might have saved publishing status. Also setting the name is an additional feature.

    interface UmbPropertyDatasetContext {
        getVariantId: () => UmbVariantId;
        name: Observable<undefined | string>;
        properties: Observable<undefined | UmbPropertyValueData<unknown>[]>;
        propertyVariantId?: (
            propertyAlias: string,
        ) => Promise<Observable<undefined | UmbVariantId>>;
        readOnly: Observable<boolean>;
        get controllerAlias(): UmbControllerAlias;
        destroy(): void;
        getEntityType(): string;
        getHostElement(): Element;
        getName(): undefined | string;
        getProperties(): Promise<undefined | UmbPropertyValueData<unknown>[]>;
        getReadOnly(): boolean;
        getUnique(): undefined | UmbEntityUnique;
        hostConnected(): void;
        hostDisconnected(): void;
        propertyValueByAlias<ReturnType = unknown>(
            propertyAlias: string,
        ): Promise<undefined | Observable<undefined | ReturnType>>;
        setPropertyValue(propertyAlias: string, value: unknown): void;
    }

    Hierarchy (View Summary, Expand)

    Implemented by

    Index

    Properties

    getVariantId name properties propertyVariantId? readOnly

    Accessors

    controllerAlias

    Methods

    destroy getEntityType getHostElement getName getProperties getReadOnly getUnique hostConnected hostDisconnected propertyValueByAlias setPropertyValue

    Properties

    getVariantId: () => UmbVariantId
    name: Observable<undefined | string>
    properties: Observable<undefined | UmbPropertyValueData<unknown>[]>
    propertyVariantId?: (
        propertyAlias: string,
    ) => Promise<Observable<undefined | UmbVariantId>>
    readOnly: Observable<boolean>

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    MMNEPVFCICPMFPCPTTAAATR