MarkRect · Traits · OODS Foundry

Fields it adds

This trait adds no fields.

What it shows in each context

form: VizHeatmapControls
detail: VizHeatmapPreview

Parameters

chart object: Optional read-only chart declaration binding existing domain fields; projects into supported detail and dashboard views.
title string: Title for the bound chart and its accessible figure.
description string: Description of the bound chart measurements and units.
renderIntent string: JSON-encoded Cartesian viz.render input fragment; data rows are supplied by the consumer.
previewSvg string: Static SVG returned by viz.render for the authored sample.

Objects that use it

No shipped object uses this trait.

The trait file

traits/viz/mark-rect.trait.yaml

{
  "trait": {
    "name": "MarkRect",
    "version": "0.1.0",
    "description": "Heatmap authoring over the existing MarkRect renderer",
    "category": "viz.mark",
    "tags": [
      "viz",
      "authoring"
    ]
  },
  "parameters": [
    {
      "name": "chart",
      "type": "object",
      "required": false,
      "description": "Optional read-only chart declaration binding existing domain fields; projects into supported detail and dashboard views."
    },
    {
      "name": "title",
      "type": "string",
      "required": false,
      "description": "Title for the bound chart and its accessible figure."
    },
    {
      "name": "description",
      "type": "string",
      "required": false,
      "description": "Description of the bound chart measurements and units."
    },
    {
      "name": "renderIntent",
      "type": "string",
      "required": false,
      "default": "{}",
      "description": "JSON-encoded Cartesian viz.render input fragment; data rows are supplied by the consumer."
    },
    {
      "name": "previewSvg",
      "type": "string",
      "required": false,
      "description": "Static SVG returned by viz.render for the authored sample."
    }
  ],
  "schema": {},
  "semantics": {},
  "view_extensions": {
    "form": [
      {
        "component": "VizHeatmapControls",
        "position": "top",
        "props": {
          "intentParameter": "renderIntent"
        }
      }
    ],
    "detail": [
      {
        "component": "VizHeatmapPreview",
        "position": "top",
        "props": {
          "svgParameter": "previewSvg"
        }
      }
    ]
  },
  "tokens": {},
  "metadata": {
    "regionsUsed": [
      "form",
      "detail"
    ]
  }
}