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

    Class ComponentsAbstract

    The global component registry

    Index

    Methods

    Add AddProperty FetchPropertyNLS GetBaseClass GetConstructor GetDescription GetDisplayName GetDisplayNamePlural GetInheritors GetPropertyCategories GetPropertyInfoCollection HasProperty IsAbstract IsInheritor RemoveProperty ShouldShowInDebugOnly UpdateProperty

    Methods

    • Register the component class in the component registry.

      Type Parameters

      • T
      • TArgs extends unknown[] = unknown[]

      Parameters

      • cls: TAnyClass<T, TArgs>

        The component class

      • name: string

        The full name of the component class

      • config: Partial<IClassConfig> = null

        Component class configutaration

      Returns void

    • Adds a new property to the class

      Parameters

      • classpath: string

        The full name of the class.

      • pinfo: IPropertyConfig

        PropertyInfo object for the new property

      Returns void

    • Fetch property NLS for a component instance

      Parameters

      Returns void

    • Gets the base class name for a registered class.

      Parameters

      • classname: string

        The full name of class.

      Returns string

    • Gets the constructor for a registered class.

      Parameters

      • classname: string

        The full name of class.

      Returns TConstructor

    • Gets the description of a registered class.

      Parameters

      • classname: string

        The full name of class.

      Returns string

    • Gets a friendly name for the class

      Parameters

      • classname: string

        The full name of class.

      Returns string

    • Gets a friendly name for the class in plural form

      Parameters

      • classname: string

        The full name of class

      Returns string

    • Gets all classes registered as inheritors of a specific base class.

      Parameters

      • baseclassname: string

        The full name of the base class

      Returns string[]

    • Gets the ordered property categories of a specific class.

      Parameters

      • classname: string

        The full name of the class

      Returns string[]

    • Gets the property info collection for the component class. NOTE properties defined in instance are not present.

      Parameters

      • classname: string

        The component class name

      Returns cPropertyInfoCollection

    • Check if the property exists in class

      Parameters

      • classpath: string

        The full name of class.

      • propertyname: string

        The name of the property.

      Returns boolean

    • The component cannot be instantiated (can be used only as base class)

      Parameters

      • classname: string

        The full name of the component class

      Returns boolean

    • Checks if the class is an inheritor of a specific base class.

      Parameters

      • baseclassname: string

        The full name of the base class.

      • classname: string

        The full name of the possibly inheriting class.

      Returns boolean

    • Removes a property from the class

      Parameters

      • classpath: string

        The full name of the class

      • propertyname: string

        The name of the removed property

      Returns void

    • The component is browsable only in debug mode

      Parameters

      • classname: string

        The full name of the class

      Returns boolean

    • Updates a property of the class

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods