Image

Represents an image (see example).

options

OptionsStore

The configuration of this element.

Constructors

Image

(src: string, rect: Rect)

Creates an image instance.

Parameters

src

string

The source image URL.

rect

Rect

A rectangle defining the image size and position.

Methods

bbox

Returns the bounding box of the element with applied transformations.

Returns

Rect

  • The bounding box of the element with transformations applied.

clip

Gets the clipping path for this element.

Returns

Path

  • The clipping path for this element.

clip

Sets the clipping path for this element. The Path instance will be monitored for changes. Can be replaced by calling the clip method.

The following example demonstrates how to set a clipping path on a Circle.

The following example demonstrates how to clear a clipping path.

Parameters

clip

Path

The element clipping path.

clippedBBox

Returns the bounding box of the element with clipping and transformations applied. This is the rectangle that will fit around the actual rendered element.

Returns

Rect

  • The bounding box of the element with clipping and transformations applied.

containsPoint

Returns true if the shape contains the specified point.

Parameters

point

Point

The point that should be checked.

Returns

boolean

value indicating if the shape contains the point.

opacity

Gets the element opacity.

Returns

number

The current element opacity.

opacity

Sets the opacity of the element.

Parameters

opacity

number

The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).

rect

Gets the rectangle which defines the position and size of the image.

Returns

Rect

  • The rectangle which defines the position and size of the image.

rect

Sets the rectangle which defines the position and size of the image.

Parameters

value

Rect

The rectangle which defines the position and size of the image.

src

Gets the source URL of the image.

Returns

string

  • The source URL of the image.

src

Sets the source URL of the image.

Parameters

value

string

The source URL of the image.

transform

Gets the transformation of the element.

Returns

Transformation

  • The current transformation on the element.

transform

Sets the transformation of the element.

Parameters

transform

Transformation

The transformation to apply to the element.

visible

Gets the visibility of the element.

Returns

boolean

true if the element is visible. Otherwise, returns false.

visible

Sets the visibility of the element.

Parameters

visible

boolean

A flag which indicates if the element will be visible.