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

    The base class to be used by widgets.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    • Construct a new widget instance

      Parameters

      • parentelement: string | HTMLElement

        The container element for the widget

      Returns cWidgetBase

    Properties

    _version: IProperty<number> = ...
    AcceptContext: IProperty<boolean> = ...
    AllowEditorDrop: IProperty<boolean> = ...
    Background: IProperty<cBackground> = ...
    BorderColor: IProperty<string> = ...
    BorderLineWidth: IProperty<number> = ...
    BorderRadius: IProperty<number> = ...
    Container: IProperty<cWidgetContainer> = ...
    Context: IContextAPI = ...

    The context API handle functions handling the context in the current component.

    DefaultStorage: IDefaultStorage = ...

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

    DesignMode: IProperty<boolean> = ...
    DirtyMessage: IProperty<string> = ...
    DisableDashboardDOMEvents: IProperty<boolean> = ...
    DisposeEvent: IManualEvent<void>

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

    DOM: IDOMHandler = ...
    DragAllowed: IProperty<boolean> = ...
    DropAllowed: IProperty<boolean> = ...
    Events: IEvents

    cClassBase event API

    GetContextMenu: TGetMenu = ...

    The getter for Context Menu, should be overridden in any widget supporting context menus.

    Guide: IWidgetBaseGuide = ...
    IsDirty: IProperty<boolean> = ...
    ListenContext: IProperty<cWidgetBase[]> = ...
    ListenGlobalContext: IProperty<boolean> = ...
    MergeListenContext: IProperty<boolean> = ...
    Name: IProperty<string> = ...
    NoGuide: IProperty<boolean> = ...
    OverflowX: IProperty<cOverFlowType> = ...
    OverflowY: IProperty<cOverFlowType> = ...
    ParentElement: IProperty<HTMLElement> = ...
    Printable: IProperty<boolean> = ...
    RefreshEvent: IEvent<void | cRefreshType> = ...
    RelayListenContext: IProperty<boolean> = ...
    SendGlobalContext: IProperty<boolean> = ...
    ShowBorder: IProperty<boolean> = ...
    ShowConfigureOption: IProperty<boolean> = ...
    ShowContextMenu: IProperty<boolean> = ...
    ShowCurrentValueIdInTooltip: IProperty<boolean> = ...
    ShowDisplayNameInTooltip: IProperty<boolean> = ...
    ShowProcessPathInTooltip: IProperty<boolean> = ...
    ShowResolvedStatusInTooltip: IProperty<boolean> = ...
    ShowTooltip: IProperty<boolean> = ...
    TabIndex: IProperty<number> = ...
    TooltipDelay: IProperty<number> = ...
    TooltipTrendSpan: IProperty<cTimeSpan> = ...
    UId: IProperty<string>
    ValueInfoUpdated: IEvent<void> = ...
    Visible: IProperty<boolean> = ...
    WindowResizeEventDisabled: IProperty<boolean> = ...

    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

    • Returns ILegacyBase

    • 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

    • set font style comment

      Parameters

      • elem: HTMLElement
      • Optionalprefix: string

      Returns void

    • Binds a property value to an HTML element.

      Type Parameters

      • T

      Parameters

      • property: string | IProperty<T>

        The property to bind.

      • elem: HTMLElement

        The element of which will be updated

      • Optionaltag: string

        If specified - any identical string found in the text contents of the element will be replaced by the property value.

      • Optionalcomp: cComponentBase

        The component containing the property (Needed if property is given as string value).

      Returns string

    • Create an animation in the widget

      Parameters

      • animfunc: () => void

        The function performing the animation.

      Returns cAnimation

    • Return a floating window which can be filled with anything

      Parameters

      • caption: string

        Window title.

      • config: IDialogButtonConfig

        Button configuration i.e {OK: true, Cancel: true, Apply: false}

      • Optionalwidth: number

        Width of the window

      • Optionalheight: number

        Height of the window

      Returns IWindow

    • Disposes the class object.

      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

    • Parameters

      • prefix: string = ""
      • fixedsize: boolean = false
      • curlybrackets: boolean = true

      Returns string

    • Returns IContext

    • Get string (containing HTML) to be displayed in the tooltip

      Parameters

      Returns string

    • Returns string

    • Returns void

    • Gets the dispose state of the current class object.

      Returns boolean

      True, if the component is disposed.

    • Refreshes the widget.

      Parameters

      • Optionalrefreshtype: cRefreshType

        The type of refresh requested

      Returns void

    • Parameters

      • facetype: FaceType
      • size: number
      • Optionalprefix: string
      • Optionalcanvas: HTMLCanvasElement

      Returns string

    • Parameters

      • Optionalprefix: string
      • Optionalcanvascontext: CanvasRenderingContext2D

      Returns string

    • 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

    • Parameters

      • value: boolean

      Returns void

    • Parameters

      • bg: cBackground
      • nodisposeforold: boolean
      • Optionalbgelem: HTMLElement
      • Optionalimagesizeneeded: boolean
      • Optionaldefaultcolor: string

      Returns void

    • Sets the canvas size according the used canvas context and the parent element size.

      Parameters

      • canvas: HTMLCanvasElement

        The canvas to be resized.

      • Optionalcontext: CanvasRenderingContext2D

        The canvas context to be used. (If null, "2d" is used.)

      • Optionalelement: HTMLElement

        The element that presumably contains the canvas. (If null, the value of property "ParentElement" is used.)

      Returns void

    • Parameters

      Returns void

    • Parameters

      • value: boolean

      Returns void

    • Parameters

      • value: boolean

      Returns void

    • Parameters

      • value: boolean

      Returns void

    • Returns void

    • Returns string

      ToString

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

      Returns string