Hosanna UI API v1.30.2-next
    Preparing search index...

    WebAsyncManagerTask is a specialized SGTask for managing async commands and events on the web platform.

    • Integrates with AsyncManager to handle async command execution and event dispatching.
    • Observes the 'control' field to start the async manager when the task is set to run.
    • Exposes 'command' and 'event' fields for communication with the async system.

    Hierarchy

    • WebSGTask
      • WebAsyncManagerTask

    Indexable

    • [key: string]: any
    Index

    Constructors

    Properties

    _hid: string

    Internal ID used to identify nodes in debugger views. DO NOT USE THIS ID FOR ANYTHING ELSE.

    _oid: undefined = undefined

    Internal object ID (not used on some platforms).

    asyncManager?: AsyncManager.AsyncManager

    The AsyncManager instance responsible for managing async commands and events.

    boundView: any

    The bound view associated with the node (if any).

    change: undefined = undefined

    Change handler for the node (not implemented).

    children: ISGNNode[] = []

    The child nodes of this node.

    command?: IAsyncCommand<unknown>

    The async command to be processed by the manager.

    control?: TaskControl

    Task control state

    div: undefined | HTMLDivElement

    The HTML div element associated with the node (if applicable).

    event?: IAsyncEvent<any>

    The async event to be sent or received by the manager.

    focusable: boolean = true

    Indicates whether the node is focusable.

    focusedChild: undefined = undefined

    The currently focused child node (if any).

    functionName?: string

    Function name to execute

    hasStarted: boolean = false
    observers: Record<string, FieldObserver[]> = {}

    A record of field observers, keyed by field names.

    state?: string

    Current state

    taskAA?: Record<string, unknown>

    Accessors

    • get _subType(): string

      Returns the subtype identifier for this task.

      Returns string

    • get id(): string

      Gets the ID of the node.

      Returns string

    • set id(value: string): void

      Sets the ID of the node.

      Parameters

      • value: string

        The new ID value.

      Returns void

    Methods

    • Adds field to node

      Parameters

      • fieldName: string
      • type: string
      • alwaysNotify: boolean

      Returns boolean

    • Adds multiple fields

      Parameters

      • fields: any

      Returns boolean

    • Adds or replaces a field with the specified key and value.

      Parameters

      • key: string

        The field key.

      • value: any

        The field value.

      Returns void

    • Retrieves the bounding rectangle relative to an ancestor node.

      Parameters

      Returns I2DRectangle

      The bounding rectangle.

    • Gets sub-item bounding rect relative to ancestor

      Parameters

      Returns I2DRectangle

    • Appends fields from another instance.

      Parameters

      • aa: any

        The instance containing fields to append.

      Returns void

    • Appends a child node to this node.

      Parameters

      • child: ISGNNode

        The child node to append.

      Returns boolean

      true if the child was appended successfully, otherwise false.

    • Appends multiple child nodes

      Parameters

      • child_nodes: any

      Returns boolean

    • Parameters

      • node: WebSGNode
      • outlineStyle: string

      Returns void

    • Gets bounding rect

      Returns I2DRectangle

    • Parameters

      • funcName: string
      • ...args: unknown[]

      Returns unknown

    • Functions

      Parameters

      • funcName: string
      • ...args: unknown[]

      Returns unknown

    • Returns true if a reference can be retrieved for the field.

      Parameters

      • field_name: string

      Returns boolean

    • Clears all fields from the node.

      Returns void

    • Clones node

      Parameters

      • isDeepCopy: boolean

      Returns void

    • Counts the number of fields in the node.

      Returns number

      The number of fields.

    • Creates child node

      Type Parameters

      Parameters

      • nodeType: string

      Returns T

    • Creates multiple child nodes

      Type Parameters

      Parameters

      • num_children: number
      • subtype: string

      Returns T[]

    • Deletes a field by its key.

      Parameters

      • key: string

        The field key to delete.

      Returns boolean

      true if the field was deleted, otherwise false.

    • Checks if a field exists by its key.

      Parameters

      • key: string

        The field key to check.

      Returns boolean

      true if the field exists, otherwise false.

    • Finds node by name

      Parameters

      • name: string

      Returns undefined | ISGNNode

    • Gets all child nodes

      Returns void

    • Gets all child node metadata

      Returns void

    • Gets child node at index

      Parameters

      • index: number

      Returns ISGNNode

    • Retrieves the number of child nodes.

      Returns number

      The number of child nodes.

    • Gets multiple child nodes

      Parameters

      • num_children: number
      • index: number

      Returns ISGNNode[]

    • Gets field value

      Parameters

      • fieldName: string

      Returns any

    • Gets all fields

      Returns string[]

    • Gets field type

      Parameters

      • fieldName: string

      Returns string

    • Gets all field types

      Returns any[]

    • Gets HTTP agent

      Returns void

    • Gets parent node

      Returns undefined | ISGNNode

    • Gets the referenced object for the field (no copy).

      Parameters

      • field_name: string

      Returns undefined | object

    • Gets root nodes

      Returns void

    • Gets root node metadata

      Returns void

    • Gets scene node

      Returns ISGNNode

    • Checks if field exists

      Parameters

      • fieldName: string

      Returns boolean

    • Checks if node has focus

      Returns boolean

    • Inserts child node at index

      Parameters

      Returns boolean

    • Inserts multiple child nodes at index

      Parameters

      • child_nodes: any
      • index: number

      Returns boolean

    • Checks if node is in focus chain

      Returns boolean

    • Checks if nodes are same

      Parameters

      • node: any

      Returns boolean

    • Checks if node is subtype

      Parameters

      • nodeType: string

      Returns boolean

    • Retrieves all field entries as key-value pairs.

      Returns [string, any][]

      An array of key-value pairs.

    • Retrieves all field keys.

      Returns string[]

      An array of field keys.

    • Gets local bounding rect

      Returns I2DRectangle

    • Gets local sub-item bounding rect

      Parameters

      • itemnumber: string

      Returns I2DRectangle

    • Looks up a field by its key.

      Parameters

      • key: string

        The field key to look up.

      Returns any

      The field value, or undefined if the field does not exist.

    • Looks up a field by its key, ignoring case.

      Parameters

      • key: string

        The field key to look up.

      Returns any

      The field value, or undefined if the field does not exist.

    • Returns void

    • Moves (extracts) data from a field and clears the field.

      Parameters

      • field_name: string

      Returns undefined | object

    • Moves (transfers ownership of) data into a field; returns number of bytes moved (approximate for web).

      Parameters

      • field_name: string
      • data: object

      Returns number

    • Adds an observer to a specific field.

      Parameters

      • fieldName: string

        The name of the field to observe.

      • portOrString: string | Function | ISGROMessagePort

        The message port or function to associate with the observer.

      • OptionalinfoFields: string[]

        Optional fields to observe for additional information.

      Returns boolean

      true if the observer was added successfully, otherwise false.

    • Parameters

      • fieldName: string
      • portOrString: string | Function | ISGROMessagePort
      • OptionalinfoFields: string[]

      Returns boolean

    • Gets parent subtype

      Parameters

      • nodeType: string

      Returns string

    • Queues field updates

      Parameters

      • queueNode: boolean

      Returns boolean

    • Removes child node

      Parameters

      Returns boolean

    • Removes child node at index

      Parameters

      • index: number

      Returns boolean

    • Removes multiple child nodes

      Parameters

      Returns boolean

    • Removes multiple child nodes at index

      Parameters

      • num_children: number
      • index: number

      Returns boolean

    • Removes field

      Parameters

      • fieldName: string

      Returns boolean

    • Removes multiple fields

      Parameters

      • fieldNames: any

      Returns boolean

    • Returns void

    • Changes node parent

      Parameters

      • newParent: ISGNNode
      • adjustTransform: boolean

      Returns boolean

    • Replaces child node at index

      Parameters

      Returns boolean

    • Replaces multiple child nodes at index

      Parameters

      • child_nodes: any
      • index: number

      Returns boolean

    • Type Parameters

      • T

      Parameters

      • callback: () => T

      Returns T

    • Gets scene bounding rect

      Returns I2DRectangle

    • Gets scene sub-item bounding rect

      Parameters

      • itemnumber: string

      Returns I2DRectangle

    • Sets field value

      Parameters

      • fieldName: string
      • value: any

      Returns boolean

    • Sets multiple field values

      Parameters

      • fields: any

      Returns boolean

    • Sets node focus

      Parameters

      • on: boolean

      Returns boolean

    • Sets HTTP agent

      Parameters

      • HTTP_agent: any

      Returns boolean

    • Sets the mode to case-sensitive for field keys.

      Returns void

      Error indicating that the method is not implemented.

    • Parameters

      Returns void

    • Stores a reference to an object in a field without copying.

      Parameters

      • field_name: string
      • data: object

      Returns void

    • Parameters

      • show: boolean

      Returns void

    • Signals beacon

      Parameters

      • beacon: string

      Returns number

    • Gets sub-item bounding rect

      Parameters

      • itemnumber: string

      Returns I2DRectangle

    • Gets node subtype

      Returns string

    • Gets thread info

      Returns void

    • Returns void

    • Stops observing field

      Parameters

      • fieldName: string

      Returns boolean

    • Stops observing scoped field

      Parameters

      • fieldName: string

      Returns boolean

    • Updates node fields

      Parameters

      • fields: any
      • addFields: boolean = false

      Returns void