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

    The base class for all View components

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    DefaultStorage: IDefaultStorage = ...

    Default property value storage - used by the default property getters and setters.

    DisposeEvent: IManualEvent<void>

    Dispose Event signaled when the object is being disposed. NOTE: Inheriting classes should use AddDisposeHandler instead.

    Events: IEvents

    cClassBase event API

    UId: IProperty<string>

    Accessors

    • get CanDispose(): boolean

      The object can be disposed

      Returns boolean

    • set CanDispose(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get NLS(): IComponentNLSRequest

      The component class specific NLS request

      Returns IComponentNLSRequest

    • get Properties(): IPropertyAPI

      The component property API

      Returns IPropertyAPI

    Methods

    • Create function that can abort asynchronous code in case the function is called again or the owner instance have been disposed. This is useful with problematic cases where for example server request is sent and the return is handled asynchronously (with a callback). Meanwhile the configuration may have changed making the code in the callback unnecessary or even harmful. *

      Type Parameters

      • TArgs extends unknown[] = []

      Parameters

      • func: TAsyncAbortable<TArgs>

        A function with first parameter as function to check the abort state: Can be used in the function: if(abort()) return; //abort

      • disposeonly: boolean = false

        Check only the dispose state - don't check subsequent calls to the function.

      Returns TAsyncAbortableReturn<TArgs>

    • Add a dispose handler called when this object is being disposed. The dispose handlers are called in reverse order (the latest first).

      Parameters

      • disposer: () => void

        The dispose handler - should make any manual clean up necessary when the object is being disposed.

      Returns void

    • Get the value of a named property.

      Type Parameters

      • T

      Parameters

      • propertyname: string

        The name of the property

      Returns T

    • Get the registered component class name

      Returns string

      Components.Add

    • Gets the dispose state of the current class object.

      Returns boolean

      True, if the component is disposed.

    • Set a value for the named property.

      Type Parameters

      • T

      Parameters

      • propertyname: string

        The name of the property

      • value: T

        The new value for the property

      Returns void

    • Returns string

      ToString

    • String representation of the component instance. Can be overridden by inheriting classes.

      Returns string

    • Enable events for detecting when an event listener is added or removed

      Parameters

      Returns void