Class UIDrawImageElement

Defines an image element within UIDrawContent.

Index

Constructors

Properties

_border _clipPath _depth? _image _preserveAspect _rect _tint

Accessors

border clipPath depth image preserveAspect rect tint

Methods

assign clone isEqual isEqual

Constructors

constructor

new UIDrawImageElement(image?, rect?, tint?, border?, preserveAspect?, clipPath?, depth?): UIDrawImageElement
Parameters
- Optionalimage: Image
- Optionalrect: Immutable<Rect2>
- Optionaltint: Immutable<SRGBColor>
- Optionalborder: Immutable<RectOffset>
- OptionalpreserveAspect: boolean
- OptionalclipPath: Path
- Optionaldepth: number
Returns UIDrawImageElement

Properties

`Protected`_border

_border: RectOffset

`Protected`_clipPath

_clipPath: Path

`Protected` `Optional`_depth

_depth?: number

`Protected`_image

_image: Image

`Protected`_preserveAspect

_preserveAspect: boolean

`Protected`_rect

_rect: Rect2

`Protected`_tint

_tint: SRGBColor

Accessors

border

get border(): RectOffset
Scale9Grid borders in pixels (0 = no 9-slice).

Returns RectOffset
set border(value): void
Parameters
- value: Immutable<RectOffset>
Returns void

clipPath

get clipPath(): Path
Clip path in local point coordinates. If set, the image is clipped to this path shape.

Returns Path
set clipPath(value): void
Parameters
- value: Path
Returns void

depth

get depth(): number
Optional depth layer override. If unset, the default insertion-order depth is used.

Returns number
set depth(value): void
Parameters
- value: number
Returns void

image

get image(): Image
The image resource to display.

Returns Image
set image(value): void
Parameters
- value: Image
Returns void

preserveAspect

get preserveAspect(): boolean
Whether to preserve the image's aspect ratio when scaling.

Returns boolean
set preserveAspect(value): void
Parameters
- value: boolean
Returns void

rect

get rect(): Rect2
Position and size in points.

Returns Rect2
set rect(value): void
Parameters
- value: Immutable<Rect2>
Returns void

tint

get tint(): SRGBColor
Color tint applied to the image. White = no tint.

Returns SRGBColor
set tint(value): void
Parameters
- value: Immutable<SRGBColor>
Returns void

Methods

assign

assign(other): UIDrawImageElement
Copies all properties defined by the prototype of UIDrawImageElement from other to this instance.
Parameters
- other: Immutable<UIDrawImageElement>
Returns UIDrawImageElement

clone

clone(): UIDrawImageElement
Clones this instance and returns a new UIDrawImageElement with identical values.

Returns UIDrawImageElement

isEqual

isEqual(this, other): boolean
Determines if this UIDrawImageElement instance is equal to the other instance.
Parameters
- this: Immutable<UIDrawImageElement>
- other: Immutable<UIDrawImageElement>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both UIDrawImageElement instances are equal.
Parameters
- lhs: Immutable<UIDrawImageElement>
- rhs: Immutable<UIDrawImageElement>
Returns boolean