ZoomCharts Documentation

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

ZoomCharts.Configuration.LinearChartSettingsComment

Methods

This type does not define any methods.

Properties

Optional background around this comment in the comments panel.

extraLabelGroupStyle: BaseSettingsLabelGroupStyle

Optional group-level margin/padding for the {@link extraLabels} LabelGroup.

Style used for spacing between {@link extraLabels} (text ignored; uses a non-breaking space). When unset, spacing is derived from the first {@link extraLabels} entry.

Optional multi-style labels drawn as a LabelGroup in the side panel, on their own row below the icon/companion row and above the below-label row (secondary, or primary when {@link swapSecondary}).

iconMarkerAlign: "center" | "right" | "left"
iconMarkerAlignSeriesId: string

When set (and {@link iconMarkerOffset} is unset), {@link iconMarkerAlign} is applied to this series' drawn X bounds instead of the item slot. Use the series config id (SettingsSeries.id).

Relative icon position. x is within the column slot (like left/right align) and y is within the chart draw area (like top/bottom). If set, this overrides iconMarkerAlign, iconMarkerPosition, and the series id fields.

iconMarkerPosition: "default" | "top" | "bottom"
iconMarkerPositionSeriesId: string

When set (and {@link iconMarkerOffset} is unset), {@link iconMarkerPosition} is applied to this series' Y bounds instead of the chart draw area. Use the series config id (SettingsSeries.id).

iconStyleSelected: BaseSettingsLabelStyle

Additional style applied on top of {@link iconStyle} when drawing the comment marker inside the chart while selected. The sidebar icon always uses {@link iconStyle}.

iconText: string
id: string

Stable application-defined identifier used by comment edit events.

secondaryLabelStyle: BaseSettingsLabelStyle
secondaryText: string

Optional secondary label shown in the comments panel on a new line below the icon and primary text.

Optional shape drawn in the chart area using relative start/end points.

swapSecondary: boolean

When true, the primary and secondary labels swap vertical positions in the comments panel (secondary appears on the icon row; primary appears on the line below).

text: string
X