Interface UmbNameablePropertyDatasetContext

A variant context with ability to set the name of it.

interface UmbNameablePropertyDatasetContext {
    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;
    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>>;
    setName(name: string): void;
    setPropertyValue(propertyAlias: string, value: unknown): void;
}

Hierarchy (View Summary)

Implemented by

Properties

getVariantId name properties propertyVariantId? readOnly

Accessors

controllerAlias

Methods

destroy getEntityType getName getProperties getReadOnly getUnique hostConnected hostDisconnected propertyValueByAlias setName setPropertyValue

Properties

getVariantId

getVariantId: () => UmbVariantId

Readonlyname

name: Observable<undefined | string>

Readonlyproperties

properties: Observable<undefined | UmbPropertyValueData<unknown>[]>

OptionalpropertyVariantId

propertyVariantId?: (
    propertyAlias: string,
) => Promise<Observable<undefined | UmbVariantId>>

ReadonlyreadOnly

readOnly: Observable<boolean>

Accessors

controllerAlias

Methods

destroy

getEntityType

getName

getProperties

getReadOnly

getUnique

hostConnected

hostDisconnected

propertyValueByAlias

setName

setPropertyValue

Settings

Member Visibility

On This Page

Properties
Accessors
Methods