API Docs for: 1.8.0
Show:

photonui.Canvas Class

Extends photonui.Widget
Defined in: src/visual/canvas.js:41
Module: Visual
Parent Module: PhotonUI

Canvas.

Constructor

photonui.Canvas

(
  • params
)

Defined in src/visual/canvas.js:41

Parameters:

  • params Object

    An object that can contain any property of the widget (optional).

Methods

__onContextMenu

(
  • event
)
private

Inherited from photonui.Widget: src/widget.js:445

Called when the context menu should be displayed.

Parameters:

__onLocaleChanged

() private

Inherited from photonui.Widget but overwritten in src/visual/canvas.js:268

Called when the locale is changed.

_bindEvent

(
  • id
  • element
  • evName
  • callback
  • [options]
)
private

Inherited from photonui.Base: src/base.js:229

Javascript event binding (for internal use).

Parameters:

  • id String
    An unique id for the event.
  • element DOMElement
    The element on which the event will be bind.
  • evName String
    The event name (e.g. "mousemove", "click",...).
  • callback Function
    The function that will be called when the event occured.
  • [options] Object optional
    options for addEventListener

_buildHtml

() private

Inherited from photonui.Widget but overwritten in src/visual/canvas.js:250

Build the widget HTML.

_callCallbacks

(
  • wEvent
  • params
)
private

Inherited from photonui.Base: src/base.js:292

Call all callbacks for the given wEvent. NOTE: the first argument passed to the callback is the current widget. NOTE²: if the thisArg of the callback is null, this will be binded to the current widget.

Parameters:

  • wEvent String
    The widget event.
  • params Array
    Parametters that will be sent to the callbacks.

_registerWEvents

(
  • wEvents
)
private

Inherited from photonui.Base: src/base.js:276

Register available wEvent.

Parameters:

_unbindEvent

(
  • id
)
private

Inherited from photonui.Base: src/base.js:257

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_updateProperties

(
  • properties
)
deprecated private

Inherited from photonui.Base: src/base.js:209

Force the update of the given properties. This method is deprecated. One should use '@photonui-update' abitbol's annotation on concerned properties.

Parameters:

  • properties Array
    The properties to update.

_visibilityChanged

(
  • visibility
)
private

Inherited from photonui.Widget: src/widget.js:425

Called when the visibility changes.

Parameters:

  • visibility Boolean

    Current visibility state (otptional, defaut=this.visible)

addClass

(
  • className
)

Inherited from photonui.Widget: src/widget.js:378

Add a class to the outer HTML element of the widget.

Parameters:

  • className String
    The class to add.

destroy

()

Inherited from photonui.Base but overwritten in src/widget.js:367

Destroy the widget.

getContext

(
  • contextId
)

Defined in src/visual/canvas.js:57

Returns a drawing context on the canvas.

Proxy of the native canvas method. For more informations see:

Parameters:

Returns:

The drawing context.

hide

()

Inherited from photonui.Widget: src/widget.js:345

Hide the widget (equivalent to widget.visible = false).

registerCallback

(
  • id
  • wEvent
  • callback
  • thisArg
)

Inherited from photonui.Base: src/base.js:169

Register a callback for any PhotonUI/Widget event (called wEvent). Callback signature: function (Object(Base/Widget) [, arg1 [, arg2 [, ...]]])

Parameters:

  • id String
    An unique id for the callback.
  • wEvent String
    the PhotonUI/Widget event name.
  • callback Function
    The callback function.
  • thisArg Object
    The value of this (optionnal, default = current widget).

removeCallback

(
  • id
)

Inherited from photonui.Base: src/base.js:193

Remove a registered callback.

Parameters:

  • id String
    The id of the callback.

removeClass

(
  • className
)

Inherited from photonui.Widget: src/widget.js:395

Remove a class from the outer HTML element of the widget.

Parameters:

  • className String
    The class to remove.

setContext

(
  • contextId
)

Defined in src/visual/canvas.js:85

Changes the context the element is related to to the given one.

Proxy of the native canvas method if exists. For more informations see:

Parameters:

show

()

Inherited from photonui.Widget: src/widget.js:336

Display the widget (equivalent to widget.visible = true).

supportsContext

(
  • contextId
)
Boolean

Defined in src/visual/canvas.js:70

Indicate if the given context is supported by this canvas.

Proxy of the native canvas method if exists. For more informations see:

Parameters:

Returns:

Boolean:

toBlob

(
  • type
)
Blob

Defined in src/visual/canvas.js:140

Returns a Blob object representing the image contained in the canvas (at 96dpi).

Proxy of the native canvas method if exists. For more informations see:

Parameters:

  • type String

    The image format (optional, e.g: "image/png", "image/jpeg",..., default="image/png")

Returns:

Blob:

toBlobHD

(
  • type
)
Blob

Defined in src/visual/canvas.js:155

Returns a Blob object representing the image contained in the canvas (at the native resolution of the canvas).

Proxy of the native canvas method if exists. For more informations see:

Parameters:

  • type String

    The image format (optional, e.g: "image/png", "image/jpeg",..., default="image/png")

Returns:

Blob:

toDataURL

(
  • type
)
String

Defined in src/visual/canvas.js:112

Returns a "data:" URL containing a representation of the image (at 96dpi).

Proxy of the native canvas method. For more informations see:

Parameters:

  • type String

    The image format (optional, e.g: "image/png", "image/jpeg",..., default="image/png")

Returns:

String:

The data URL

toDataURLHD

(
  • type
)
String

Defined in src/visual/canvas.js:125

Returns a "data:" URL containing a representation of the image (at the native resolution of the canvas).

Proxy of the native canvas method if exists. For more informations see:

Parameters:

  • type String

    The image format (optional, e.g: "image/png", "image/jpeg",..., default="image/png")

Returns:

String:

The data URL

transferControlToProxy

()

Defined in src/visual/canvas.js:99

Gives back a proxy to allow the canvas to be used in another Worker.

Proxy of the native canvas method if exists. For more informations see:

unparent

()

Inherited from photonui.Widget: src/widget.js:354

Detache the widget from its parent.

Properties

__callbacks

Object private

Inherited from photonui.Base: src/base.js:142

Object containing references to registered callbacks.

__events

Object private

Inherited from photonui.Base: src/base.js:132

Object containing references javascript events binding (for widget internal use).

__html

Object private

Inherited from photonui.Widget: src/widget.js:321

Object containing references to the widget HTML elements

absolutePosition

Object

Inherited from photonui.Widget: src/widget.js:275

Absolute position of the widget on the page. {x: Number, y: Number}

canvas

HTMLElement

Defined in src/visual/canvas.js:210

The Canvas HTML Element.

contextMenu

photonui.PopupWindow

Inherited from photonui.Widget: src/widget.js:223

The managed contextual menu.

Default: null (= no context menu)

contextMenuName

String

Inherited from photonui.Widget: src/widget.js:206

The name of the managed contextual menu (photonui.PopupWindow().name).

Default: null (= no context menu)

data

Object

Inherited from photonui.Base: src/base.js:113

Arbitrary data

Default: {}

height

Number default 150

Defined in src/visual/canvas.js:194

Canvas height.

html

HTMLElement

Inherited from photonui.Widget but overwritten in src/visual/canvas.js:221

Html outer element of the widget (if any).

Default: null

interactiveNode

HTMLElement

Defined in src/visual/canvas.js:233

The interactive HTML element (for event managers).

layoutOptions

Object

Inherited from photonui.Widget: src/widget.js:243

Layout options.

Default: {}

name

String

Inherited from photonui.Widget: src/widget.js:109

The unique name of the widget.

Default: "widget-" + uuid.v4()

offsetHeight

Number

Inherited from photonui.Widget: src/widget.js:305

Widget height (outer HTML element).

offsetWidth

Number

Inherited from photonui.Widget: src/widget.js:291

Widget width (outer HTML element).

parent

photonui.Widget

Inherited from photonui.Widget: src/widget.js:145

The parent widget.

Default: null (no parent)

parentName

String

Inherited from photonui.Widget: src/widget.js:131

The parent widget name.

Default: null (no parent)

tooltip

String

Inherited from photonui.Widget: src/widget.js:184

Tooltip.

Default: null

visible

Boolean

Inherited from photonui.Widget: src/widget.js:157

Is the widget visible or hidden.

Default: true

width

Number default 300

Defined in src/visual/canvas.js:178

Canvas width.