ZoomCharts Documentation

Version: 1.21.19 (2026-08-03)
Switch to Version 2.0 (BETA)

ZoomCharts.Configuration.LinearChartCommentPlacementInfo

Placement metadata included when {@link ICommentEditEventArguments.added} is true.

Methods

This type does not define any methods.

Properties

relativeX: number

Horizontal position relative to the data-point slot (0 = left, 1 = right; may be outside 0..1).

relativeY: number

Vertical position relative to the chart draw area (0 = top, 1 = bottom; may be outside 0..1).

seriesId: string

Nearest resolvable series config id under the pointer; null when no column series segment was found.

seriesRelativeX: number

Horizontal position relative to {@link seriesId} bounds (0 = left, 1 = right); null when series bounds are unavailable.

seriesRelativeY: number

Vertical position relative to {@link seriesId} bounds (0 = top, 1 = bottom); null when series bounds are unavailable.

Relative shape end; null when the placement has no shape.

Relative shape start; null when the placement has no shape.

suggestedIconMarkerAlign: "center" | "right" | "left"

Suggested non-relative icon alignment derived from the start point.

suggestedIconMarkerOffset: LinearChartSettingsCommentRelativePoint

Suggested relative marker offset. Set for canvas placement modes; null for basic data-point comments.

suggestedIconMarkerPosition: "default" | "top" | "bottom"

Suggested non-relative icon vertical position derived from the start point.

suggestedMarkerBasis: "item" | "series"

Whether the click is closer to the series segment or the item/chart slot. "item" when no series segment is available.

suggestedSeriesIconMarkerAlign: "center" | "right" | "left"

Suggested align when positioning relative to the nearest series. Null when series bounds are unavailable.

suggestedSeriesIconMarkerPosition: "default" | "top" | "bottom"

Suggested vertical position when positioning relative to the nearest series. Null when series bounds are unavailable.

suggestedShapeType: "rectangle" | "arrow" | "oval"

Shape type for oval/rectangle/arrow canvas modes; null otherwise.

type: "dataPoint" | "canvasText" | "canvasOval" | "canvasRectangle" | "canvasArrow"

Chart X coordinate of the placement start (click or drag start).

Chart Y coordinate of the placement start (click or drag start).

X