ZoomCharts Documentation

Version: 1.21.20 (2026-09-08)
Switch to Version 2.0 (BETA)

FacetChart.settings.seriesDefault.style.comment

This section is defined by the type LinearChartSettingsComment.

Properties

View section details

Optional background around this comment in the comments panel.

View section details

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

View section details

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.

View section details

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"
Default value: "center"
iconMarkerAlignSeriesId: string
Default value: null

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).

View section details

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"
Default value: "default"
iconMarkerPositionSeriesId: string
Default value: null

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).

View section details

Optional style applied on top of {@link iconStyle} when drawing the comment marker inside the chart. The sidebar icon ignores this. When selected, merge order for chart markers is {@link iconStyle} → this → {@link iconStyleSelected} → {@link iconStyleChartSelected}.

iconStyleChartSelected: LinearChartSettingsCommentLabelStyle
View section details

Optional style applied on top of {@link iconStyleSelected} when drawing the selected comment marker inside the chart. The sidebar icon ignores this (e.g. drop shadow on chart selection only).

View section details

Additional style applied on top of {@link iconStyle} when the comment is selected, for both the sidebar icon and the in-chart marker. Use this for shared selection changes (e.g. fill color). Chart-only selection extras belong in {@link iconStyleChartSelected}.

iconText: string
Default value: null
id: string
Default value: null

Stable application-defined identifier used by comment edit events.

rangeItemCount: number
Default value: null

Inclusive item count for a range comment (>= 2). Null / omitted / 1 means a normal single-item comment. The comment remains associated with the leftmost item; this count extends the range to the right.

secondaryText: string
Default value: null

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

View section details

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

swapSecondary: boolean
Default value: false

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
Default value: null
X