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

    Interface ISGNTargetList

    Interface for target list component.

    interface ISGNTargetList {
        advanceKey?: string;
        animateToItem?: number;
        animateToTargetSet?: any;
        boundView: undefined | IHosannaView<ViewState>;
        change?: { [key: string]: any };
        childRenderOrder?: string;
        clippingRect?: number[];
        content?: ISGNNode;
        currFocusItemIndex?: number;
        currTargetSet?: any;
        defaultTargetSetFocusIndex?: any;
        div: undefined | HTMLDivElement;
        duration?: number;
        enableRenderTracking?: boolean;
        focusable?: boolean;
        focusedChild?: void;
        focusedTargetSet?: any[];
        id: string;
        inheritParentOpacity?: boolean;
        inheritParentTransform?: boolean;
        itemComponentName?: string;
        itemFocused?: number;
        itemSelected?: number;
        itemUnfocused?: number;
        jumpToItem?: number;
        muteAudioGuide?: boolean;
        opacity: number;
        renderPass?: number;
        renderTracking?: string;
        reverseKey?: string;
        rotation: number;
        scale: [number, number];
        scaleRotateCenter: [number, number];
        showTargetRects?: boolean;
        targetSet?: any;
        translation: [number, number];
        unfocusedTargetSet?: any;
        visible: boolean;
        wrap?: 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

    advanceKey? animateToItem? animateToTargetSet? boundView change? childRenderOrder? clippingRect? content? currFocusItemIndex? currTargetSet? defaultTargetSetFocusIndex? div duration? enableRenderTracking? focusable? focusedChild? focusedTargetSet? id inheritParentOpacity? inheritParentTransform? itemComponentName? itemFocused? itemSelected? itemUnfocused? jumpToItem? muteAudioGuide? opacity renderPass? renderTracking? reverseKey? rotation scale scaleRotateCenter showTargetRects? targetSet? translation unfocusedTargetSet? visible wrap?

    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

    advanceKey?: string

    Key for advancing

    animateToItem?: number

    Target item to animate to

    animateToTargetSet?: any

    Target set to animate to

    boundView: undefined | IHosannaView<ViewState>

    The view instance bound to this renderable.

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

    Change object

    childRenderOrder?: string

    Child render order

    clippingRect?: number[]

    Clipping rectangle

    Optionalcontent

    content?: ISGNNode

    Group content

    currFocusItemIndex?: number

    Index of currently focused item

    currTargetSet?: any

    Current target set

    defaultTargetSetFocusIndex?: any

    Default focus index for target set

    div: undefined | HTMLDivElement

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

    duration?: number

    Animation duration

    enableRenderTracking?: boolean

    Enable render tracking

    focusable?: boolean

    Is focusable

    focusedChild?: void

    Focused child

    focusedTargetSet?: any[]

    Focused target sets

    id: string

    Node ID

    inheritParentOpacity?: boolean

    Inherit parent opacity

    inheritParentTransform?: boolean

    Inherit parent transform

    itemComponentName?: string

    Component name for items

    itemFocused?: number

    Index of focused item

    itemSelected?: number

    Index of selected item

    itemUnfocused?: number

    Index of unfocused item

    jumpToItem?: number

    Target item to jump to

    muteAudioGuide?: boolean

    Mute audio guide

    opacity: number

    Opacity value

    renderPass?: number

    Render pass

    renderTracking?: string

    Render tracking

    reverseKey?: string

    Key for reversing

    rotation: number

    Rotation angle

    scale: [number, number]

    Scale values

    scaleRotateCenter: [number, number]

    Scale/rotate center point

    showTargetRects?: boolean

    Whether to show target rectangles

    targetSet?: any

    Target set

    translation: [number, number]

    Translation values

    unfocusedTargetSet?: any

    Unfocused target set

    visible: boolean

    Visibility

    wrap?: boolean

    Whether focus wraps around

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate