Skip to content

Charts docs: reconcile with Charts module 6.3.2 - #12041

Open
rahmanunver wants to merge 11 commits into
mendix:developmentfrom
rahmanunver:charts-overhaul
Open

rahmanunver wants to merge 11 commits into
mendix:developmentfrom
rahmanunver:charts-overhaul

Conversation

@rahmanunver

@rahmanunver rahmanunver commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Reconciles the Charts documentation with the current Charts module (v6.3.2, Studio Pro 10.6 and above). Builds on the earlier Charts PRs (Plotly how-to removal, configuration page updates, Any Chart deprecation).

Marketplace Guide (/appstore/widgets/charts/)

  • Charts overview restructured: chart types, common properties (the tabs of the Edit Series Item dialog box, General, Dimensions, Advanced), and the customization model. Documents Show playground slot instead of the removed developer mode, and Enable advanced options, which controls whether the Advanced tab properties are visible.
  • New reference page per chart type: area, bar, bubble, column, heat map, line, pie, and time series. Each lists only its type-specific properties.
  • New Chart Playground reference page (/appstore/widgets/chart-playground/).
  • Custom chart: full property reference (Dimensions, Events).
  • Fine-tuning and theme how-tos updated for the playground-slot workflow, Enable advanced options, and Enable theme folder config loading.
  • Tutorials (create, dynamic series, REST): series steps match the Studio Pro UI (New in the Series list, Edit Series Item dialog box tabs). Create a Basic Chart no longer uses a data view.
  • Legacy (below 3.0.0) section trimmed to a pointer to the legacy refguide page and the mendixlabs v1.4.4 cheat sheet.
  • Aliases for stale widget help URLs: /appstore/widgets/ChartPlayground/, /appstore/widgets/time-series-chart/.

Studio Pro Guide (refguide 11 and 10)

  • Charts overview: intro rewritten, links to the Custom chart and Chart Playground pages, and points to the Marketplace Guide for configuration. Sample chart images refreshed.
  • Chart Configuration: marked as legacy (below 3.0.0), with a description added.
  • Advanced cheat sheet, Any Chart configuration, and charting with view entities: added descriptions and image alt text, and updated old /howto/ links to the current URLs.

Notes for Reviewers

  • New Studio Pro 11 and runtime screenshots across the chart pages, with alt text. No {{% todo %}} markers remain.
  • Property captions, values, and defaults were checked against the widget XML in mendix/web-widgets.
  • hugo --environment development builds with 0 errors. Internal links, anchors, and images on all chart pages resolve.

@ConnorLand ConnorLand self-assigned this Oct 7, 2026
@rahmanunver
rahmanunver marked this pull request as ready for review October 8, 2026 10:19
@ConnorLand ConnorLand mentioned this pull request Oct 8, 2026
Replace all screenshot todo markers with Studio Pro 11 and runtime
captures, refresh verify-row images (chart pages and refguide 11/10
sample charts), and update alt text.

Document Enable advanced options: in 6.3.2 it hides the Advanced tab
properties, Custom series options, and heat map value options unless
set to Yes. Add the step to the fine-tuning, theme, and custom series
procedures.

Align wording with the Studio Pro UI: Edit Series Item dialog box,
New in the Series list, dialog tabs instead of sections, double-click
to open properties. Fix the REST data source sentence, restore the
XPath constraint note and pie required markers, drop a duplicate
Any Chart link in refguide10.
@ConnorLand

Copy link
Copy Markdown
Collaborator

Final tasks

Connor:

  • I'll check all the replaced screenshots to ensure they sync with the text around them.
  • I'll look at everything in a local build for a final visual check.

Rahman:

  • Going to make an LLM skill that can help docs take complicated screenshots by making page elements, running the app, and taking the screenshot per instructions (works both in a running app in the browser, or a running app in SP itself)

@ConnorLand

Copy link
Copy Markdown
Collaborator

Also fun thing: we can use this project Grand's team uses to more easily test/play around with configured widgets: https://github.com/mendix/Atlas-Design-System

People might have to ask for permission, but once you have access it's a full app that's exposed to you in SP. Very useful for testing page components.

If set to **Yes**, the chart shows a **Playground slot** in the page editor. Place a Chart playground widget in this slot to edit the chart's layout, configuration, and series settings live while the app runs. For more information, see [Fine-Tune a Chart with Chart Playground](/appstore/widgets/chart-advanced-tuning/).

#### Scale
{{< figure src="/attachments/appstore/platform-supported-content/widgets/charts/show-playground-slot.png" alt="Line chart in the page editor with a Chart playground widget in its Playground slot, shown as a Toggle Editor button" width="300px" class="no-border" >}}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't seem like it's showing a playground slot.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rahmanunver thoughts?


For the properties that all series-based charts share, such as the **Series** list, **Dimensions**, and **Advanced** settings, see [Common Chart Properties](/appstore/widgets/charts/#common-properties). This page describes the properties that are specific to the area chart.

## Edit Series Item Dialog Box – Appearance Tab

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this just be Appearance Tab? Once I validate I'll change this and other headers that say "edit series item dialog box".


The **X axis attribute** of a time series must be of the **Date and time** type.

## General Section

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are sections, not tabs right? Same question for Advanced below.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants