@hmiproject/helio-sdk
    Preparing search index...

    Type Alias UseDynamicPropertyResult

    type UseDynamicPropertyResult = {
        canRead: boolean | undefined;
        canWrite: boolean | undefined;
        displayValue: string | undefined;
        meta?: Record<string, unknown>;
        value: unknown;
        valueType: ValueType;
        render?(): ReactNode;
        setValue?(nextValue: unknown): void;
    }
    Index

    Properties

    canRead: boolean | undefined

    Can the dynamic property value be read?

    If this is undefined, the current status of the read permission cannot be determined, e.g. when a connection has not been established yet.

    canWrite: boolean | undefined

    Can the dynamic property value be written?

    If this is undefined, the current status of the write permission cannot be determined, e.g. when a connection has not been established yet.

    displayValue: string | undefined

    Optional human-readable dynamic property value.

    This can include formatting and adjustments based on the current locale or transformations to make the value human-readable.

    "42.00"
    
    meta?: Record<string, unknown>

    Optional set of value metadata.

    Can be used to include information about units, precision, etc.

    value: unknown

    Current raw dynamic property value.

    42
    
    valueType: ValueType

    The current type of value that is being returned.

    This type can change at runtime based on the value the dynamic property is producing.

    Methods

    • Optionally, render additional components.

      Can be used to call .render() on other dynamic properties.

      Returns ReactNode