Class Image

Hierarchy

Node
- Image

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Image(id: string, position: Vector, source: string | HTMLImageElement, width: number, height: number, props?: ImageOptions): Image

Overrides Node.constructor
- Defined in view/image.ts:14
A scene-graph Node

Parameters
- id: string
- position: Vector
- source: string | HTMLImageElement
- width: number
- height: number
- props: ImageOptions = {}
Returns Image

Properties

_source

_source: HTMLImageElement

context

context: CanvasRenderingContext2D

drawing

drawing: Drawing

height

height: number

hitColor

hitColor: Color

id

id: string

offContext

offContext: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D

order

order: number

props

props: ImageOptions = {}

registeredEvents

registeredEvents: any

transform

transform: Transform

width

width: number

Accessors

absolutePosition

get absolutePosition(): Vector

Inherited from Node.absolutePosition
- Defined in core/node.ts:54
Returns Vector

childs

get childs(): Node[]

Inherited from Node.childs
- Defined in core/node.ts:42
Returns Node[]

localRotation

get localRotation(): number
set localRotation(degrees: number): void

Inherited from Node.localRotation
- Defined in core/node.ts:65
Returns number
Inherited from Node.localRotation
- Defined in core/node.ts:68
Parameters
- degrees: number
Returns void

parent

get parent(): Node
set parent(newParent: Node): void

Inherited from Node.parent
- Defined in core/node.ts:35
Returns Node
Inherited from Node.parent
- Defined in core/node.ts:38
Parameters
- newParent: Node
Returns void

position

get position(): Vector
set position(position: Vector): void

Inherited from Node.position
- Defined in core/node.ts:48
Returns Vector
Inherited from Node.position
- Defined in core/node.ts:51
Parameters
- position: Vector
Returns void

rotation

get rotation(): number
set rotation(degrees: number): void

Inherited from Node.rotation
- Defined in core/node.ts:58
Returns number
Inherited from Node.rotation
- Defined in core/node.ts:61
Parameters
- degrees: number
Returns void

scale

get scale(): Vector
set scale(scale: Vector): void

Inherited from Node.scale
- Defined in core/node.ts:72
Returns Vector
Inherited from Node.scale
- Defined in core/node.ts:75
Parameters
- scale: Vector
Returns void

zIndex

get zIndex(): number
set zIndex(zIndex: number): void

Inherited from Node.zIndex
- Defined in core/node.ts:22
Returns number
Inherited from Node.zIndex
- Defined in core/node.ts:25
Parameters
- zIndex: number
Returns void

Methods

_offRender

_offRender(): void

Overrides Node._offRender
- Defined in view/image.ts:75
Returns void

_render

_render(): void

Overrides Node._render
- Defined in view/image.ts:34
Returns void

call

call(method: string, args?: any[]): void

Inherited from Node.call
- Defined in core/node.ts:148
Calls all the event callbacks registered using on

Parameters
- method: string
- Optional args: any[]
Returns void

dispose

dispose(): void

Inherited from Node.dispose
- Defined in core/node.ts:186
Remove this node from Drawing's scene-graph Calls remove on Drawing object

Returns void

getDimension

getDimension(): Vector

Overrides Node.getDimension
- Defined in view/image.ts:100
Returns Vector

offRender

offRender(): void

Inherited from Node.offRender
- Defined in core/node.ts:139
Calls internal _offRender function for this node

Returns void

on

on(eventKey: string, callback: Function): void

Inherited from Node.on
- Defined in core/node.ts:122
Register an event on this Node

Parameters
- eventKey: string
  
  name of the event
- callback: Function
  
  callback
Returns void

render

render(): void

Inherited from Node.render
- Defined in core/node.ts:127
Calls internal _render/_offRender functions and recursively invokes render functions for all child nodes

Returns void

setHitColor

setHitColor(): void

Inherited from Node.setHitColor
- Defined in core/node.ts:102
Sets a unique color for this node on hit-maps

Returns void