From fc0dfa3178deb6dc05edce5c96f4dc03af20015a Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 2 Aug 2026 00:12:57 +0000 Subject: [PATCH] docs: document KPI per-block styling/format and is empty/is not empty filter operators - KPI blocks (Number, Comparison, Progress bar, Sparkline, HTML) gained per-block background color, a neutral comparison color, and per-block value format on Progress bar and Sparkline (cubejs-enterprise #13162, #13113, #13540). - Dashboard filter widgets on string dimensions gained is empty / is not empty operators, distinct from the null checks (cubejs-enterprise #13456). Co-Authored-By: Claude Opus 5 --- .../docs/explore-analyze/charts/chart-types/kpi.mdx | 9 +++++++-- .../docs/explore-analyze/dashboards/widgets/controls.mdx | 4 +++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs-mintlify/docs/explore-analyze/charts/chart-types/kpi.mdx b/docs-mintlify/docs/explore-analyze/charts/chart-types/kpi.mdx index 36d0ad6f74e34..a1e736f627614 100644 --- a/docs-mintlify/docs/explore-analyze/charts/chart-types/kpi.mdx +++ b/docs-mintlify/docs/explore-analyze/charts/chart-types/kpi.mdx @@ -29,6 +29,7 @@ Displays a single value from your query result. | **Row** | Which row of the result to read from | | **Format** | Number formatting (currency, percent, etc.) | | **Font size / color** | Text appearance | +| **Background** | Background color for the block | | **Alignment** | Left, center, or right | {/* TODO screenshot: Number block (hidden — replace this comment with when image is ready) */} @@ -42,7 +43,7 @@ Displays a current value alongside a previous value with a calculated difference | **Current field / row** | The primary value | | **Previous field / row** | The value to compare against — can be a different column or a different row from the same column | | **Difference format** | Absolute, percentage, or both | -| **Positive color / Negative color** | Colors applied based on whether the change is positive or negative | +| **Positive / negative / neutral color** | Colors applied based on whether the change is positive, negative, or unchanged | To compare to a static goal, add a column to your query that always returns the same number (e.g. a calculated field with a constant), then select it as the **Previous** field. @@ -58,6 +59,8 @@ Shows a value relative to a target as a progress bar or circle. Useful for goal | **Target field / row** | The goal or maximum value | | **Style** | Bar or circle | | **Color** | Fill color for the progress indicator | +| **Format** | Number formatting for the displayed value | +| **Background** | Background color for the block | To compare against a static number like a quarterly goal, add a calculated field that always returns that number and use it as the **Target** field. @@ -77,6 +80,8 @@ Renders a compact trend chart — either a bar or line — within the KPI tile. | **Height / Width** | Dimensions of the sparkline in the tile | | **Max points** | Limits the number of data points rendered | | **Colors** | Line/fill colors | +| **Format** | Number formatting for the displayed value | +| **Background** | Background color for the block | {/* TODO screenshot: Sparkline block showing a trend line (hidden — replace this comment with when image is ready) */} @@ -90,7 +95,7 @@ Use text blocks for short labels and headings inside the KPI. For complex layout ### HTML -A free-form HTML block rendered inside the KPI tile. Use this for advanced custom layouts that go beyond what the other block types support. +A free-form HTML block rendered inside the KPI tile. Use this for advanced custom layouts that go beyond what the other block types support. Like the other block types, it accepts a background color. {/* TODO screenshot: HTML block with custom content (hidden — replace this comment with when image is ready) */} diff --git a/docs-mintlify/docs/explore-analyze/dashboards/widgets/controls.mdx b/docs-mintlify/docs/explore-analyze/dashboards/widgets/controls.mdx index f31e24d7109ba..5b628771892af 100644 --- a/docs-mintlify/docs/explore-analyze/dashboards/widgets/controls.mdx +++ b/docs-mintlify/docs/explore-analyze/dashboards/widgets/controls.mdx @@ -18,10 +18,12 @@ The available operators depend on the type of the underlying dimension: | Dimension type | Operators | |---|---| -| **String** | `is`, `is not`, `contains`, `not contains`, `starts with`, `not starts with`, `ends with`, `not ends with`, `is null`, `is not null` | +| **String** | `is`, `is not`, `contains`, `not contains`, `starts with`, `not starts with`, `ends with`, `not ends with`, `is null`, `is not null`, `is empty`, `is not empty` | | **Number** | `is`, `is not`, `greater than`, `greater than or equal`, `less than`, `less than or equal`, `is null`, `is not null` | | **Time** | `is`, `is not`, `before date`, `before or on date`, `after date`, `after or on date`, `between`, `relative date`, `is null`, `is not null` | +`is empty` and `is not empty` test for an empty string and are distinct from `is null` / `is not null`, which test for a missing value. + ### Single vs. multiple selection Filters can allow either a single value or multiple values. Configure this when adding or editing the filter — multi-select is the default for string dimensions, while time and number dimensions default to a single value.