API Reference
Namespaces
Classes
Events
Global
Externals

Class: Helper

CIQ.UI. Helper


new Helper(node, context)

Abstract class for UI Helpers.

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the web components can be found here: Web Component Interface

Parameters:
Name Type Description
node HTMLElement

DOM node.

context CIQ.UI.Context

UIContext the helper is associated with

Methods


addInjection(position, injection, code)

Adds an injection. These will be automatically destroyed if the helper object is destroyed.

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the web components can be found here: Web Component Interface

Parameters:
Name Type Description
position String

"prepend" or "append"

injection String

The injection name. i.e. "draw"

code function

The code to be run


addObserver(params)

Adds listener as an observer and saves it in the list allowing it to reconnect to a different observable.

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the web components can be found here: Web Component Interface

Parameters:
Name Type Description
params object

Object holding parameter properties

Properties
Name Type Description
base object

Observable object

path string

Path to the property to observe

listener function

The function to invoke when the property changes

Since:
  • 8.4.0


changeContext(newContext)

Changes helper context updates references and listeners

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the web components can be found here: Web Component Interface

Parameters:
Name Type Description
newContext object

The new context for the helper

Since:
  • 8.4.0


destroy()

Removes injections from the ChartEngine and helper created observers

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the web components can be found here: Web Component Interface