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

    Interface ISGISGNodeChildren

    Interface for node child operations.

    interface ISGISGNodeChildren {
        appendChild(child: ISGNNode): boolean;
        appendChildren(child_nodes: any): boolean;
        createChild<T extends ISGNNode = ISGNNode>(nodeType: string): T;
        createChildren<T extends ISGNNode = ISGNNode>(
            num_children: number,
            subtype: string,
        ): T[];
        getAll(): any;
        getAllMeta(): any;
        getChild(index: number): any;
        getChildCount(): number;
        getChildren(num_children: number, index: number): any;
        getParent(): undefined | ISGNNode;
        getRoots(): any;
        getRootsMeta(): any;
        getScene(): ISGNNode;
        insertChild(child: ISGNNode, index: number): boolean;
        insertChildren(child_nodes: any, index: number): boolean;
        removeChild(child: ISGNNode): boolean;
        removeChildIndex(index: number): boolean;
        removeChildren(child_nodes: ISGNNode[]): boolean;
        removeChildrenIndex(num_children: number, index: number): boolean;
        reparent(newParent: ISGNNode, adjustTransform: boolean): boolean;
        replaceChild(newChild: ISGNNode, index: number): boolean;
        replaceChildren(child_nodes: any, index: number): boolean;
        update(fields: any, addFields?: boolean): any;
    }

    Hierarchy (View Summary)

    Index

    Methods

    appendChild appendChildren createChild createChildren getAll getAllMeta getChild getChildCount getChildren getParent getRoots getRootsMeta getScene insertChild insertChildren removeChild removeChildIndex removeChildren removeChildrenIndex reparent replaceChild replaceChildren update

    Methods

    • Appends child node

      Parameters

      Returns boolean

    • Appends multiple child nodes

      Parameters

      • child_nodes: any

      Returns boolean

    • Creates multiple child nodes

      Type Parameters

      Parameters

      • num_children: number
      • subtype: string

      Returns T[]

    • Gets all child nodes

      Returns any

    • Gets all child node metadata

      Returns any

    • Gets child node at index

      Parameters

      • index: number

      Returns any

    • Gets number of child nodes

      Returns number

    • Gets multiple child nodes

      Parameters

      • num_children: number
      • index: number

      Returns any

    • Gets root nodes

      Returns any

    • Gets root node metadata

      Returns any

    • Inserts child node at index

      Parameters

      Returns boolean

    • Inserts multiple child nodes at index

      Parameters

      • child_nodes: any
      • index: number

      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

    • 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

    • Updates node fields

      Parameters

      • fields: any
      • OptionaladdFields: boolean

      Returns any

    Settings

    Member Visibility

    On This Page

    Methods