API Reference
Namespaces
Classes
Events
Global
Externals

Class: SeriesEdit

CIQ.UI. SeriesEdit ( [node], context)


new SeriesEdit( [node], context)

UI Helper for managing series context menus and edit dialogs.

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

Works with the cq-series-context and cq-series-edit-dialog web components to provide right-click context menus and edit dialogs for all series types (comparison, reference data, etc.).

Follows the same pattern as CIQ.UI.StudyEdit for studies.

Parameters:
Name Type Argument Description
node HTMLElement <optional>

The HTML element that surrounds the context menu.

context CIQ.UI.Context

The context for the chart

Since:
  • 10.3.0

Methods


edit( [input])

Proxy for editing a series.

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 series have already been set.

Parameters:
Name Type Argument Description
input object <optional>

Input object containing parameters

Properties
Name Type Argument Description
params object <optional>

Parameters object

Properties
Name Type Argument Description
parent HTMLElement <optional>

Parent node of activator

Since:
  • 10.3.0


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

Since:
  • 10.3.0


openContextMenu(params)

Displays the Edit Settings, Delete context dialog for series 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 including stx, series, context, x, y

Since:
  • 10.3.0


openDialog(params)

Opens the series 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.

Parameters:
Name Type Description
params object

Parameters from the series right-click event

Since:
  • 10.3.0


remove( [input])

Proxy for removing a series.

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

To observe series removal, use the native symbolChange event listener:

Parameters:
Name Type Argument Description
input object <optional>

Input object containing parameters

Properties
Name Type Argument Description
params object <optional>

Parameters object

Properties
Name Type Argument Description
parent HTMLElement <optional>

Parent node of activator

Since:
  • 10.3.0

Example
stxx.addEventListener("symbolChange", (e) => {
  if (e.action === "remove-series") {
    console.log("Series removed:", e.id, e.symbol);
  }
});