Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ImageProperties

Indexable

[key: string]: any

key for others property.

Index

Properties

Source

Source: string

The image source (either a remote URL or a local file resource). The image source (either a remote URL or a local file resource).

Optional accessibilityLabel

accessibilityLabel: Node

The text that's read by the screen reader when the user interacts with the image. It is only for ios The text that's read by the screen reader when the user interacts with the image. It is only for ios

accessible

accessible: boolean

When true, indicates the image is an accessibility element. When true, indicates the image is an accessibility element.

Optional blurRadius

blurRadius: undefined | number

blurRadius: the blur radius of the blur filter added to the image blurRadius: the blur radius of the blur filter added to the image

capInsets

capInsets: object

When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched

getSize

getSize: function

Retrieve the width and height (in pixels) of an image prior to displaying it. This method can fail if the image cannot be found, or fails to download. Retrieve the width and height (in pixels) of an image prior to displaying it. This method can fail if the image cannot be found, or fails to download.

Type declaration

    • (uri: string, success: function, failure: function): void
    • Parameters

      • uri: string
      • success: function
          • (): void
          • Returns void

      • failure: function
          • (): void
          • Returns void

      Returns void

Optional onError

onError: undefined | function

Invoked on load error with {nativeEvent: {error}}. Invoked on load error with {nativeEvent: {error}}.

Optional onLayout

onLayout: undefined | function

Invoked on mount and layout changes with {nativeEvent: {layout: {x, y, width, height}}}. Invoked on mount and layout changes with {nativeEvent: {layout: {x, y, width, height}}}.

Optional onLoad

onLoad: undefined | function

Invoked when load completes successfully. Invoked when load completes successfully.

Optional onLoadEnd

onLoadEnd: undefined | function

Invoked when load either succeeds or fails. Invoked when load either succeeds or fails.

Optional onLoadStart

onLoadStart: undefined | function

Invoked on load start. Invoked on load start.

onPartialLoad

onPartialLoad: function

Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads. Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads.

Type declaration

    • (): void
    • Returns void

onProgress

onProgress: function

Invoked on download progress with {nativeEvent: {loaded, total}}. Invoked on download progress with {nativeEvent: {loaded, total}}.

Type declaration

    • (): void
    • Returns void

prefetch

prefetch: function

Prefetches a remote image for later use by downloading it to the disk cache Prefetches a remote image for later use by downloading it to the disk cache

Type declaration

    • (url: string): void
    • Parameters

      • url: string

      Returns void

Optional resizeMethod

resizeMethod: "auto" | "resize" | "scale"

The mechanism that should be used to resize the image. when the image's dimensions differ from the image view's dimensions. Defaults to auto The mechanism that should be used to resize the image. when the image's dimensions differ from the image view's dimensions. Defaults to auto

Optional resizeMode

resizeMode: "cover" | "contain" | "stretch" | "repeat" | "center"

Determines how to resize the image when the frame doesn't match the raw image dimensions Determines how to resize the image when the frame doesn't match the raw image dimensions

Optional style

style: undefined | object

It is used to style the Image It is used to style the Image

Optional testID

testID: undefined | string

A unique identifier for this element to be used in UI Automation testing scripts. It is only for android A unique identifier for this element to be used in UI Automation testing scripts. It is only for android

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc