ZoomCharts Documentation
Switch to Version 2.0 (BETA)
FacetChart.settings.comments
Properties
When enabled, a tooltip is shown for every visible comment marker, anchored beside the marker per {@link markerTooltipPosition}. When disabled, a tooltip appears only while hovering a marker and follows the mouse cursor (still respecting {@link markerTooltipPosition}).
When {@link experience} is "annotations", enables the built-in
TimeChart comment catalog (add/edit/delete + panel/paint wiring)
unless the app supplies its own {@link panelItemsFunction} /
{@link panelCountFunction} persistence. Set to false to disable.
Ignored for legacy experience. Default true under annotations.
When true (default), comment markers and shapes are drawn in the chart area. When false, they are hidden in the chart but still listed in the side panel when it is open.
View section details
Optional default panel-card chrome ({@link SettingsComment.background} style fill/line) applied by the annotations experience when styling comments. Dark theme sets a light wash (white ~2% fill / ~15% outline).
View section details
Optional default style for category (full-item) comment shapes in the annotations experience. Dark theme sets a light wash (white ~4% fill / ~20% dashed outline).
When set, non-arrow shapes created from placement use this opacity
for {@link SettingsCommentShape.style.fillColor} (same RGB as the
shape default). Annotations accent themes also honor this for
oval/rectangle fills. Dark theme sets 0.2.
Fallback fill color for new comments / the editor when a comment has no {@link SettingsComment.labelStyle} text fillColor. Dark themes override this to a light color so draft text stays readable.
Optional app callback that returns a short placement summary shown
under the add-comment dialog titlebar (above the editor toolbar).
Return null or an empty string to hide the row. Edit mode never
shows this line. Canvas adds typically return null.
Parameters
Return value
Product experience for comments.
legacy(default / unset): existing read-only-friendly defaults (waterfall-style: editing off, titlebar/levels off, panel shows visible comments).annotations: opt-in pack that enables editing, titlebar, levels,allAtLevelpanel contents, annotation localization, and (for TimeChart) built-in storage / appearance callbacks when unset.
How chart comment markers resolve overlaps with each other.
default: bottom markers usemoveup, top markers usemovedown, and markers with {@link SettingsComment.iconMarkerOffset} keep an exact position (none).none: markers always draw at their layout position (may overlap).
Preferred side for comment marker tooltips. Falls back to the opposite side when the preferred side does not fit in the chart area.
top(default): above the marker, else belowbottom: below the marker, else aboveleft: left of the marker, else rightright: right of the marker, else left
Controls which comments appear in the side panel.
visible(default): comments whose marker center, shape endpoint, or (when there is no marker) data-item bounds intersect the chart.allLoaded: every comment from data currently loaded at this level.allAtLevel: every comment for the current aggregation/drilldown level, supplied by {@link panelItemsFunction} (not limited to currently loaded chart data). Falls back toallLoadedwhen the function is missing or returns null/undefined.
Optional app-provided value for the panel titlebar / toolbar comment
counter. Intended for a global (or as-global-as-possible) total:
especially with {@link panelContents} === "allAtLevel", return the
size of the full multi-level catalog. When unset or when the function
returns null/undefined, counters fall back to the current panel list
length (the closest honest figure for the active mode).
Parameters
Return value
App-provided source of side-panel comments for
{@link panelContents} === "allAtLevel". Should return every comment
that belongs to the current aggregation/drilldown level. Chart markers
are unaffected and still come only from loaded data.
Parameters
Return value
View section details
Optional "Comments by Level" band below the titlebar (when both are enabled). Lists dataset levels plus an All pseudo-level for navigating and aggregating comments across levels.
When true (default), the comments side panel starts open and claims its configured width from the chart area. When false, it starts closed (zero width). Toggled at runtime via the comments toolbar dropdown or {@link ChartComments.setPanelOpen}.
Duration in seconds for animating the panel open/close width change
({@link FixedDurationLinearAnimation}). The chart area reflows with
the animated width. Use 0 for an instant snap.
View section details
Optional fixed titlebar above the scrollable comment list (icon, title, optional total count, separator). Disabled by default.
View section details
Derivation parameters for the dismissible top-of-chart placement guidance pill (colors are derived from the placement icon accent).
Optional app callback that builds a {@link SettingsComment} used only for the live placement preview (ghost marker while adding a data-point or canvas comment). Must not persist comments or advance id counters.
When unset, data-point mode keeps the range band on drag and no mode draws an icon preview.
Parameters
Return value
Opacity multiplier applied when painting
{@link placementPreviewComment} (relative to the current canvas
alpha). Default 0.5.
View section details
Per-item icon colors for the comments toolbar dropdown menu. Icons render with {@code currentColor}; these values are applied to the icon wrapper at build time.
When true (default), the comments toolbar dropdown shows the same resolved comment total as the panel titlebar counter ({@link panelCountFunction} or panel list length) instead of the localized {@link SettingsLocalizationToolbar.commentsEditButton} label. The button title/tooltip remains the add-comment string.