ABB Ability™ History UI SDK - Client API Reference
    Preparing search index...

    Interface IContextItem

    Specifies a single context item in the context object

    interface IContextItem {
        Class?: string;
        Connection?: string | IMiaClient;
        DataItem?: IDataItemConfiguration;
        Id?: unknown;
        ItemType: ContextItemType;
        Key?: string;
        Name?: string;
        Property?: string;
        Type?: cPropertyType;
        Unique?: IUniqueDbProperty;
        Value?: unknown;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Class? Connection? DataItem? Id? ItemType Key? Name? Property? Type? Unique? Value?

    Properties

    Class?: string

    [ItemType.DbClassInstance] Data Class Name

    Connection?: string | IMiaClient

    [ItemType.DbClassInstance] Connection object

    DataItem?: IDataItemConfiguration

    [ItemType.DbClassInstance, ItemType.DataItem] Additional data item configuration.

    Id?: unknown

    [ItemType.DbClassInstance] Data Class Instance Id

    ItemType: ContextItemType

    Context item type

    Key?: string

    A context key, if defined can be used in mapping the context to receiving components.

    IContextAPI.ContextKey

    Name?: string

    [ItemType.DbClassInstance] Data Class Instance Name

    Property?: string

    [ItemType.DbClassInstance] Data Class Property

    Type?: cPropertyType

    [ItemType.Value] Value type

    Unique?: IUniqueDbProperty

    [ItemType.DbClassInstance] Data Class Unique Property values to use if Id does not exist.

    Value?: unknown

    [ItemType.Value] Value

    Settings

    Member Visibility

    On This Page

    Properties