Widget “ImageView”

Extends Widget

A widget to display an image.

You can import this type like this:

import {ImageView} from 'tabris';

Or reference it directly form anywhere as “tabris.ImageView”.

Properties

image

Type: 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.

maxZoomLevel

Type: number, default: 3

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.

minZoomLevel

Type: number, default: 1

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.

scaleMode

Type: string, supported values: auto, fit, fill, stretch, none, default: auto

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.

tintColor

Type: Color

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.

zoomEnabled

Type: boolean

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.

zoomLevel

Type: number, default: 1

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

Events

imageChanged

Fired when the image property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: Image The new value of image.

load

Fired when the image loading has finished.

Event Parameters

  • target: this The widget the event was fired on.

  • error: boolean Contains the final status of the loading process

maxZoomLevelChanged

Fired when the maxZoomLevel property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: number The new value of maxZoomLevel.

minZoomLevelChanged

Fired when the minZoomLevel property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: number The new value of minZoomLevel.

scaleModeChanged

Fired when the scaleMode property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: string The new value of scaleMode.

tintColorChanged

Fired when the tintColor property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: Color The new value of tintColor.

zoom

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

Event Parameters

  • target: this The widget the event was fired on.

  • zoomLevel: number The new value of zoomLevel.

zoomEnabledChanged

Fired when the zoomEnabled property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: boolean The new value of zoomEnabled.

zoomLevelChanged

Fired when the zoomLevel property has changed.

Event Parameters

  • target: this The widget the event was fired on.

  • value: number The new value of zoomLevel.

Example

import {ImageView, ui} from 'tabris';

// Display images with different scale modes

createImageView('fit');
createImageView('none');
createImageView('fill');

function createImageView(scaleMode) {
  new ImageView({
    left: 10, top: 'prev() 10', width: 250, height: 100,
    image: 'resources/target_200.png',
    background: '#aaaaaa',
    scaleMode
  }).appendTo(ui.contentView);
}