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

    Interface ISGNButtonGroup

    Interface for button group component.

    interface ISGNButtonGroup {
        addItemSpacingAfterChild?: boolean;
        boundView: undefined | IHosannaView<ViewState>;
        buttonFocused?: number;
        buttonHeight?: number;
        buttons?: string[];
        buttonSelected?: number;
        change?: { [key: string]: any };
        childRenderOrder?: string;
        clippingRect?: number[];
        div: undefined | HTMLDivElement;
        enableRenderTracking?: boolean;
        focusable?: boolean;
        focusBitmapUri?: string;
        focusButton?: number;
        focusedChild?: void;
        focusedIconUri?: string;
        focusedTextColor?: sgApi.IColor;
        focusedTextFont?: ISGROFont;
        focusFootprintBitmapUri?: string;
        horizAlignment?: SGHorizontalAlignment;
        iconUri?: string;
        id: string;
        inheritParentOpacity?: boolean;
        inheritParentTransform?: boolean;
        itemSpacings?: number[];
        layoutDirection?: string;
        maxWidth?: number;
        minWidth?: number;
        muteAudioGuide?: boolean;
        opacity: number;
        renderPass?: number;
        renderTracking?: string;
        rightJustify?: boolean;
        rotation: number;
        scale: [number, number];
        scaleRotateCenter: [number, number];
        textColor?: sgApi.IColor;
        textFont?: ISGROFont;
        translation: [number, number];
        vertAlignment?: SGVerticalAlignment;
        visible: boolean;
        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

    addItemSpacingAfterChild? boundView buttonFocused? buttonHeight? buttons? buttonSelected? change? childRenderOrder? clippingRect? div enableRenderTracking? focusable? focusBitmapUri? focusButton? focusedChild? focusedIconUri? focusedTextColor? focusedTextFont? focusFootprintBitmapUri? horizAlignment? iconUri? id inheritParentOpacity? inheritParentTransform? itemSpacings? layoutDirection? maxWidth? minWidth? muteAudioGuide? opacity renderPass? renderTracking? rightJustify? rotation scale scaleRotateCenter textColor? textFont? translation vertAlignment? visible

    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

    addItemSpacingAfterChild?: boolean

    Add spacing after child

    boundView: undefined | IHosannaView<ViewState>

    The view instance bound to this renderable.

    buttonFocused?: number

    Currently focused button

    buttonHeight?: number

    Button height

    buttons?: string[]

    Array of button texts

    buttonSelected?: number

    Currently selected button

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

    Change object

    childRenderOrder?: string

    Child render order

    clippingRect?: number[]

    Clipping rectangle

    div: undefined | HTMLDivElement

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

    enableRenderTracking?: boolean

    Enable render tracking

    focusable?: boolean

    Is focusable

    focusBitmapUri?: string

    Focus bitmap URI

    focusButton?: number

    Button to focus

    focusedChild?: void

    Focused child

    focusedIconUri?: string

    Focused icon URI

    focusedTextColor?: sgApi.IColor

    Focused text color

    focusedTextFont?: ISGROFont

    Focused text font

    focusFootprintBitmapUri?: string

    Focus footprint bitmap URI

    horizAlignment?: SGHorizontalAlignment

    Horizontal alignment

    iconUri?: string

    Icon URI

    id: string

    Node ID

    inheritParentOpacity?: boolean

    Inherit parent opacity

    inheritParentTransform?: boolean

    Inherit parent transform

    itemSpacings?: number[]

    Item spacing values

    layoutDirection?: string

    Layout direction

    maxWidth?: number

    Maximum width

    minWidth?: number

    Minimum width

    muteAudioGuide?: boolean

    Mute audio guide

    opacity: number

    Opacity value

    renderPass?: number

    Render pass

    renderTracking?: string

    Render tracking

    rightJustify?: boolean

    Right justify buttons

    rotation: number

    Rotation angle

    scale: [number, number]

    Scale values

    scaleRotateCenter: [number, number]

    Scale/rotate center point

    textColor?: sgApi.IColor

    Text color

    textFont?: ISGROFont

    Text font

    translation: [number, number]

    Translation values

    vertAlignment?: SGVerticalAlignment

    Vertical alignment

    visible: boolean

    Visibility

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate