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

    Interface IClassConfig

    interface IClassConfig {
        Description: string;
        DisplayName: string;
        DisplayNamePlural: string;
        IsAbstract: boolean;
        LegacyNames: string[];
        NLS: INLSDefaults;
        PrivateConstructor: boolean;
        Properties: { [name: string]: Partial<IPropertyAttributes> };
        PropertyCategories: string[];
        ShowInDebugOnly: boolean;
    }
    Index

    Properties

    Description DisplayName DisplayNamePlural IsAbstract LegacyNames NLS PrivateConstructor Properties PropertyCategories ShowInDebugOnly

    Properties

    Description: string

    A description of the class (to be shown in automatic documentation).

    DisplayName: string

    A display name of the class (visible in user interface).

    DisplayNamePlural: string

    A plural form of the display name of the class (visible in user interface).

    IsAbstract: boolean

    If true, the class is abstract and only inheriting classes can be instantiated in user interface.

    LegacyNames: string[]

    A set of legacy names for the class (for backward compatibility).

    NLS: INLSDefaults

    NLS text entries utilized by this component. { "SubKey1": ["Text1", "LongText1"], "SubKey2": ["Text2", "LongText2"], "SubKey3": ["Text3", "LongText3"], ... } Should contain the defaults in case no translations are available.

    PrivateConstructor: boolean

    If true, the constructor for the class is private (and the instances cannot be serialized!).

    Properties: { [name: string]: Partial<IPropertyAttributes> }

    The set of property descriptors for the component class.

    PropertyCategories: string[]
    ShowInDebugOnly: boolean

    If true, the class would not be shown in property editor dropdown.

    Settings

    Member Visibility

    On This Page

    Properties