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

    Interface ISGISGNodeField

    Interface for node field operations.

    interface ISGISGNodeField {
        addField(fieldName: string, type: string, alwayNotify: boolean): boolean;
        addFields(fields: any): boolean;
        getField<T = unknown>(fieldName: string): T;
        getFields(): JsonData;
        getFieldType(fieldName: string): string;
        getFieldTypes(): string[];
        hasField(fieldName: string): boolean;
        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;
        queueFields(queueNode: boolean): boolean;
        removeField(fieldName: string): boolean;
        removeFields(fieldNames: any): boolean;
        setField(fieldName: string, value: any): boolean;
        setFields(fields: any): boolean;
        signalBeacon(beacon: string): number;
        threadinfo(): any;
        unobserveField(fieldName: string): boolean;
        unobserveFieldScoped(fieldName: string): boolean;
    }

    Hierarchy (View Summary)

    Index

    Methods

    addField addFields getField getFields getFieldType getFieldTypes hasField observeField observeFieldScoped queueFields removeField removeFields setField setFields signalBeacon threadinfo unobserveField unobserveFieldScoped

    Methods

    • Adds field to node

      Parameters

      • fieldName: string
      • type: string
      • alwayNotify: boolean

      Returns boolean

    • Adds multiple fields

      Parameters

      • fields: any

      Returns boolean

    • Gets field value

      Type Parameters

      • T = unknown

      Parameters

      • fieldName: string

      Returns T

    • Gets all fields

      Returns JsonData

    • Gets field type

      Parameters

      • fieldName: string

      Returns string

    • Gets all field types

      Returns string[]

    • Checks if field exists

      Parameters

      • fieldName: string

      Returns boolean

    • Observes field changes

      Parameters

      • fieldName: string
      • functionName: Function
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • functionName: string
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • port: any
      • OptionalinfoFields: string[]

      Returns boolean

    • Observes field changes with scope

      Parameters

      • fieldName: string
      • functionName: string
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • functionName: Function
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • port: any
      • OptionalinfoFields: string[]

      Returns boolean

    • Queues field updates

      Parameters

      • queueNode: boolean

      Returns boolean

    • Removes field

      Parameters

      • fieldName: string

      Returns boolean

    • Removes multiple fields

      Parameters

      • fieldNames: any

      Returns boolean

    • Sets field value

      Parameters

      • fieldName: string
      • value: any

      Returns boolean

    • Sets multiple field values

      Parameters

      • fields: any

      Returns boolean

    • Signals beacon

      Parameters

      • beacon: string

      Returns number

    • Gets thread info

      Returns any

    • Stops observing field

      Parameters

      • fieldName: string

      Returns boolean

    • Stops observing scoped field

      Parameters

      • fieldName: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Methods