new StudyEdit( [node], context)
UI Helper for managing study interaction, editing, deleting, and so forth.
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 cq-study-dialog web component.
Sets up a studyOverlayEditEventListener to display a context menu for editing or deleting overlays and a studyPanelEditEventListener to display a dialog for editing study parameters.
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 The
contextDialog
parameter is no longer passed in.
Methods
-
addToFavorites(activator)
-
Proxy for adding the study to favorites.
Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize web components can be found at Web Component Interface.
Assumes the params for the study have already been set.
Parameters:
Name Type Description activator
Object Properties
Name Type Description params
Object Properties
Name Type Description parent
HTMLElement Parent node of activator
- Since:
-
8.8.0
-
edit(activator)
-
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.
Parameters:
Name Type Description activator
Object Properties
Name Type Description params
Object Properties
Name Type Description parent
HTMLElement Parent node of activator
-
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 the studyOverlayEditEventListener.
-
editPanel(params)
-
Finds the cq-study-dialog 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 the studyPanelEditEventListener.
-
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(activator)
-
Proxy for removing 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
Parameters:
Name Type Description activator
Object Properties
Name Type Description params
Object Properties
Name Type Description parent
HTMLElement Parent node of activator