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

    Class ImageView<T, R>

    ImageView is a primitive view for displaying images with loading and error states.

    • Uses a native renderer for efficient image display.
    • Supports custom loading and error bitmaps.
    • Emits load status change events.
    Image({
      imageUri: this.iconUri,
      color: this.iconColor
    })
      .visible(this.iconUri !== '')
      .imageUri(this.iconUri)
      .styleKey(this.iconStyleKey)

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __isMemoizedStateValid _cacheKey _hid _isInFocusChain _rendereredTranslation activeStyleViewStatus aggregateView audioGuideHint? audioGuideItem? calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children childrenChanged clippingRect color compositeView customData? defaultValues eventHandlers failedBitmapOpacity failedBitmapUri focusedChildId? focusId height id imageUri includeInLayout initialFocusId instancePool isFocused isLayoutDirty isPresented isSkeleton isWaking loadDisplayMode loadingBitmapOpacity loadingBitmapUri loadStatus nextViewId nodePool onLoadStatusChange? opacity parent? partialRendererHibernatedState rotation scale scaleRotateCenter scrollablePositionX scrollablePositionY staticType styleRegistry subViews subViewsChanged translation viewOwner viewStatus visible width

    Accessors

    renderer viewPhase

    Methods

    addChild addChildren addRendererToParentViewRenderer addSubView applyIdsToViewStructs applyInitialState applyLayoutStateToNativeRenderer applyStateChanges buildView canMeasureBounds clearErrorByErrorField clearErrors configureAudioGuideItem containsChild createDataEvent dismiss dispatch dispatchAction dispatchAsync dispatchSelection findNextFocusable findNextFocusableView findNextFocusableViewByDirection getAudioGuideItem getBounds getBoundsInApp getBoundsInParent getChangedField getChildView getCustomData getField getFlattenedStructs getFlattenedStructsById getNavController getObservableField getSubView getSubViewRenderer hibernateView inflateViewStructs insertChild insertSubView invalidateLayout invalidateParentLayout isDescendantOf isInFocusChain layoutAt layoutChildren notifyOnFocusedChildChange onAppear onBlur onDidAddToAggregateView onDidRemoveFromAggregateView onDisappear onFocus onKeyEvent onLoadStatus onMount onUnmount onWillAddToAggregateView onWillApplyStateChanges onWillRemoveFromAggregateView performViewManagerLayoutChildren present reconcileChildren recycle registerControlWithErrorMessage registerControlWithKnownError release removeChild removeSubView render setError setField setLayoutField setObservableField setShowOnScreen setState showDialog unobserveObservableObjects wakeView

    Constructors

    Properties

    __isMemoizedStateValid

    __isMemoizedStateValid: boolean = false

    _cacheKey

    _cacheKey: string = ''

    _hid

    _hid: string

    _isInFocusChain

    _isInFocusChain: boolean = false

    _rendereredTranslation

    _rendereredTranslation: [number, number] = ...
    activeStyleViewStatus: ViewStatus = ViewStatus.Normal
    aggregateView: undefined | IAggregateView.IAggregateView

    IHosannaView

    audioGuideHint?: string = ''

    This hint can be used in conjunction with the audio guide item

    audioGuideItem?: string | IAudioGuideItem
    calculatedHeight: number = 0
    calculatedWidth: number = 0
    calculatedX: number = 0
    calculatedY: number = 0
    canReceiveFocus: boolean = false

    Whether the view can receive focus.

    children: BaseView.BaseView<ViewState, ISGNGroup>[] = []

    These are the children that are rendered on screen in the tree structure of the view

    childrenChanged: boolean = false
    clippingRect: number[] = ...
    color: string = '#ffffff'
    compositeView: boolean = false

    Whether this is a composite view.

    customData?: unknown
    defaultValues: Partial<T> = {}
    eventHandlers: Record<string, Function> = {}
    failedBitmapOpacity: number = 0

    Opacity for the failed bitmap.

    failedBitmapUri: string = ''

    URI for the failed bitmap.

    focusedChildId?: string
    focusId: string = ''
    height: number = 0
    id: string = ''
    imageUri: string = ''

    URI of the image to display.

    includeInLayout: boolean = true
    initialFocusId: string = ''
    instancePool: IInstancePool
    isFocused: boolean = false

    Indicates whether the element is currently focused.

    isLayoutDirty: boolean = false
    isPresented: boolean = false

    If true, this view has been presented in an AggregateViewController

    isSkeleton: boolean = false
    isWaking: boolean = false
    loadDisplayMode: SGImageLoadDisplayMode = SGImageLoadDisplayMode.LimitSize

    Display mode for image loading.

    loadingBitmapOpacity: number = 0

    Opacity for the loading bitmap.

    loadingBitmapUri: string = ''

    URI for the loading bitmap.

    loadStatus: SGImageLoadStatus = SGImageLoadStatus.None

    Current load status.

    nextViewId: number = 0
    nodePool: INodePool
    onLoadStatusChange?: ViewEventHandler<ImageEvent>

    Callback for load status changes.

    opacity: number = 1.0
    parent?: IHosannaView<ViewState> = undefined
    partialRendererHibernatedState: Partial<T> = {}
    rotation: number = 0
    scale: number[] = ...
    scaleRotateCenter: number[] = ...
    scrollablePositionX: undefined | number = undefined
    scrollablePositionY: undefined | number = undefined
    staticType: ViewStaticType = ViewStaticType.None
    styleRegistry: IStyleRegistry
    subViews: BaseView.BaseView<ViewState, ISGNGroup>[] = []

    These are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.

    subViewsChanged: boolean = false
    translation: number[] = ...
    viewOwner: IHosannaView<ViewState>

    The IHosannaView subclass that created us in getViews

    viewStatus: ViewStatus = ViewStatus.Normal
    visible: boolean = true

    Indicates whether the navigatable entity is visible.

    width: number = 0

    Accessors

    Methods

    • Builds the view and attaches it to the view owner.

      Parameters

      • struct: ViewStruct<ViewState>
      • OptionalmountTarget: IHosannaView<ViewState>

        The target to mount the view.

      • childIndex: number = -1

      Returns undefined | IHosannaView<ViewState>

      The built view or undefined.

    • Parameters

      • nextStructs: ViewStruct<ViewState>[]
      • map: Record<string, ViewStruct<ViewState>> = {}
      • idList: { childIndex: number; id: string }[] = []

      Returns {
          idList: { childIndex: number; id: string }[];
          mappedNextStructs: Record<string, ViewStruct<ViewState>>;
      }

    • Presents a new screen in the navigation stack or as a dialog.

      Parameters

      • screen: ViewStruct<ViewState>

        The screen to be presented, represented by a ViewStruct<ViewState>.

      • Optionaloptions: IScreenPresentationOptions

        Optional presentation options.

        • isDialog

          If true, the screen will be presented as a dialog.

        • animated

          If true, the screen transition will be animated.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    addChildaddChildrenaddRendererToParentViewRendereraddSubViewapplyIdsToViewStructsapplyInitialStateapplyLayoutStateToNativeRendererapplyStateChangesbuildViewcanMeasureBoundsclearErrorByErrorFieldclearErrorsconfigureAudioGuideItemcontainsChildcreateDataEventdismissdispatchdispatchActiondispatchAsyncdispatchSelectionfindNextFocusablefindNextFocusableViewfindNextFocusableViewByDirectiongetAudioGuideItemgetBoundsgetBoundsInAppgetBoundsInParentgetChangedFieldgetChildViewgetCustomDatagetFieldgetFlattenedStructsgetFlattenedStructsByIdgetNavControllergetObservableFieldgetSubViewgetSubViewRendererhibernateViewinflateViewStructsinsertChildinsertSubViewinvalidateLayoutinvalidateParentLayoutisDescendantOfisInFocusChainlayoutAtlayoutChildrennotifyOnFocusedChildChangeonAppearonBluronDidAddToAggregateViewonDidRemoveFromAggregateViewonDisappearonFocusonKeyEventonLoadStatusonMountonUnmountonWillAddToAggregateViewonWillApplyStateChangesonWillRemoveFromAggregateViewperformViewManagerLayoutChildrenpresentreconcileChildrenrecycleregisterControlWithErrorMessageregisterControlWithKnownErrorreleaseremoveChildremoveSubViewrendersetErrorsetFieldsetLayoutFieldsetObservableFieldsetShowOnScreensetStateshowDialogunobserveObservableObjectswakeView