API Docs for: 1.7.0
Show:

photonui.ColorPicker Class

Extends photonui.Widget
Defined in: src/interactive/colorpicker.js:44
Module: Interactive
Parent Module: PhotonUI

A Color Picker.

wEvents:

  • value-changed:
    • description: the selected color changed.
    • callback: function(widget, color)

Constructor

photonui.ColorPicker

(
  • params
)

Defined in src/interactive/colorpicker.js:44

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:

__onDragEnd

(
  • manager
  • mstate
)
private

Defined in src/interactive/colorpicker.js:493

Parameters:

__onDraggingCircle

(
  • manager
  • mstate
)
private

Defined in src/interactive/colorpicker.js:482

Parameters:

__onDraggingSquare

(
  • manager
  • mstate
)
private

Defined in src/interactive/colorpicker.js:470

Parameters:

__onDragStart

(
  • manager
  • mstate
)
private

Defined in src/interactive/colorpicker.js:453

Parameters:

__onLocaleChanged

() private

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

Called when the locale is changed.

__onMouseDown

(
  • manager
  • mstate
)
private

Defined in src/interactive/colorpicker.js:434

Parameters:

__onMouseMove

(
  • manager
  • mstate
)
private

Defined in src/interactive/colorpicker.js:420

Parameters:

__onValueChanged

() private

Defined in src/interactive/colorpicker.js:505

_bindEvent

(
  • id
  • element
  • evName
  • callback
)
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.

_buildHtml

() private

Inherited from photonui.Widget but overwritten in src/interactive/colorpicker.js:201

Build the widget HTML.

_callCallbacks

(
  • wEvent
  • params
)
private

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

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.

_pointerAngle

(
  • mstate
)
Number private

Defined in src/interactive/colorpicker.js:392

the angle of the pointer with the horizontal line that pass by the center of the hue circle.

Parameters:

Returns:

Number:

the angle in degree.

_pointerOnCircle

(
  • mstate
)
Boolean private

Defined in src/interactive/colorpicker.js:377

Is the pointer on the hue circle?

Parameters:

Returns:

Boolean:

_pointerOnSquare

(
  • mstate
)
Boolean private

Defined in src/interactive/colorpicker.js:365

Is the pointer on the SB Square?

Parameters:

Returns:

Boolean:

_registerWEvents

(
  • wEvents
)
private

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

Register available wEvent.

Parameters:

_unbindEvent

(
  • id
)
private

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

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_updateCanvas

() private

Defined in src/interactive/colorpicker.js:325

Update the canvas

_updateH

() private

Defined in src/interactive/colorpicker.js:227

Update hue circle

_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.

_updateSB

() private

Defined in src/interactive/colorpicker.js:290

Update saturation/brightness square

_updateSBmask

() private

Defined in src/interactive/colorpicker.js:256

Update saturation/brightness square mask

_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.

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.

show

()

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

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

unparent

()

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

Detache the widget from its parent.

Properties

__buffH

HTMLCanvasElement private

Defined in src/interactive/colorpicker.js:154

Buffer canvas for hue circle.

__buffSB

HTMLCanvasElement private

Defined in src/interactive/colorpicker.js:163

Buffer canvas for saturation/brightness square.

__callbacks

Object private

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

Object containing references to registered callbacks.

__disableSBUpdate

Boolean private

Defined in src/interactive/colorpicker.js:181

FLAG: Disable SB square update.

Default: false

__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

__mouseManager

photonui.MouseManager private

Defined in src/interactive/colorpicker.js:172

Mouse manager.

absolutePosition

Object

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

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

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: {}

html

HTMLElement

Inherited from photonui.Widget but overwritten in src/interactive/colorpicker.js:140

Html outer element of the widget (if any).

Default: null

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

value

String

Defined in src/interactive/colorpicker.js:95

The value (color in rgb hexadecimal format (e.g. "#ff0000")).

visible

Boolean

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

Is the widget visible or hidden.

Default: true