Chart Type

Schema $id

https://openpresentation.org/schema/opf-chart-type/v1

Type

object

Source

spec/schemas/chart-type.schema.json

Fields

22 · 4 required

Field index

$schema

typeconstrequiredyesdefault—

Identifies this record as a chart type in the open presentation catalog.

{
  "$schema": "https://openpresentation.org/schema/opf-chart-type/v1"
}

id

typestringrequiredyesdefault—pattern^[a-z0-9][a-z0-9-]*$

Stable slug used by OPF documents to reference this chart type. Lowercase kebab-case. Chart type ids may start with a digit (e.g., '100pct-stacked-column', '3d-column') to mirror conventional chart naming.

{
  "id": "column"
}

name

typestringrequiredyesdefault—

Stable display/programmatic name for this chart type.

{
  "name": "COLUMN"
}

label

typestringrequirednodefault—

Human-readable label shown in chart pickers.

{
  "label": "Column"
}

summary

typestringrequirednodefault—

One-sentence positioning: when to reach for this chart variant.

{
  "summary": "Single-series vertical column chart for comparing values across categories."
}

description

typestringrequirednodefault—

Longer prose describing the chart and ideal use cases.

{
  "description": "Use a clustered column when you want to compare a small number of series across the same categories — e.g., revenue by quarter for two product lines. Best with 2–4 series and ≤12 categories."
}

mappings

typeref:ChartTypeMappingsrequiredyesdefault—

Canonical and optional renderer-specific mappings used by engines to render this chart type.

{
  "mappings": "mappings-value"
}

group

typestringrequirednodefault—

Top-level grouping in the chart picker (column, bar, line, area, pie, radar, etc.).

{
  "group": "Column"
}

groupSort

typeintegerrequirednodefault—

Display ordering hint within the chart group.

{
  "groupSort": 1
}

complexity

typeenumrequirednodefault—

Shape of the underlying data: a flat series ('simple'), one with engine-side calculation ('calculated'), parent-child rows ('hierarchical'), or pre-normalized rows ('normalized').

{
  "complexity": "simple"
}

series

typeintegerrequirednodefault—

Number of data series this chart type expects.

{
  "series": 1
}

categories

typeintegerrequirednodefault—

Number of category labels this chart type expects on the primary axis.

{
  "categories": 4
}

seriesGroups

typeintegerrequirednodefault—

Number of series groups (axis bands) this chart type uses; >1 for combo or banded charts.

{
  "seriesGroups": 1
}

useSecondaryCategories

typebooleanrequirednodefault—

Whether the chart type uses a secondary category axis.

{
  "useSecondaryCategories": false
}

workbookRange

typestringrequirednodefault—

A1 reference to the source range in the embedded workbook.

{
  "workbookRange": "Sheet1!$A$1:$I$2"
}

columns

typearray<string>requirednodefault—

Column header names of the embedded workbook, in left-to-right order.

{
  "columns": [
    "Series 1",
    "Value"
  ]
}

dataColumns

typearray<ref:ChartDataColumn>requirednodefault—

Per-column metadata describing the role and position of each column in the workbook source.

{
  "dataColumns": [
    {
      "name": "Series 1",
      "role": "categoryLabel",
      "type": "string",
      "position": "row0_col0"
    },
    {
      "name": "Value 1",
      "role": "series",
      "type": "number",
      "position": "row1_col0"
    },
    {
      "name": "Value 2",
      "role": "series",
      "type": "number",
      "position": "row2_col0"
    }
  ]
}

helperColumns

typearray<string>requirednodefault—

Optional auxiliary column names used by calculated or banded charts (e.g., 'Excellent', 'Good', 'Fair', 'Poor' for a bullet chart).

{
  "helperColumns": [
    "Excellent",
    "Good",
    "Fair",
    "Poor"
  ]
}

sampleData

typeref:ChartSampleDatarequirednodefault—

Inline sample dataset for previews and pickers.

{
  "sampleData": {
    "headers": [
      "Series 1",
      "Q1 2024",
      "Q2 2024",
      "Q3 2024",
      "Q4 2024"
    ],
    "rows": [
      [
        "Value",
        93810,
        24592,
        13278,
        46048
      ]
    ]
  }
}

slideNumber

typeintegerrequirednodefault—

Source slide number in the original chart-gallery deck. Carried for traceability.

{
  "slideNumber": 1
}

tags

typearray<string>requirednodefault—

Free-form labels for filtering and search.

{
  "tags": [
    "column",
    "comparison"
  ]
}

preview

typeobjectrequirednodefault—

Visual previews of the record, used by picker UIs and inline rendering. All sub-fields are optional; engines fall back gracefully when previews aren't available.

{
  "preview": {}
}