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

    Interface ISGNPosterGrid

    Interface for poster grid component that extends array grid functionality.

    interface ISGNPosterGrid {
        animateToItem?: number;
        basePosterSize?: any;
        boundView: undefined | IHosannaView<ViewState>;
        caption1Color?: sgApi.IColor;
        caption1Font?: ISGROFont;
        caption1NumLines?: number;
        caption2Color?: sgApi.IColor;
        caption2Font?: ISGROFont;
        caption2NumLines?: number;
        captionBackgroundBitmapUri?: string;
        captionHorizAlignment?: SGHorizontalAlignment;
        captionLineSpacing?: number;
        captionVertAlignment?: string;
        change?: { [key: string]: any };
        childRenderOrder?: string;
        clippingRect?: number[];
        columnSpacings?: number[];
        columnWidths?: number[];
        content?: ISGNNode;
        currFocusColumn?: number;
        currFocusFeedbackOpacity?: number;
        currFocusRow?: number;
        currFocusSection?: number;
        div: undefined | HTMLDivElement;
        drawFocusFeedback?: boolean;
        drawFocusFeedbackOnTop?: boolean;
        enableCaptionScrolling?: boolean;
        enableRenderTracking?: boolean;
        fadeFocusFeedbackWhenAutoScrolling?: boolean;
        failedBitmapOpacity?: number;
        failedBitmapUri?: string;
        fixedLayout?: boolean;
        focusable?: boolean;
        focusBitmapBlendColor?: sgApi.IColor;
        focusBitmapUri?: string;
        focusColumn?: number;
        focusedChild?: void;
        focusFootprintBitmapUri?: string;
        focusFootprintBlendColor?: sgApi.IColor;
        focusRow?: number;
        horizFocusAnimationStyle?: string;
        id: string;
        imageWellBitmapUri?: string;
        inheritParentOpacity?: boolean;
        inheritParentTransform?: boolean;
        itemClippingRect?: any;
        itemcurrFocusFeedbackOpacity?: number;
        itemFocused?: number;
        itemSelected?: number;
        itemSize?: any;
        itemSpacing?: any;
        itemUnfocused?: number;
        jumpToItem?: number;
        loadingBitmapOpacity?: number;
        loadingBitmapUri?: string;
        muteAudioGuide?: boolean;
        numColumns?: number;
        numRenderPasses?: number;
        numRows?: number;
        opacity: number;
        posterDisplayMode?: string;
        renderPass?: number;
        renderTracking?: string;
        rotation: number;
        rowHeights?: number[];
        rowSpacings?: number[];
        scale: [number, number];
        scaleRotateCenter: [number, number];
        sectionDividerBitmapUri?: string;
        sectionDividerFont?: ISGROFont;
        sectionDividerHeight?: number;
        sectionDividerLeftOffset?: number;
        sectionDividerMinWidth?: number;
        sectionDividerSpacing?: number;
        sectionDividerTextColor?: sgApi.IColor;
        sectionDividerWidth?: number;
        showBackgroundForEmptyCaptions?: boolean;
        skipFocusAnimations?: boolean;
        translation: [number, number];
        useAtlas?: boolean;
        vertFocusAnimationStyle?: string;
        visible: boolean;
        wrapDividerBitmapUri?: string;
        wrapDividerHeight?: number;
        wrapDividerWidth?: 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

    animateToItem? basePosterSize? boundView caption1Color? caption1Font? caption1NumLines? caption2Color? caption2Font? caption2NumLines? captionBackgroundBitmapUri? captionHorizAlignment? captionLineSpacing? captionVertAlignment? change? childRenderOrder? clippingRect? columnSpacings? columnWidths? content? currFocusColumn? currFocusFeedbackOpacity? currFocusRow? currFocusSection? div drawFocusFeedback? drawFocusFeedbackOnTop? enableCaptionScrolling? enableRenderTracking? fadeFocusFeedbackWhenAutoScrolling? failedBitmapOpacity? failedBitmapUri? fixedLayout? focusable? focusBitmapBlendColor? focusBitmapUri? focusColumn? focusedChild? focusFootprintBitmapUri? focusFootprintBlendColor? focusRow? horizFocusAnimationStyle? id imageWellBitmapUri? inheritParentOpacity? inheritParentTransform? itemClippingRect? itemcurrFocusFeedbackOpacity? itemFocused? itemSelected? itemSize? itemSpacing? itemUnfocused? jumpToItem? loadingBitmapOpacity? loadingBitmapUri? muteAudioGuide? numColumns? numRenderPasses? numRows? opacity posterDisplayMode? renderPass? renderTracking? rotation rowHeights? rowSpacings? scale scaleRotateCenter sectionDividerBitmapUri? sectionDividerFont? sectionDividerHeight? sectionDividerLeftOffset? sectionDividerMinWidth? sectionDividerSpacing? sectionDividerTextColor? sectionDividerWidth? showBackgroundForEmptyCaptions? skipFocusAnimations? translation useAtlas? vertFocusAnimationStyle? visible wrapDividerBitmapUri? wrapDividerHeight? wrapDividerWidth?

    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

    animateToItem?: number

    Target item to animate to

    basePosterSize?: any

    Base size for posters in the grid

    boundView: undefined | IHosannaView<ViewState>

    The view instance bound to this renderable.

    caption1Color?: sgApi.IColor

    Color for primary caption text

    caption1Font?: ISGROFont

    Font settings for primary caption

    caption1NumLines?: number

    Maximum number of lines for primary caption

    caption2Color?: sgApi.IColor

    Color for secondary caption text

    caption2Font?: ISGROFont

    Font settings for secondary caption

    caption2NumLines?: number

    Maximum number of lines for secondary caption

    captionBackgroundBitmapUri?: string

    URI for caption background bitmap image

    captionHorizAlignment?: SGHorizontalAlignment

    Horizontal alignment of captions

    captionLineSpacing?: number

    Spacing between caption lines

    captionVertAlignment?: string

    Vertical alignment of captions

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

    Change object

    childRenderOrder?: string

    Child render order

    clippingRect?: number[]

    Clipping rectangle

    columnSpacings?: number[]

    Array of column spacing values

    columnWidths?: number[]

    Array of column width values

    Optionalcontent

    content?: ISGNNode

    Grid content node

    currFocusColumn?: number

    Currently focused column

    currFocusFeedbackOpacity?: number

    Current focus feedback opacity

    currFocusRow?: number

    Currently focused row

    currFocusSection?: number

    Currently focused section

    div: undefined | HTMLDivElement

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

    drawFocusFeedback?: boolean

    Whether to draw focus feedback

    drawFocusFeedbackOnTop?: boolean

    Whether to draw focus feedback on top

    enableCaptionScrolling?: boolean

    Whether caption scrolling is enabled

    enableRenderTracking?: boolean

    Enable render tracking

    fadeFocusFeedbackWhenAutoScrolling?: boolean

    Fade focus feedback during auto-scroll

    failedBitmapOpacity?: number

    Opacity of bitmap shown when poster fails to load

    failedBitmapUri?: string

    URI for bitmap shown when poster fails to load

    fixedLayout?: boolean

    Use fixed layout

    focusable?: boolean

    Is focusable

    focusBitmapBlendColor?: sgApi.IColor

    Focus bitmap blend color

    focusBitmapUri?: string

    Focus bitmap URI

    focusColumn?: number

    Focused column

    focusedChild?: void

    Focused child

    focusFootprintBitmapUri?: string

    Focus footprint bitmap URI

    focusFootprintBlendColor?: sgApi.IColor

    Focus footprint blend color

    focusRow?: number

    Focused row

    horizFocusAnimationStyle?: string

    Horizontal focus animation style

    id: string

    Node ID

    imageWellBitmapUri?: string

    URI for image well bitmap

    inheritParentOpacity?: boolean

    Inherit parent opacity

    inheritParentTransform?: boolean

    Inherit parent transform

    itemClippingRect?: any

    Item clipping rectangle

    itemcurrFocusFeedbackOpacity?: number

    Item focus feedback opacity

    itemFocused?: number

    Currently focused item

    itemSelected?: number

    Currently selected item

    itemSize?: any

    Item size

    itemSpacing?: any

    Item spacing

    itemUnfocused?: number

    Currently unfocused item

    jumpToItem?: number

    Target item to jump to

    loadingBitmapOpacity?: number

    Opacity of bitmap shown while poster is loading

    loadingBitmapUri?: string

    URI for bitmap shown while poster is loading

    muteAudioGuide?: boolean

    Mute audio guide

    numColumns?: number

    Number of columns

    numRenderPasses?: number

    Number of render passes

    numRows?: number

    Number of rows

    opacity: number

    Opacity value

    posterDisplayMode?: string

    Display mode for posters

    renderPass?: number

    Render pass

    renderTracking?: string

    Render tracking

    rotation: number

    Rotation angle

    rowHeights?: number[]

    Array of row heights

    rowSpacings?: number[]

    Array of row spacings

    scale: [number, number]

    Scale values

    scaleRotateCenter: [number, number]

    Scale/rotate center point

    sectionDividerBitmapUri?: string

    Section divider bitmap URI

    sectionDividerFont?: ISGROFont

    Section divider font

    sectionDividerHeight?: number

    Section divider height

    sectionDividerLeftOffset?: number

    Section divider left offset

    sectionDividerMinWidth?: number

    Section divider minimum width

    sectionDividerSpacing?: number

    Section divider spacing

    sectionDividerTextColor?: sgApi.IColor

    Section divider text color

    sectionDividerWidth?: number

    Section divider width

    showBackgroundForEmptyCaptions?: boolean

    Whether to show background for empty captions

    skipFocusAnimations?: boolean

    Skip focus animations

    translation: [number, number]

    Translation values

    useAtlas?: boolean

    Whether to use texture atlas

    vertFocusAnimationStyle?: string

    Vertical focus animation style

    visible: boolean

    Visibility

    wrapDividerBitmapUri?: string

    Wrap divider bitmap URI

    wrapDividerHeight?: number

    Wrap divider height

    wrapDividerWidth?: number

    Wrap divider width

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    animateToItembasePosterSizeboundViewcaption1Colorcaption1Fontcaption1NumLinescaption2Colorcaption2Fontcaption2NumLinescaptionBackgroundBitmapUricaptionHorizAlignmentcaptionLineSpacingcaptionVertAlignmentchangechildRenderOrderclippingRectcolumnSpacingscolumnWidthscontentcurrFocusColumncurrFocusFeedbackOpacitycurrFocusRowcurrFocusSectiondivdrawFocusFeedbackdrawFocusFeedbackOnTopenableCaptionScrollingenableRenderTrackingfadeFocusFeedbackWhenAutoScrollingfailedBitmapOpacityfailedBitmapUrifixedLayoutfocusablefocusBitmapBlendColorfocusBitmapUrifocusColumnfocusedChildfocusFootprintBitmapUrifocusFootprintBlendColorfocusRowhorizFocusAnimationStyleidimageWellBitmapUriinheritParentOpacityinheritParentTransformitemClippingRectitemcurrFocusFeedbackOpacityitemFocuseditemSelecteditemSizeitemSpacingitemUnfocusedjumpToItemloadingBitmapOpacityloadingBitmapUrimuteAudioGuidenumColumnsnumRenderPassesnumRowsopacityposterDisplayModerenderPassrenderTrackingrotationrowHeightsrowSpacingsscalescaleRotateCentersectionDividerBitmapUrisectionDividerFontsectionDividerHeightsectionDividerLeftOffsetsectionDividerMinWidthsectionDividerSpacingsectionDividerTextColorsectionDividerWidthshowBackgroundForEmptyCaptionsskipFocusAnimationstranslationuseAtlasvertFocusAnimationStylevisiblewrapDividerBitmapUriwrapDividerHeightwrapDividerWidth
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate