Class: StudyEdit

CIQ.UI. StudyEdit


new StudyEdit( [node], context)

UI Helper for managing study interaction, editing, deleting etc.

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

Requires the StudyDialog web component

It sets up CIQ.ChartEngine.callbacks#studyOverlayEdit and CIQ.ChartEngine.callbacks#studyPanelEdit callbacks in order to display a dialog for editing study parameters and a context menu for editing or deleting overlays.

Parameters:
Name Type Argument Default Description
node HTMLElement <optional>
context.topNode

Automatically attaches to the top node of the context

context CIQ.UI.Context

The context for the chart

Since:
  • 4.1.0 contextDialog is no longer passed in.

Methods


edit()

Proxy for editing a study.

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

Assumes the params for the study have already been set.


editOverlay(params)

Displays the Edit Settings, Delete Study context dialog for overlay studies and prepares the parameters for editing. 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

Parameters from studyOverlayEdit callback


editPanel(params)

Finds the StudyDialog web component and proxies the parameters over to it.

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

Parameters from studyPanelEdit callback


initialize()

Creates the callbacks for self and the context.

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


remove()

Closes Study Edit dialog.

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