Interface ISGROSGNode

Interface representing an SG node that extends multiple node-related interfaces.

interface ISGROSGNode {
    boundView?: unknown;
    div?: HTMLDivElement;
    id: string;
    addField(fieldName: string, type: string, alwayNotify: boolean): boolean;
    addFields(fields: any): boolean;
    AddReplace(key: string, value: any): any;
    ancestorBoundingRect(
        ancestor: undefined | null | ISGROSGNode,
    ): I2DRectangle;
    ancestorSubBoundingRect(
        itemnumber: string,
        ancestor: ISGROSGNode,
    ): I2DRectangle;
    Append(aa: any): any;
    appendChild(child: ISGNNode): boolean;
    appendChildren(child_nodes: any): boolean;
    boundingRect(): I2DRectangle;
    Clear(): any;
    clone(isDeepCopy: boolean): any;
    Count(): number;
    createChild<T extends ISGNNode = ISGNNode>(nodeType: string): T;
    createChildren<T extends ISGNNode = ISGNNode>(
        num_children: number,
        subtype: string,
    ): T[];
    Delete(key: string): boolean;
    DoesExist(key: string): boolean;
    findNode(name: string): any;
    getAll(): any;
    getAllMeta(): any;
    getChild(index: number): any;
    getChildCount(): number;
    getChildren(num_children: number, index: number): any;
    getField<T = unknown>(fieldName: string): T;
    getFields(): JsonData;
    getFieldType(fieldName: string): string;
    getFieldTypes(): string[];
    getHttpAgent(): any;
    getParent(): undefined | ISGNNode;
    getRoots(): any;
    getRootsMeta(): any;
    getScene(): ISGNNode;
    hasField(fieldName: string): boolean;
    hasFocus(): boolean;
    insertChild(child: ISGNNode, index: number): boolean;
    insertChildren(child_nodes: any, index: number): boolean;
    isInFocusChain(): boolean;
    isSameNode(node: any): boolean;
    isSubtype(nodeType: string): boolean;
    Items(): any;
    Keys(): string[];
    localBoundingRect(): I2DRectangle;
    localSubBoundingRect(itemnumber: string): I2DRectangle;
    Lookup(key: string): any;
    LookupCI(key: string): any;
    mount(): void;
    observeField(
        fieldName: string,
        functionName: Function,
        infoFields?: string[],
    ): boolean;
    observeField(
        fieldName: string,
        functionName: string,
        infoFields?: string[],
    ): boolean;
    observeField(fieldName: string, port: any, infoFields?: string[]): boolean;
    observeFieldScoped(
        fieldName: string,
        functionName: string,
        infoFields?: string[],
    ): boolean;
    observeFieldScoped(
        fieldName: string,
        functionName: Function,
        infoFields?: string[],
    ): boolean;
    observeFieldScoped(
        fieldName: string,
        port: any,
        infoFields?: string[],
    ): boolean;
    parentSubtype(nodeType: string): string;
    queueFields(queueNode: boolean): boolean;
    removeChild(child: ISGNNode): boolean;
    removeChildIndex(index: number): boolean;
    removeChildren(child_nodes: ISGNNode[]): boolean;
    removeChildrenIndex(num_children: number, index: number): boolean;
    removeField(fieldName: string): boolean;
    removeFields(fieldNames: any): boolean;
    render(): void;
    reparent(newParent: ISGNNode, adjustTransform: boolean): boolean;
    replaceChild(newChild: ISGNNode, index: number): boolean;
    replaceChildren(child_nodes: any, index: number): boolean;
    sceneBoundingRect(): I2DRectangle;
    sceneSubBoundingRect(itemnumber: string): I2DRectangle;
    setField(fieldName: string, value: any): boolean;
    setFields(fields: any): boolean;
    setFocus(on: boolean): boolean;
    setHttpAgent(HTTP_agent: any): boolean;
    SetModeCaseSensitive(): any;
    showDebugBounds(show: boolean): void;
    signalBeacon(beacon: string): number;
    subBoundingRect(itemnumber: string): I2DRectangle;
    subtype(): string;
    threadinfo(): any;
    unmount(): void;
    unobserveField(fieldName: string): boolean;
    unobserveFieldScoped(fieldName: string): boolean;
    update(fields: any, addFields?: boolean): any;
}

Hierarchy (View Summary)

Index

Properties

boundView? div? id

Methods

addField addFields AddReplace ancestorBoundingRect ancestorSubBoundingRect Append appendChild appendChildren boundingRect Clear clone Count createChild createChildren Delete DoesExist findNode getAll getAllMeta getChild getChildCount getChildren getField getFields getFieldType getFieldTypes getHttpAgent getParent getRoots getRootsMeta getScene hasField hasFocus insertChild insertChildren isInFocusChain isSameNode isSubtype Items Keys localBoundingRect localSubBoundingRect Lookup LookupCI mount observeField observeFieldScoped parentSubtype queueFields removeChild removeChildIndex removeChildren removeChildrenIndex removeField removeFields render reparent replaceChild replaceChildren sceneBoundingRect sceneSubBoundingRect setField setFields setFocus setHttpAgent SetModeCaseSensitive showDebugBounds signalBeacon subBoundingRect subtype threadinfo unmount unobserveField unobserveFieldScoped update

Properties

`Optional`boundView

boundView?: unknown

`Optional`div

div?: HTMLDivElement

id

id: string

The unique identifier for the node.

Methods

addField

addField(fieldName: string, type: string, alwayNotify: boolean): boolean
Adds field to node
Parameters
- fieldName: string
- type: string
- alwayNotify: boolean
Returns boolean
Inherited from ISGISGNodeField.addField

addFields

addFields(fields: any): boolean
Adds multiple fields
Parameters
- fields: any
Returns boolean
Inherited from ISGISGNodeField.addFields

AddReplace

AddReplace(key: string, value: any): any
Adds or replaces a key-value pair
Parameters
- key: string
- value: any
Returns any
Inherited from ISGIAssociativeArray.AddReplace

ancestorBoundingRect

ancestorBoundingRect(ancestor: undefined | null | ISGROSGNode): I2DRectangle
Gets bounding rect relative to ancestor
Parameters
- ancestor: undefined | null | ISGROSGNode
Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.ancestorBoundingRect

ancestorSubBoundingRect

ancestorSubBoundingRect(itemnumber: string, ancestor: ISGROSGNode): I2DRectangle
Gets sub-item bounding rect relative to ancestor
Parameters
- itemnumber: string
- ancestor: ISGROSGNode
Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.ancestorSubBoundingRect

Append

Append(aa: any): any
Appends another associative array
Parameters
- aa: any
Returns any
Inherited from ISGIAssociativeArray.Append

appendChild

appendChild(child: ISGNNode): boolean
Appends child node
Parameters
- child: ISGNNode
Returns boolean
Inherited from ISGISGNodeChildren.appendChild

appendChildren

appendChildren(child_nodes: any): boolean
Appends multiple child nodes
Parameters
- child_nodes: any
Returns boolean
Inherited from ISGISGNodeChildren.appendChildren

boundingRect

boundingRect(): I2DRectangle
Gets bounding rect

Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.boundingRect

Clear

Clear(): any
Clears the associative array

Returns any
Inherited from ISGIAssociativeArray.Clear

clone

clone(isDeepCopy: boolean): any
Clones node
Parameters
- isDeepCopy: boolean
Returns any
Inherited from ISGISGNodeDict.clone

Count

Count(): number
Gets the count of items

Returns number
Inherited from ISGIAssociativeArray.Count

createChild

createChild<T extends ISGNNode = ISGNNode>(nodeType: string): T
Creates child node
Type Parameters
- T extends ISGNNode = ISGNNode
Parameters
- nodeType: string
Returns T
Inherited from ISGISGNodeChildren.createChild

createChildren

createChildren<T extends ISGNNode = ISGNNode>(
num_children: number,
subtype: string,
): T[]
Creates multiple child nodes
Type Parameters
- T extends ISGNNode = ISGNNode
Parameters
- num_children: number
- subtype: string
Returns T[]
Inherited from ISGISGNodeChildren.createChildren

Delete

Delete(key: string): boolean
Deletes an item by key
Parameters
- key: string
Returns boolean
Inherited from ISGIAssociativeArray.Delete

DoesExist

DoesExist(key: string): boolean
Checks if a key exists
Parameters
- key: string
Returns boolean
Inherited from ISGIAssociativeArray.DoesExist

findNode

findNode(name: string): any
Finds node by name
Parameters
- name: string
Returns any
Inherited from ISGISGNodeDict.findNode

getAll

getAll(): any
Gets all child nodes

Returns any
Inherited from ISGISGNodeChildren.getAll

getAllMeta

getAllMeta(): any
Gets all child node metadata

Returns any
Inherited from ISGISGNodeChildren.getAllMeta

getChild

getChild(index: number): any
Gets child node at index
Parameters
- index: number
Returns any
Inherited from ISGISGNodeChildren.getChild

getChildCount

getChildCount(): number
Gets number of child nodes

Returns number
Inherited from ISGISGNodeChildren.getChildCount

getChildren

getChildren(num_children: number, index: number): any
Gets multiple child nodes
Parameters
- num_children: number
- index: number
Returns any
Inherited from ISGISGNodeChildren.getChildren

getField

getField<T = unknown>(fieldName: string): T
Gets field value
Type Parameters
- T = unknown
Parameters
- fieldName: string
Returns T
Inherited from ISGISGNodeField.getField

getFields

getFields(): JsonData
Gets all fields

Returns JsonData
Inherited from ISGISGNodeField.getFields

getFieldType

getFieldType(fieldName: string): string
Gets field type
Parameters
- fieldName: string
Returns string
Inherited from ISGISGNodeField.getFieldType

getFieldTypes

getFieldTypes(): string[]
Gets all field types

Returns string[]
Inherited from ISGISGNodeField.getFieldTypes

getHttpAgent

getHttpAgent(): any
Gets HTTP agent

Returns any
Inherited from ISGISGNodeHttpAgentAccess.getHttpAgent

getParent

getParent(): undefined | ISGNNode
Gets parent node

Returns undefined | ISGNNode
Inherited from ISGISGNodeChildren.getParent

getRoots

getRoots(): any
Gets root nodes

Returns any
Inherited from ISGISGNodeChildren.getRoots

getRootsMeta

getRootsMeta(): any
Gets root node metadata

Returns any
Inherited from ISGISGNodeChildren.getRootsMeta

getScene

getScene(): ISGNNode
Gets scene node

Returns ISGNNode
Inherited from ISGISGNodeChildren.getScene

hasField

hasField(fieldName: string): boolean
Checks if field exists
Parameters
- fieldName: string
Returns boolean
Inherited from ISGISGNodeField.hasField

hasFocus

hasFocus(): boolean
Checks if node has focus

Returns boolean
Inherited from ISGISGNodeFocus.hasFocus

insertChild

insertChild(child: ISGNNode, index: number): boolean
Inserts child node at index
Parameters
- child: ISGNNode
- index: number
Returns boolean
Inherited from ISGISGNodeChildren.insertChild

insertChildren

insertChildren(child_nodes: any, index: number): boolean
Inserts multiple child nodes at index
Parameters
- child_nodes: any
- index: number
Returns boolean
Inherited from ISGISGNodeChildren.insertChildren

isInFocusChain

isInFocusChain(): boolean
Checks if node is in focus chain

Returns boolean
Inherited from ISGISGNodeFocus.isInFocusChain

isSameNode

isSameNode(node: any): boolean
Checks if nodes are same
Parameters
- node: any
Returns boolean
Inherited from ISGISGNodeDict.isSameNode

isSubtype

isSubtype(nodeType: string): boolean
Checks if node is subtype
Parameters
- nodeType: string
Returns boolean
Inherited from ISGISGNodeDict.isSubtype

Items

Items(): any
Gets all items

Returns any
Inherited from ISGIAssociativeArray.Items

Keys

Keys(): string[]
Gets all keys

Returns string[]
Inherited from ISGIAssociativeArray.Keys

localBoundingRect

localBoundingRect(): I2DRectangle
Gets local bounding rect

Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.localBoundingRect

localSubBoundingRect

localSubBoundingRect(itemnumber: string): I2DRectangle
Gets local sub-item bounding rect
Parameters
- itemnumber: string
Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.localSubBoundingRect

Lookup

Lookup(key: string): any
Looks up a value by key
Parameters
- key: string
Returns any
Inherited from ISGIAssociativeArray.Lookup

LookupCI

LookupCI(key: string): any
Looks up a value by key (case insensitive)
Parameters
- key: string
Returns any
Inherited from ISGIAssociativeArray.LookupCI

mount

mount(): void
Returns void
Inherited from IRenderable.mount

observeField

observeField(
    fieldName: string,
    functionName: Function,
    infoFields?: string[],
): boolean
Observes field changes
Parameters
- fieldName: string
- functionName: Function
- OptionalinfoFields: string[]
Returns boolean
Inherited from ISGISGNodeField.observeField
observeField(
    fieldName: string,
    functionName: string,
    infoFields?: string[],
): boolean
Parameters
- fieldName: string
- functionName: string
- OptionalinfoFields: string[]
Returns boolean
Inherited from ISGISGNodeField.observeField
observeField(fieldName: string, port: any, infoFields?: string[]): boolean
Parameters
- fieldName: string
- port: any
- OptionalinfoFields: string[]
Returns boolean
Inherited from ISGISGNodeField.observeField

observeFieldScoped

observeFieldScoped(
    fieldName: string,
    functionName: string,
    infoFields?: string[],
): boolean
Observes field changes with scope
Parameters
- fieldName: string
- functionName: string
- OptionalinfoFields: string[]
Returns boolean
Inherited from ISGISGNodeField.observeFieldScoped
observeFieldScoped(
    fieldName: string,
    functionName: Function,
    infoFields?: string[],
): boolean
Parameters
- fieldName: string
- functionName: Function
- OptionalinfoFields: string[]
Returns boolean
Inherited from ISGISGNodeField.observeFieldScoped
observeFieldScoped(fieldName: string, port: any, infoFields?: string[]): boolean
Parameters
- fieldName: string
- port: any
- OptionalinfoFields: string[]
Returns boolean
Inherited from ISGISGNodeField.observeFieldScoped

parentSubtype

parentSubtype(nodeType: string): string
Gets parent subtype
Parameters
- nodeType: string
Returns string
Inherited from ISGISGNodeDict.parentSubtype

queueFields

queueFields(queueNode: boolean): boolean
Queues field updates
Parameters
- queueNode: boolean
Returns boolean
Inherited from ISGISGNodeField.queueFields

removeChild

removeChild(child: ISGNNode): boolean
Removes child node
Parameters
- child: ISGNNode
Returns boolean
Inherited from ISGISGNodeChildren.removeChild

removeChildIndex

removeChildIndex(index: number): boolean
Removes child node at index
Parameters
- index: number
Returns boolean
Inherited from ISGISGNodeChildren.removeChildIndex

removeChildren

removeChildren(child_nodes: ISGNNode[]): boolean
Removes multiple child nodes
Parameters
- child_nodes: ISGNNode[]
Returns boolean
Inherited from ISGISGNodeChildren.removeChildren

removeChildrenIndex

removeChildrenIndex(num_children: number, index: number): boolean
Removes multiple child nodes at index
Parameters
- num_children: number
- index: number
Returns boolean
Inherited from ISGISGNodeChildren.removeChildrenIndex

removeField

removeField(fieldName: string): boolean
Removes field
Parameters
- fieldName: string
Returns boolean
Inherited from ISGISGNodeField.removeField

removeFields

removeFields(fieldNames: any): boolean
Removes multiple fields
Parameters
- fieldNames: any
Returns boolean
Inherited from ISGISGNodeField.removeFields

render

render(): void
Returns void
Inherited from IRenderable.render

reparent

reparent(newParent: ISGNNode, adjustTransform: boolean): boolean
Changes node parent
Parameters
- newParent: ISGNNode
- adjustTransform: boolean
Returns boolean
Inherited from ISGISGNodeChildren.reparent

replaceChild

replaceChild(newChild: ISGNNode, index: number): boolean
Replaces child node at index
Parameters
- newChild: ISGNNode
- index: number
Returns boolean
Inherited from ISGISGNodeChildren.replaceChild

replaceChildren

replaceChildren(child_nodes: any, index: number): boolean
Replaces multiple child nodes at index
Parameters
- child_nodes: any
- index: number
Returns boolean
Inherited from ISGISGNodeChildren.replaceChildren

sceneBoundingRect

sceneBoundingRect(): I2DRectangle
Gets scene bounding rect

Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.sceneBoundingRect

sceneSubBoundingRect

sceneSubBoundingRect(itemnumber: string): I2DRectangle
Gets scene sub-item bounding rect
Parameters
- itemnumber: string
Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.sceneSubBoundingRect

setField

setField(fieldName: string, value: any): boolean
Sets field value
Parameters
- fieldName: string
- value: any
Returns boolean
Inherited from ISGISGNodeField.setField

setFields

setFields(fields: any): boolean
Sets multiple field values
Parameters
- fields: any
Returns boolean
Inherited from ISGISGNodeField.setFields

setFocus

setFocus(on: boolean): boolean
Sets node focus
Parameters
- on: boolean
Returns boolean
Inherited from ISGISGNodeFocus.setFocus

setHttpAgent

setHttpAgent(HTTP_agent: any): boolean
Sets HTTP agent
Parameters
- HTTP_agent: any
Returns boolean
Inherited from ISGISGNodeHttpAgentAccess.setHttpAgent

SetModeCaseSensitive

SetModeCaseSensitive(): any
Sets case sensitive mode

Returns any
Inherited from ISGIAssociativeArray.SetModeCaseSensitive

showDebugBounds

showDebugBounds(show: boolean): void
Parameters
- show: boolean
Returns void
Inherited from IRenderable.showDebugBounds

signalBeacon

signalBeacon(beacon: string): number
Signals beacon
Parameters
- beacon: string
Returns number
Inherited from ISGISGNodeField.signalBeacon

subBoundingRect

subBoundingRect(itemnumber: string): I2DRectangle
Gets sub-item bounding rect
Parameters
- itemnumber: string
Returns I2DRectangle
Inherited from ISGISGNodeBoundingRect.subBoundingRect

subtype

subtype(): string
Gets node subtype

Returns string
Inherited from ISGISGNodeDict.subtype

threadinfo

threadinfo(): any
Gets thread info

Returns any
Inherited from ISGISGNodeField.threadinfo

unmount

unmount(): void
Returns void
Inherited from IRenderable.unmount

unobserveField

unobserveField(fieldName: string): boolean
Stops observing field
Parameters
- fieldName: string
Returns boolean
Inherited from ISGISGNodeField.unobserveField

unobserveFieldScoped

unobserveFieldScoped(fieldName: string): boolean
Stops observing scoped field
Parameters
- fieldName: string
Returns boolean
Inherited from ISGISGNodeField.unobserveFieldScoped

update

update(fields: any, addFields?: boolean): any
Updates node fields
Parameters
- fields: any
- OptionaladdFields: boolean
Returns any
Inherited from ISGISGNodeChildren.update

Interface ISGROSGNode

Hierarchy (View Summary)

Index

Properties

Methods

Properties

OptionalboundView

Optionaldiv

id

Methods

addField

Parameters

Returns boolean

addFields

Parameters

Returns boolean

AddReplace

Parameters

Returns any

ancestorBoundingRect

Parameters

Returns I2DRectangle

ancestorSubBoundingRect

Parameters

Returns I2DRectangle

Append

Parameters

Returns any

appendChild

Parameters

Returns boolean

appendChildren

Parameters

Returns boolean

boundingRect

Returns I2DRectangle

Clear

Returns any

clone

Parameters

Returns any

Count

Returns number

createChild

Type Parameters

Parameters

Returns T

createChildren

Type Parameters

Parameters

Returns T[]

Delete

Parameters

Returns boolean

DoesExist

Parameters

Returns boolean

findNode

Parameters

Returns any

getAll

Returns any

getAllMeta

Returns any

getChild

Parameters

Returns any

getChildCount

Returns number

getChildren

Parameters

Returns any

getField

Type Parameters

Parameters

Returns T

getFields

Returns JsonData

getFieldType

Parameters

`Optional`boundView

`Optional`div