Class “ImageView”

Object > NativeObject > Widget > ImageView

A widget to display an image.

ImageView on Android
Android
ImageView on iOS
iOS
Constructor public
Singleton No
Namespace tabris
Direct subclasses None
JSX support Element: <ImageView/>
Parent element: <Composite/> and any widget extending Composite
Child elements: None
Text content: Not supported

Example

import {ImageView, contentView} from 'tabris';

new ImageView({image: 'resources/image.png'})
  .appendTo(contentView);

See also:

Constructor

new ImageView(properties?)

Parameter Type Optional Description
properties Properties<ImageView> Yes Sets all key-value pairs in the properties object as widget properties.

Properties

image

The image to display. Providing the width and height attributes on the image will resize it internally. When no dimensions are given the image will be loaded with its original size. Since the full size image might occupy a lot of memory, it’s recommended to provide exact dimensions.

Type ImageValue
Settable Yes
Change events Yes

maxZoomLevel

The highest amount the image can be zoomed in to. Setting the maxZoomLevel to a level smaller than the current zoomLevel changes the zoomLevel to be the same as the new maxZoomLevel.

Type number
Default 3
Settable Yes
Change events Yes

minZoomLevel

The lowest amount the image can be zoomed out to. Setting the minZoomLevel to a level larger than the current zoomLevel changes the zoomLevel to be the same as the new minZoomLevel.

Type number
Default 1
Settable Yes
Change events Yes

scaleMode

How to scale the image.

  • fit will scale the image proportionally to fit into the view, possible leaving some empty space at the edges. That is, the image will be displayed as large as possible while being fully contained in the view.
  • fill will scale the image proportionally to fill the entire view, possibly cutting off parts of the image. That is, the image will be displayed as small as possible while covering the entire view.
  • auto will scale down the image to fit into the view if it is too large, but it won’t scale up a smaller image.
  • stretch will resize the image to the actual bounds of the image view.
  • none will not resize the image at all. The image will be displayed in its original size.
Type 'auto' | 'fit' | 'fill' | 'stretch' | 'none'
Default 'auto'
Settable Yes
Change events Yes

tintColor

A color to change the image appearance. All opaque parts of the image will be tinted with the given color. Set to initial to remove the effect.

Type ColorValue
Settable Yes
Change events Yes

zoomEnabled

Enables the pinch-to-zoom gesture on the ImageView and makes the properties zoomLevel, minZoomLevel and maxZoomLevel available. Setting zoomEnabled to false also resets the zoomLevel, minZoomLevel, maxZoomLevel to their respective defaults.

Type boolean
Settable Yes
Change events Yes

zoomLevel

The amount that the image is zoomed in or out. The default position without any zooming has the value 1.0.

Type number
Default 1
Settable Yes
Change events Yes

Events

load

Fired when the image loading has finished.

Parameter Type Description
error boolean Contains the final status of the loading process

zoom

Fired when the user zooms the image in or out. The zoom event indicates a change to the zoomLevel property.

Parameter Type Description
zoomLevel number The new value of zoomLevel.

Change Events

imageChanged

Fired when the image property has changed.

Parameter Type Description
value ImageValue The new value of image.

scaleModeChanged

Fired when the scaleMode property has changed.

Parameter Type Description
value string The new value of scaleMode.

tintColorChanged

Fired when the tintColor property has changed.

Parameter Type Description
value ColorValue The new value of tintColor.

zoomEnabledChanged

Fired when the zoomEnabled property has changed.

Parameter Type Description
value boolean The new value of zoomEnabled.

zoomLevelChanged

Fired when the zoomLevel property has changed.

Parameter Type Description
value number The new value of zoomLevel.

minZoomLevelChanged

Fired when the minZoomLevel property has changed.

Parameter Type Description
value number The new value of minZoomLevel.

maxZoomLevelChanged

Fired when the maxZoomLevel property has changed.

Parameter Type Description
value number The new value of maxZoomLevel.