@grafana/viz-contract 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -50,6 +50,7 @@ flowchart TB
50
50
  | Viz spec | The JSON object that the App gives to the Renderer |
51
51
  | Icon cache | The `react-inlinesvg` cache of the copy of `@grafana/ui` in the App. `Icon` reads an SVG from it, and makes no request for that SVG |
52
52
  | Note | A text line that the Source gives to `render_grafana_app`, and that the model reads in the same turn (`tool.28`). Not a notice: the Renderer shows a notice in the chart (`state.7`) |
53
+ | Legend overrides | The `fieldConfig` overrides that the user makes with the legend: hide, show and color an item. Only the Renderer keeps them (`renderer.37`) |
53
54
 
54
55
  The Renderer draws the panels of the package `@plugins/grafana-echarts`.
55
56
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@grafana/viz-contract",
3
- "version": "1.6.0",
3
+ "version": "1.7.0",
4
4
  "description": "Contract between a Grafana query source, the host that shows the chart, and the Renderer",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
package/renderer-api.d.ts CHANGED
@@ -32,7 +32,7 @@ export interface RenderOptions {
32
32
  }
33
33
 
34
34
  export interface RenderHandle {
35
- /** Draws a new viz spec in the same element. */
35
+ /** Draws a new viz spec in the same element. It keeps the legend overrides of the user (renderer.35). */
36
36
  update(spec: unknown): void;
37
37
  /**
38
38
  * Gives the result of the refresh with this id. id is the id of the RefreshRequest. With ok false, error is the