Class: Layer

Layer

new Layer(layerUseopt)

todoc
Parameters:
Name Type Attributes Description
layerUse Object <optional>
Properties:
Name Type Description
canvas HTMLCanvasElement | HTMLElement
ctx CanvasRenderingContext2D
Source:

Extends

Members

background :String

The background of the layer's canvas
Type:
  • String
Default Value:
  • 'rgba(0, 0, 0, 0)'
Source:

body :ContainerElement

The main ContainerElement of the Layer
Type:
Source:

height :Number

The height of the layer
Type:
  • Number
Source:

id :String

The id of the layer
Type:
  • String
Default Value:
  • null
Source:

live :Boolean

If the renderer should update the layer at every tick
Type:
  • Boolean
Default Value:
  • true
Source:

opacity :Number

The alpha level (globalAlpha) of the layer's canvas element
Type:
  • Number
Default Value:
  • 1
Source:

(readonly) root :Scene

The scene of the layer
Type:
Default Value:
  • null
Source:

(readonly) uuid :String

The uuid of the layer
Type:
  • String
Default Value:
  • null
Source:

visible :Boolean

If the layer should be rendered
Type:
  • Boolean
Default Value:
  • true
Source:

width :Number

The width of the layer
Type:
  • Number
Source:

x :Number

The x position of the canvas
Type:
  • Number
Default Value:
  • 0
Source:

y :Number

The y position of the canvas
Type:
  • Number
Default Value:
  • 0
Source:

zIndex :Number

The z-index of the layer's canvas
Type:
  • Number
Default Value:
  • 0
Source:

Methods

add(element, container, orderIDopt) → {Layer}

Adds an Element to the Layer
Parameters:
Name Type Attributes Description
element Element
container String
orderID int <optional>
Source:
Returns:
Layer
this

addEventListener(type, listener) → {EventTarget}

Adds a listener to the specified event
Parameters:
Name Type Description
type String
listener function
Inherited From:
Source:
Returns:
EventTarget
this

clear() → {Layer}

Clears the entire layer
Source:
Returns:
Layer
this

contains(searchElement) → {Boolean}

Checks if the Layer contains a specific Element
Parameters:
Name Type Description
searchElement Element
Source:
Returns:
Boolean

create(type) → (nullable) {Element}

Creates a new Element and returns it
Parameters:
Name Type Attributes Description
type String
* <repeatable>
Source:
Returns:
Element

dispatchEvent(type) → {EventTarget}

Dispatches an Event at the specified EventTarget
Parameters:
Name Type Description
type String
Inherited From:
Source:
Returns:
EventTarget
this

eachContainer(callback, thisArgopt) → {Layer}

Executes a provided callback function once per ContainerElement
Parameters:
Name Type Attributes Description
callback function
thisArg * <optional>
Source:
Returns:
Layer
this

eachElement(callback, thisArgopt) → {Layer}

Executes a provided callback function recursively once per Element in ascending order
Parameters:
Name Type Attributes Description
callback function
thisArg * <optional>
Source:
Returns:
Layer
this

eachEventListener(type, callback) → {EventTarget}

Executes a provided function once per event listener
Parameters:
Name Type Description
type String
callback function
Inherited From:
Source:
Returns:
EventTarget
this

emit(type) → {EventTarget}

Dispatches an Event at the specified EventTarget
Parameters:
Name Type Description
type String
Inherited From:
Source:
See:
Returns:
EventTarget
this

getElementByID(id) → (nullable) {Element}

Gets an element by id
Parameters:
Name Type Description
id String
Source:
To Do:
  • Break forEach when find element
Returns:
Element

getPixel(x, y) → {Uint8ClampedArray}

Gets ImageData from the layer
Parameters:
Name Type Description
x int
y int
Source:
Returns:
Uint8ClampedArray

hasEventListener(type) → {Boolean}

Determines if the eventTarget has eventListeners of the given type
Parameters:
Name Type Description
type String
Inherited From:
Source:
Returns:
Boolean

insert(elementType, argsopt, containeropt, orderIDopt) → (nullable) {Element}

Combination of Layer#create and Layer#add
Parameters:
Name Type Attributes Description
elementType String
args Object | Array <optional>
container String <optional>
orderID int <optional>
Source:
Returns:
Element

moveAfter(element, reference) → {Layer}

Sets the order position of the Element exactly after the reference
Parameters:
Name Type Description
element Element
reference Element
Source:
Returns:
Layer
this

moveBefore(element, reference) → {Layer}

Sets the order position of the Element exactly before the reference
Parameters:
Name Type Description
element Element
reference Element
Source:
Returns:
Layer
this

off(type, listener) → {EventTarget}

Removes a listener from the specified event
Parameters:
Name Type Description
type String
listener function
Inherited From:
Source:
See:
Returns:
EventTarget
this

offAll() → {EventTarget}

Removes all listeners
Inherited From:
Source:
See:
Returns:
EventTarget
this

on(type, listener) → {EventTarget}

Adds a listener to the specified event
Parameters:
Name Type Description
type String
listener function
Inherited From:
Source:
See:
Returns:
EventTarget
this

remove(removeElement) → (nullable) {Element}

Removes an Element from the Layer
Parameters:
Name Type Description
removeElement Element
Source:
Returns:
Element
removed

removeAllEventListeners() → {EventTarget}

Removes all listeners
Inherited From:
Source:
Returns:
EventTarget
this

removeEventListener(type, listener) → {EventTarget}

Removes a listener from the specified event
Parameters:
Name Type Description
type String
listener function
Inherited From:
Source:
Returns:
EventTarget
this

render() → {Layer}

Renders the entries of the layer
Source:
Returns:
Layer
this

scrollBy(x, y) → {Layer}

Scrolls the layer, edits it's x and y by the given values
Parameters:
Name Type Description
x int
y int
Source:
Returns:
Layer
this

scrollTo(x, y) → {Layer}

Scrolls the layer, sets it's x and y to the given values
Parameters:
Name Type Description
x int
y int
Source:
Returns:
Layer
this

select(query, contextopt) → {Array}

Returns a list of elements by the given query selector
Parameters:
Name Type Attributes Default Description
query String
context ContainerElement <optional>
 this.body
Source:
To Do:
  • Implement this method
Returns:
Array

toString() → {String}

Returns the string value of the layer
Overrides:
Source:
Returns:
String