Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: DOM
Phaser.DOM
Source: src/dom/index.js (Line 7)

Classes

Methods

<static> AddToDOM(element, [parent])
Focus
Focus

Description:

Adds the given element to the DOM. If a parent is provided the element is added as a child of the parent, providing it was able to access it. If no parent was given it falls back to using document.body.

Parameters:

name type arguments description
element HTMLElement

The element to be added to the DOM. Usually a Canvas object.

parent string | HTMLElement <optional>

The parent in which to add the element. Can be a string which is passed to getElementById or an actual DOM object.

Returns:
Description:

The element that was added to the DOM.

Type:
  • HTMLElement
Examples:
Since: 3.0.0
Source: src/dom/AddToDOM.js (Line 7)
Focus
Focus
<static> DOMContentLoaded(callback)
Focus
Focus

Description:

Inspects the readyState of the document. If the document is already complete then it invokes the given callback. If not complete it sets up several event listeners such as deviceready, and once those fire, it invokes the callback. Called automatically by the Phaser.Game instance. Should not usually be accessed directly.

Parameters:

name type description
callback ContentLoadedCallback

The callback to be invoked when the device is ready and the DOM content is loaded.

Examples:
Since: 3.0.0
Focus
Focus
<static> GetInnerHeight(iOS)
Focus
Focus

Description:

Attempts to determine the document inner height across iOS and standard devices. Based on code by @tylerjpeterson

Parameters:

name type description
iOS boolean

Is this running on iOS?

Returns:
Description:

The inner height value.

Type:
  • number
Examples:
Since: 3.16.0
Source: src/dom/GetInnerHeight.js (Line 7)
Focus
Focus
<static> GetScreenOrientation(width, height)
Focus
Focus

Description:

Attempts to determine the screen orientation using the Orientation API.

Parameters:

name type description
width number

The width of the viewport.

height number

The height of the viewport.

Returns:
Description:

The orientation.

Type:
  • string
Examples:
Since: 3.16.0
Focus
Focus
<static> GetTarget(element)
Focus
Focus

Description:

Attempts to get the target DOM element based on the given value, which can be either a string, in which case it will be looked-up by ID, or an element node. If nothing can be found it will return a reference to the document.body.

Parameters:

name type description
element HTMLElement

The DOM element to look-up.

Examples:
Since: 3.16.0
Source: src/dom/GetTarget.js (Line 7)
Focus
Focus
<static> ParseXML(data)
Focus
Focus

Description:

Takes the given data string and parses it as XML. First tries to use the window.DOMParser and reverts to the Microsoft.XMLDOM if that fails. The parsed XML object is returned, or null if there was an error while parsing the data.

Parameters:

name type description
data string

The XML source stored in a string.

Returns:
Description:

The parsed XML data, or null if the data could not be parsed.

Type:
  • DOMParser
  • ActiveXObject
Examples:
Since: 3.0.0
Source: src/dom/ParseXML.js (Line 7)
Focus
Focus
<static> RemoveFromDOM(element)
Focus
Focus

Description:

Attempts to remove the element from its parentNode in the DOM.

Parameters:

name type description
element HTMLElement

The DOM element to remove from its parent node.

Examples:
Since: 3.0.0
Source: src/dom/RemoveFromDOM.js (Line 7)
Focus
Focus