hosanna-ui-docs - v0.9.0
    Preparing search index...

    Interface ISGNProgressDialog

    Interface for progress dialog component.

    interface ISGNProgressDialog {
        backgroundUri?: string;
        boundView: undefined | IHosannaView<ViewState>;
        bulletText?: string[];
        bulletTextColor?: sgApi.IColor;
        bulletTextFont?: ISGROFont;
        busySpinner?: ISGNNode;
        buttonFocused?: number;
        buttonGroup?: ISGNNode;
        buttons?: string[];
        buttonSelected?: number;
        change?: { [key: string]: any };
        childRenderOrder?: string;
        clippingRect?: number[];
        close?: boolean;
        div: undefined | HTMLDivElement;
        dividerUri?: string;
        enableRenderTracking?: boolean;
        focusable?: boolean;
        focusButton?: number;
        focusedChild?: void;
        graphicHeight?: number;
        graphicUri?: string;
        graphicWidth?: number;
        iconUri?: string;
        id: string;
        inheritParentOpacity?: boolean;
        inheritParentTransform?: boolean;
        maxHeight?: number;
        message?: string;
        messageColor?: sgApi.IColor;
        messageFont?: ISGROFont;
        muteAudioGuide?: boolean;
        numberedBullets?: boolean;
        opacity: number;
        optionsDialog?: boolean;
        renderPass?: number;
        renderTracking?: string;
        rotation: number;
        scale: [number, number];
        scaleRotateCenter: [number, number];
        title?: string;
        titleColor?: sgApi.IColor;
        titleFont?: ISGROFont;
        translation: [number, number];
        visible: boolean;
        wasClosed?: IEvent;
        width?: number;
        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(nodeType: string): any;
        createChildren(num_children: number, subtype: string): any;
        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(fieldName: string): any;
        getFields(): any;
        getFieldType(fieldName: string): string;
        getFieldTypes(): any;
        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(): any;
        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

    backgroundUri? boundView bulletText? bulletTextColor? bulletTextFont? busySpinner? buttonFocused? buttonGroup? buttons? buttonSelected? change? childRenderOrder? clippingRect? close? div dividerUri? enableRenderTracking? focusable? focusButton? focusedChild? graphicHeight? graphicUri? graphicWidth? iconUri? id inheritParentOpacity? inheritParentTransform? maxHeight? message? messageColor? messageFont? muteAudioGuide? numberedBullets? opacity optionsDialog? renderPass? renderTracking? rotation scale scaleRotateCenter title? titleColor? titleFont? translation visible wasClosed? width?

    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

    backgroundUri?: string

    Background URI

    boundView: undefined | IHosannaView<ViewState>

    The view instance bound to this renderable.

    bulletText?: string[]

    Bullet point texts

    bulletTextColor?: sgApi.IColor

    Bullet text color

    bulletTextFont?: ISGROFont

    Bullet text font

    busySpinner?: ISGNNode

    Spinner node shown during busy state

    buttonFocused?: number

    Focused button

    buttonGroup?: ISGNNode

    Button group

    buttons?: string[]

    Button texts

    buttonSelected?: number

    Selected button

    change?: { [key: string]: any }

    Change object

    childRenderOrder?: string

    Child render order

    clippingRect?: number[]

    Clipping rectangle

    close?: boolean

    Close dialog

    div: undefined | HTMLDivElement

    The root HTML div element for this renderable, if any.

    dividerUri?: string

    Divider URI

    enableRenderTracking?: boolean

    Enable render tracking

    focusable?: boolean

    Is focusable

    focusButton?: number

    Button to focus

    focusedChild?: void

    Focused child

    graphicHeight?: number

    Graphic height

    graphicUri?: string

    Graphic URI

    graphicWidth?: number

    Graphic width

    iconUri?: string

    Icon URI

    id: string

    Node ID

    inheritParentOpacity?: boolean

    Inherit parent opacity

    inheritParentTransform?: boolean

    Inherit parent transform

    maxHeight?: number

    Maximum height

    message?: string

    Message text

    messageColor?: sgApi.IColor

    Message color

    messageFont?: ISGROFont

    Message font

    muteAudioGuide?: boolean

    Mute audio guide

    numberedBullets?: boolean

    Use numbered bullets

    opacity: number

    Opacity value

    optionsDialog?: boolean

    Is options dialog

    renderPass?: number

    Render pass

    renderTracking?: string

    Render tracking

    rotation: number

    Rotation angle

    scale: [number, number]

    Scale values

    scaleRotateCenter: [number, number]

    Scale/rotate center point

    title?: string

    Dialog title

    titleColor?: sgApi.IColor

    Title color

    titleFont?: ISGROFont

    Title font

    translation: [number, number]

    Translation values

    visible: boolean

    Visibility

    wasClosed?: IEvent

    Dialog closed event

    width?: number

    Dialog width

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate