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

    Property attributes including those of Data Class Properties

    interface IPropertyAttributes {
        Category: string;
        ColorSections: string[];
        ComponentType: string;
        Connected: boolean;
        Converter: <CT>(value: unknown) => CT;
        CustomAttributes: TCustomAttributes;
        CustomEditor: string;
        DashboardReference: string;
        DateTimeLocal: boolean;
        DBType: string;
        DefaultValue: unknown;
        Description: string;
        DisplayName: string;
        DisposeOrder: number;
        EditMasking: string;
        EnumType: INLSEnum;
        ForceSerializeOnPrint: boolean;
        GetterName: string;
        HasStandardValues: boolean;
        Index: number;
        InitOrder: number;
        IsBrowsable: boolean;
        IsBrowsableAsReference: boolean;
        IsDbProperty: boolean;
        IsDisposable: boolean;
        IsHistorized: boolean;
        IsInterned: boolean;
        IsNullable: boolean;
        IsNumeric: boolean;
        IsReadOnly: boolean;
        IsSerializable: boolean;
        IsTrueReadOnly: boolean;
        IsTypeSwitcher: boolean;
        IsUnique: boolean;
        IsVirtual: boolean;
        IsVisible: boolean;
        IsVisibleToUserByDefault: boolean;
        ItemCustomEditor: string;
        ItemQuickEditOnly: boolean;
        ItemQuickEditProperties: string[];
        ItemReorderEnabled: boolean;
        ItemSort: (a: [string, unknown], b: [string, unknown]) => number;
        ItemType: cPropertyType;
        ItemValueReadOnly: boolean;
        MaskRequired: boolean;
        MaxValue: unknown;
        MinValue: unknown;
        Name: string;
        NLSKey: string;
        NumberStep: number;
        Placeholder: string;
        PreviewUpdate: boolean;
        RawItemType: cPropertyType;
        RawType: cPropertyType;
        ReferenceTarget: string;
        ScriptLanguage: string;
        SerializeClass: string;
        SetterName: string;
        ShouldSerialize: TShouldSerialize;
        Size: number;
        StandardValuesExclusive: boolean;
        Type: cPropertyType;
        TypeSwitchValueProperty: string;
        Unit: string;
        UseNLS: boolean;
        UserStatusId: number;
        VisibilityRequirement: string | TIsVisible;
    }
    Index

    Properties

    Category: string

    A custom category for the property.

    ColorSections: string[]

    Default Color Theme Sections for a Color property.

    ComponentType: string

    Type information for components (as the component class name)

    Connected: boolean

    Connected to data production. (Historized properties only)

    Converter: <CT>(value: unknown) => CT

    A custom converter for converting the property value to another type.

    CustomAttributes: TCustomAttributes

    Additional attributes for custom usage.

    CustomEditor: string

    The full class name of a custom editor for the property.

    DashboardReference: string

    A property reference path to be used inside dashboard. [Dashboard internal]

    DateTimeLocal: boolean

    The ABB.Mia.cDateTime object stored in this property should be stored as a local time stamp.

    DBType: string

    For data class properties original .NET data type name. (e.g. System.Boolean)

    DefaultValue: unknown

    Default value when a new object is created.

    Description: string

    Description of the property.

    DisplayName: string

    Name used in the user intarface.

    DisposeOrder: number

    A number specifying the dispose order of properties. Properties with small order number are disposed before ones with greater number. If undefined or null:properties are disposed in alphabetical order.

    EditMasking: string

    Edit Masking for the property.

    EnumType: INLSEnum

    An object containing the enumeration members and corresponding values (needed when the property type is ABB.Mia.cPropertyType.Enum).

    ForceSerializeOnPrint: boolean
    GetterName: string
    HasStandardValues: boolean
    Index: number

    A running number which defines the order of the properties within the class.

    InitOrder: number

    A number specifying the initialization order of a property. Properties with small order number are initialized before ones with greater number. If undefined or null:properties are initialized in alphabetical order.

    IsBrowsable: boolean

    If true the property is visible to user (for example in an editor).

    IsBrowsableAsReference: boolean

    If true the property is visible to user when selecting a property reference.

    IsDbProperty: boolean
    IsDisposable: boolean

    If true the property can be disposed. NOTE:If null or undefined; Component properties will be disposed by default.

    IsHistorized: boolean
    IsInterned: boolean
    IsNullable: boolean

    If false the property cannot be set to null from the editor.

    IsNumeric: boolean

    The value of the property should be treated as a number (e.g. applying number formatting and right alignment depending on culture settings).

    IsReadOnly: boolean

    Indicates whether this property is read only in a property editor.

    IsSerializable: boolean

    If true the property value can be serialized.

    IsTrueReadOnly: boolean

    Indicates whether this property is truly read only (cannot be changed using the setter functions).

    IsTypeSwitcher: boolean
    IsUnique: boolean
    IsVirtual: boolean
    IsVisible: boolean

    When VisibilityRequirement =! null, this nullable boolean provides info for cached instances if the property is currently visible

    IsVisibleToUserByDefault: boolean
    ItemCustomEditor: string

    The mdw file path of a custom editor for the array/dictionary items.

    ItemQuickEditOnly: boolean

    Show only quick editing - do not show the property dialog. (Only for component properties!)

    ItemQuickEditProperties: string[]

    Properties to show in item list for quick editing. (Only for component properties!)

    ItemReorderEnabled: boolean

    Allows item reorder for array collections (if!=null overrides IsReadOnly).

    ItemSort: (a: [string, unknown], b: [string, unknown]) => number

    Sort function for dictionary collections (null implies default alphabetic).

    ItemType: cPropertyType

    Type information for array/dictionary item (as ABB.Mia.cPropertyType)

    ItemValueReadOnly: boolean

    Allows/Disables editing item values of collections (if!=null overrides IsReadOnly).

    MaskRequired: boolean
    MaxValue: unknown

    Largest value you can enter to property

    MinValue: unknown

    Smallest value you can enter to property

    Name: string

    Internal name, which is used to refer property within code, etc.

    NLSKey: string

    If UseNLS is true; this provides the default value for the _NLS property.

    NumberStep: number

    The step setting for the numerical input field.

    Placeholder: string

    Override the placeholder text shown for null value. Only applicable in certain type of properties.

    PreviewUpdate: boolean

    If set true, allows updating the property value while user is still editing (e.g. with collection editor). It is true by default.

    RawItemType: cPropertyType

    Raw Type information for array.

    RawType: cPropertyType

    The raw property type.

    ReferenceTarget: string

    Database Reference Target

    ScriptLanguage: string

    The script language name (for Script properties).

    SerializeClass: string

    For properties of type ABB.Mia.cPropertyType.Serializable; the full name of the constructor object as string i.e. "ABB.Mia.cRectangle"

    SetterName: string
    ShouldSerialize: TShouldSerialize

    A function (returning a boolean) that tells the serializer if the current property value should be serialized.

    Size: number

    Maximum size of array, string or other container types.

    StandardValuesExclusive: boolean

    The property type.

    TypeSwitchValueProperty: string
    Unit: string
    UseNLS: boolean

    Inform the component base to provide language support feature for this property. An additional _NLS text property is added to provide the language key for this property. The syntax for _NLS property is Section|Key|Subkey|$&. Subkey is optional. If it's left out; empty string "" is used as the subkey. Third | (after Subkey) signifies using LongText instead of Text in the language entry as the property value. (Using Text is the default). $ signifies removing a category from the Text field. $ can be defined at the end (before &). & signifies removing ampersand characters from the Text field. & can be defined at the end.

    UserStatusId: number

    ID of enum providing meaning to user status

    VisibilityRequirement: string | TIsVisible

    Visibility Requirement for the property.