Class: Group

The chart engine.

The shared groupKey value for markers associated with this group

A valid date, tick, or bar (depending on the selected xPositioner) used to select a candle to which the marker is associated.

A valid value for positioning the marker on the y-axis (depending on selected yPositioner). If this value is not provided, the marker is set "above_candle" as long as a valid candle is selected by params.x.

The HTML element that contains the marker. This element should be detached from the DOM. If an element is not provided, an empty div is created. You can create your own or use the provided CIQ.Marker.Simple and CIQ.Marker.Performance node creators.

The name of the panel to which the node is attached. Defaults to the main chart panel.

Determines the x-axis position of the marker. Values include:

• "date" — params.x must be set to a JavaScript date object. This will be converted to the closest masterData position if the provided date does not exactly match any existing points. Be sure the same timezone as masterData is used.
• "master" — params.x must be set to a masterData position.
• "tick" — params.x must be set to a dataSet position.
• "bar" — params.x must be set to a dataSegment position.
• "none" — Use CSS positioning; params.x is not used.

Determines the y-axis position of the marker. Values include:

• "value" — params.y must be set to an exact y-axis value. If params.y is omitted, the y-axis position defaults to "above_candle".
• "above_candle" — Positions the marker right above the candle or line. If more than one marker is at the same position, the markers are aligned upwards from the first. The params.y value is not used.
• "below_candle" — Positions the marker right below the candle or line. If more than one marker is at the same position, the markers are aligned downwards from the first. The params.y value is not used.
• "on_candle" — Position the marker in the center of the candle or line, covering it. If more than one marker is at the same position, the markers are aligned downwards from the first. The params.y value is not used.
• "top" — Position the marker at the top of the chart, right below the margin. If more than one marker is at the same position, the markers are aligned downwards from the first. The params.y value is not used.
• "top_lane" — Same as "top", but each marker type (defined by label) gets its own row, or lane.
• "bottom" — Position the marker at the bottom of the chart, right above the margin. If more than one marker is at the same position, the markers are aligned upwards from the first. The params.y value is not used.
• "bottom_lane" — Same as "bottom", but each marker type (defined by label) gets its own row, or lane.
• "none" — Use CSS positioning; params.y is not used.

When yPositioner is set to position relative to a candle, this parameter determined which field in the dataSet to use for the candle. When not specified, uses available HLC data.

Set to true to disable the marker's default click handler.