{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://casoon.github.io/chartlet/schema/v1.json",
"title": "chartlet v1 specification",
"type": "object",
"additionalProperties": false,
"required": ["schemaVersion", "type", "title"],
"properties": {
"schemaVersion": { "const": 1 },
"type": {
"enum": ["bar", "line", "time", "stripes", "calendar", "rangebar", "multiples", "sequence", "flow", "state", "architecture", "tree", "boxplot", "timeline", "waterfall", "waffle", "parliament", "treemap", "sankey", "survival", "scatter", "classes", "network"]
},
"orientation": { "enum": ["vertical", "horizontal"], "default": "vertical" },
"title": { "type": "string", "minLength": 1, "maxLength": 200 },
"description": { "type": "string", "minLength": 1, "maxLength": 1000 },
"source": { "type": "string", "minLength": 1, "maxLength": 300 },
"theme": { "enum": ["light", "dark", "blueprint"], "default": "light" },
"tokens": { "$ref": "#/$defs/tokens" },
"locale": {
"description": "Language of the texts chartlet generates (description, legend additions, tooltips, HTML figure and table) and of the number format.",
"enum": ["en", "de"],
"default": "en"
},
"categoryAxis": { "$ref": "#/$defs/categoryAxis" },
"valueAxis": { "$ref": "#/$defs/valueAxis" },
"timeAxis": { "$ref": "#/$defs/timeAxis" },
"panes": {
"description": "Time charts are drawn from 1 to 4 panes stacked on one time axis, small multiples from 2 to 12 titled panes.",
"type": "array",
"minItems": 1,
"maxItems": 12,
"items": { "$ref": "#/$defs/pane" }
},
"columns": {
"description": "Grid columns of a type: \"multiples\" chart; defaults to up to three.",
"type": "integer",
"minimum": 1,
"maximum": 6
},
"stripes": {
"description": "The yearly values of a type: \"stripes\" chart.",
"$ref": "#/$defs/stripes"
},
"calendar": {
"description": "The daily values of a type: \"calendar\" chart.",
"$ref": "#/$defs/calendar"
},
"sparkline": {
"description": "type: \"time\" only: draw only the lines and areas of one pane, without axes, title or legend, at 60–600 × 16–200 pixels.",
"type": "boolean",
"default": false
},
"tooltips": {
"description": "type: \"time\" only: \"observations\" (default) gives every observation a tooltip while observations stand at least 4 pixels apart, on an invisible target where no marker is drawn; \"markers\" gives tooltips only to drawn markers, which keeps dense lines small.",
"enum": ["observations", "markers"],
"default": "observations"
},
"legend": {
"description": "type: \"time\" only: top (default) names the series in a legend above the plot; end names each line at its last observation, right of the plot.",
"enum": ["top", "end"],
"default": "top"
},
"independentAxes": {
"description": "type: \"multiples\" only: every panel gets its own value axis instead of one shared one.",
"type": "boolean",
"default": false
},
"boxDisplay": {
"description": "type: \"boxplot\": how the observations are drawn: boxes with whiskers (the default), violins (the estimated density with the box inside) or strips (every observation as a point). Violins and strips need `values` on every box.",
"enum": ["box", "violin", "strip"],
"default": "box"
},
"violinScale": {
"description": "type: \"boxplot\" with boxDisplay violin: width (default) makes every violin as wide as the others at its widest, area gives them the same area, count an area that follows their number of observations.",
"enum": ["width", "area", "count"],
"default": "width"
},
"showMean": {
"description": "type: \"boxplot\": mark the mean of the observations of every box with a diamond and add a Mean column to the table. Needs `values` on every box.",
"type": "boolean",
"default": false
},
"patterns": {
"description": "type: \"bar\" with series: draw every other series as an outline, so that series differ in form as well as in color.",
"type": "boolean",
"default": false
},
"stack": {
"description": "Stacks the series of a type: \"bar\" chart: \"normal\" by value, \"percent\" as shares of each category's total.",
"enum": ["normal", "percent"]
},
"references": {
"description": "Reference lines across a type: \"bar\" or \"rangebar\" chart, such as an average, a target or the line of no effect.",
"type": "array",
"maxItems": 4,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["value", "label"],
"properties": {
"value": { "type": "number" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 }
}
}
},
"ranges": {
"description": "The spans of a type: \"rangebar\" chart, one per category.",
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": { "$ref": "#/$defs/range" }
},
"classes": {
"description": "The classes of a type: \"classes\" chart.",
"$ref": "#/$defs/classes"
},
"network": {
"description": "The nodes and edges of a type: \"network\" chart.",
"$ref": "#/$defs/network"
},
"scatter": {
"description": "The points of a type: \"scatter\" chart.",
"$ref": "#/$defs/scatter"
},
"survival": {
"description": "The groups of a type: \"survival\" chart.",
"$ref": "#/$defs/survival"
},
"sankey": {
"description": "The links of a type: \"sankey\" chart.",
"$ref": "#/$defs/sankey"
},
"treemap": {
"description": "The items of a type: \"treemap\" chart.",
"$ref": "#/$defs/treemap"
},
"parliament": {
"description": "The parties of a type: \"parliament\" chart.",
"$ref": "#/$defs/parliament"
},
"waffle": {
"description": "The parts of a type: \"waffle\" chart.",
"$ref": "#/$defs/waffle"
},
"waterfall": {
"description": "The steps of a type: \"waterfall\" chart.",
"$ref": "#/$defs/waterfall"
},
"timeline": {
"description": "The items and markers of a type: \"timeline\" chart.",
"$ref": "#/$defs/timeline"
},
"boxes": {
"description": "The boxes of a type: \"boxplot\" chart, one per category: observations (values) from which the box is computed, or the five numbers of a box computed elsewhere.",
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 200 },
"group": { "type": "string", "minLength": 1, "maxLength": 60, "description": "Boxes of one group share a palette color and a legend entry: on every box or none, at most four groups." },
"values": { "description": "5 to 1000 observations. The box runs from the first to the third quartile (linear interpolation), the whiskers to the most extreme observations within 1.5 times that distance, every other observation is a point.", "type": "array", "minItems": 5, "maxItems": 1000, "items": { "type": "number" } },
"min": { "type": "number" },
"q1": { "type": "number" },
"median": { "type": "number" },
"q3": { "type": "number" },
"max": { "type": "number" },
"outliers": { "description": "Points beyond the whiskers of a box given by its five numbers.", "type": "array", "items": { "type": "number" } }
}
}
},
"sequence": {
"description": "The participants and messages of a type: \"sequence\" diagram.",
"$ref": "#/$defs/sequence"
},
"flow": {
"description": "The steps and edges of a type: \"flow\" chart.",
"$ref": "#/$defs/flow"
},
"state": {
"description": "The states and transitions of a type: \"state\" diagram.",
"$ref": "#/$defs/state"
},
"architecture": {
"description": "The components, connections and boundaries of a type: \"architecture\" diagram.",
"$ref": "#/$defs/architecture"
},
"tree": {
"description": "The nodes of a type: \"tree\" diagram.",
"$ref": "#/$defs/tree"
},
"width": { "type": "integer", "minimum": 200, "maximum": 2400, "default": 800 },
"height": { "type": "integer", "minimum": 160, "maximum": 1600, "default": 450 },
"mobile": {
"description": "A second layout for narrow containers. The HTML profile shows it below the breakpoint by a container query; the SVG profile renders it with the variant option.",
"type": "object",
"additionalProperties": false,
"required": ["width"],
"properties": {
"width": { "type": "integer", "minimum": 200, "maximum": 600 },
"height": { "type": "integer", "minimum": 160, "maximum": 1600, "default": 360 },
"breakpoint": {
"description": "Container width in CSS pixels below which the mobile variant is shown.",
"type": "integer",
"minimum": 320,
"maximum": 1600,
"default": 640
},
"columns": {
"description": "type: \"multiples\" only: grid columns of the mobile variant.",
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"showValues": { "type": "boolean", "default": true },
"showTitle": {
"description": "false leaves the drawn title out of the SVG profile and gives its space to the chart; the title stays the accessible name. The HTML profile never draws the title: its figcaption is the visible title.",
"type": "boolean",
"default": true
},
"data": {
"description": "Single-series data. Use either data or categories with series.",
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "value"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 200 },
"value": { "$ref": "#/$defs/value" },
"lower": { "description": "Bar charts of one series without groups: the lower end of an error bar through the end of the bar; upper goes with it, and the value lies between them.", "type": "number" },
"upper": { "type": "number" },
"group": { "description": "Bar charts only: the group a bar belongs to, one palette color and legend entry per group (at most 4). Either every point names a group or none does.", "type": "string", "minLength": 1, "maxLength": 60 }
}
}
},
"categories": {
"description": "Unique category labels shared by all series, or by all panels of small multiples of bars (at most 20 there).",
"type": "array",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"items": { "type": "string", "minLength": 1, "maxLength": 200 }
},
"series": {
"description": "Named series with one value per category; null marks a missing value.",
"type": "array",
"minItems": 1,
"maxItems": 4,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["name", "values"],
"properties": {
"name": { "type": "string", "minLength": 1, "maxLength": 100 },
"values": { "type": "array", "items": { "$ref": "#/$defs/value" } },
"lower": { "type": "array", "items": { "$ref": "#/$defs/value" }, "description": "The lower end of an error bar through each value (bar and line charts, no stack): with upper, one entry per category, null where the value is null." },
"upper": { "type": "array", "items": { "$ref": "#/$defs/value" } }
}
}
},
"zoomSteps": {
"description": "Optional pre-computed zoom variants, selectable in the HTML profile. A bar or line chart names categories by index, a time chart names a window by timestamps.",
"type": "array",
"minItems": 2,
"maxItems": 4,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "from", "to"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 40 },
"from": {
"description": "First category index, or on a time chart the first timestamp of the window.",
"anyOf": [{ "type": "integer", "minimum": 0 }, { "$ref": "#/$defs/timeValue" }]
},
"to": {
"description": "Last category index, or on a time chart the last timestamp of the window.",
"anyOf": [{ "type": "integer", "minimum": 0 }, { "$ref": "#/$defs/timeValue" }]
}
}
}
}
},
"allOf": [
{
"oneOf": [
{
"required": ["data"],
"not": { "anyOf": [{ "required": ["categories"] }, { "required": ["series"] }] }
},
{
"required": ["categories", "series"],
"not": { "required": ["data"] }
},
{
"required": ["panes"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] }
]
}
},
{
"description": "Small multiples of bars: panels over shared categories.",
"required": ["panes", "categories"],
"properties": { "type": { "const": "multiples" } },
"not": { "anyOf": [{ "required": ["data"] }, { "required": ["series"] }] }
},
{
"required": ["stripes"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["calendar"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["parliament"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["treemap"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["sankey"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["survival"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["scatter"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["classes"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["network"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["waffle"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["waterfall"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["timeline"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["boxes"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["ranges"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["sequence"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["flow"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["state"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["architecture"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
},
{
"required": ["tree"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["categories"] },
{ "required": ["series"] },
{ "required": ["panes"] }
]
}
}
]
},
{
"if": { "properties": { "type": { "const": "stripes" } } },
"then": { "required": ["stripes"] },
"else": { "not": { "required": ["stripes"] } }
},
{
"if": { "properties": { "type": { "const": "calendar" } } },
"then": { "required": ["calendar"] },
"else": { "not": { "required": ["calendar"] } }
},
{
"if": { "properties": { "type": { "const": "rangebar" } } },
"then": { "required": ["ranges"] },
"else": { "not": { "required": ["ranges"] } }
},
{
"if": { "properties": { "type": { "const": "parliament" } } },
"then": { "required": ["parliament"] },
"else": { "not": { "required": ["parliament"] } }
},
{
"if": { "properties": { "type": { "const": "treemap" } } },
"then": { "required": ["treemap"] },
"else": { "not": { "required": ["treemap"] } }
},
{
"if": { "properties": { "type": { "const": "sankey" } } },
"then": { "required": ["sankey"] },
"else": { "not": { "required": ["sankey"] } }
},
{
"if": { "properties": { "type": { "const": "survival" } } },
"then": { "required": ["survival"] },
"else": { "not": { "required": ["survival"] } }
},
{
"if": { "properties": { "type": { "const": "scatter" } } },
"then": { "required": ["scatter"] },
"else": { "not": { "required": ["scatter"] } }
},
{
"if": { "properties": { "type": { "const": "classes" } } },
"then": { "required": ["classes"] },
"else": { "not": { "required": ["classes"] } }
},
{
"if": { "properties": { "type": { "const": "network" } } },
"then": { "required": ["network"] },
"else": { "not": { "required": ["network"] } }
},
{
"if": { "properties": { "type": { "const": "waffle" } } },
"then": { "required": ["waffle"] },
"else": { "not": { "required": ["waffle"] } }
},
{
"if": { "properties": { "type": { "const": "waterfall" } } },
"then": { "required": ["waterfall"] },
"else": { "not": { "required": ["waterfall"] } }
},
{
"if": { "properties": { "type": { "const": "timeline" } } },
"then": {
"required": ["timeline"],
"not": {
"anyOf": [
{ "required": ["zoomSteps"] },
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] },
{ "required": ["timeAxis"] }
]
}
},
"else": { "not": { "required": ["timeline"] } }
},
{
"if": { "properties": { "type": { "const": "boxplot" } } },
"then": { "required": ["boxes"] },
"else": { "not": { "required": ["boxes"] } }
},
{
"if": { "properties": { "type": { "const": "sequence" } } },
"then": {
"required": ["sequence"],
"not": {
"anyOf": [
{ "required": ["zoomSteps"] },
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] },
{ "required": ["timeAxis"] }
]
}
},
"else": { "not": { "required": ["sequence"] } }
},
{
"if": { "properties": { "type": { "const": "flow" } } },
"then": {
"required": ["flow"],
"not": {
"anyOf": [
{ "required": ["zoomSteps"] },
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] },
{ "required": ["timeAxis"] }
]
}
},
"else": { "not": { "required": ["flow"] } }
},
{
"if": { "properties": { "type": { "const": "state" } } },
"then": {
"required": ["state"],
"not": {
"anyOf": [
{ "required": ["zoomSteps"] },
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] },
{ "required": ["timeAxis"] }
]
}
},
"else": { "not": { "required": ["state"] } }
},
{
"if": { "properties": { "type": { "const": "architecture" } } },
"then": {
"required": ["architecture"],
"not": {
"anyOf": [
{ "required": ["zoomSteps"] },
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] },
{ "required": ["timeAxis"] }
]
}
},
"else": { "not": { "required": ["architecture"] } }
},
{
"if": { "properties": { "type": { "const": "tree" } } },
"then": {
"required": ["tree"],
"not": {
"anyOf": [
{ "required": ["zoomSteps"] },
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] },
{ "required": ["timeAxis"] }
]
}
},
"else": { "not": { "required": ["tree"] } }
},
{
"if": { "properties": { "type": { "const": "multiples" } } },
"then": {
"required": ["panes"],
"properties": { "panes": { "minItems": 2 } },
"not": {
"anyOf": [
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["zoomSteps"] }
]
}
},
"else": { "not": { "required": ["columns"] } }
},
{
"if": { "properties": { "type": { "const": "line" } } },
"then": { "not": { "required": ["orientation"] } }
},
{
"if": { "properties": { "type": { "const": "time" } } },
"then": {
"required": ["panes"],
"properties": { "panes": { "maxItems": 4 } },
"not": {
"anyOf": [
{ "required": ["orientation"] },
{ "required": ["categoryAxis"] },
{ "required": ["valueAxis"] }
]
}
}
},
{
"if": { "properties": { "type": { "enum": ["bar", "line"] } } },
"then": {
"properties": {
"zoomSteps": {
"items": {
"properties": {
"from": { "type": "integer", "minimum": 0 },
"to": { "type": "integer", "minimum": 0 }
}
}
}
},
"not": {
"anyOf": [
{ "required": ["panes"] },
{ "required": ["timeAxis"] }
]
}
}
}
],
"$defs": {
"tokens": {
"description": "Colors of the palette by the name of the --chartlet-* custom property without its prefix, as hex or rgb()/rgba() values. They win over the theme and apply to every variant, print and PNG included.",
"type": "object",
"propertyNames": { "pattern": "^(text|muted|grid|zero|accent|background|color\\-1|color\\-2|color\\-3|color\\-4|rise|fall|diverging\\-0|diverging\\-1|diverging\\-2|diverging\\-3|diverging\\-4|diverging\\-5|diverging\\-6|diverging\\-7|diverging\\-8|diverging\\-9|diverging\\-10|diverging\\-11|diverging\\-12|diverging\\-13|diverging\\-14|diverging\\-15|diverging\\-16|node|lane|lane\\-head|shadow|role\\-blue|role\\-blue\\-fill|role\\-green|role\\-green\\-fill|role\\-amber|role\\-amber\\-fill|role\\-teal|role\\-teal\\-fill|role\\-violet|role\\-violet\\-fill|role\\-gray|role\\-gray\\-fill|role\\-red|role\\-red\\-fill|heat\\-0|heat\\-1|heat\\-2|heat\\-3|heat\\-4|heat\\-5|part\\-5|part\\-6|part\\-7|part\\-8|parl\\-5|parl\\-6|parl\\-7|parl\\-8|net\\-5|net\\-6|net\\-7|net\\-8)$" },
"additionalProperties": { "type": "string", "pattern": "^(#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})|rgba?\\([0-9., %]+\\))$" }
},
"identifier": {
"description": "What other parts of a diagram refer to an element by: a letter, then letters, digits, hyphens or underscores.",
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,63}$"
},
"sequence": {
"description": "A sequence diagram. orientation auto draws it in portrait (participants side by side, time running down) where that fits the canvas, in landscape (participants one below the other, time running right) where only that fits, and otherwise in the orientation that grows the canvas less; a canvas too small for the diagram grows, with the warning canvas_too_small.",
"type": "object",
"additionalProperties": false,
"required": ["participants", "messages"],
"properties": {
"participants": {
"type": "array",
"minItems": 1,
"maxItems": 12,
"items": { "$ref": "#/$defs/participant" }
},
"messages": {
"description": "The messages in the order they are sent.",
"type": "array",
"minItems": 1,
"maxItems": 60,
"items": { "$ref": "#/$defs/message" }
},
"fragments": {
"description": "Frames around runs of consecutive messages; two fragments either nest or do not overlap, at most three deep.",
"type": "array",
"maxItems": 12,
"items": { "$ref": "#/$defs/fragment" }
},
"numbered": {
"description": "Numbers the messages in round badges at the start of their arrows.",
"type": "boolean",
"default": false
},
"orientation": { "enum": ["auto", "portrait", "landscape"], "default": "auto" }
}
},
"flow": {
"description": "A flow chart, laid out in layers along the flow: down in portrait, right in landscape. orientation auto takes portrait where that fits the canvas, landscape where only that fits, and otherwise the one that grows the canvas less (canvas_too_small). Edges may form cycles; an edge back is drawn against the flow.",
"type": "object",
"additionalProperties": false,
"required": ["nodes"],
"properties": {
"nodes": {
"type": "array",
"minItems": 1,
"maxItems": 40,
"items": { "$ref": "#/$defs/flowNode" }
},
"edges": {
"type": "array",
"maxItems": 80,
"items": { "$ref": "#/$defs/flowEdge" }
},
"lanes": {
"description": "Bands across the flow; once there are lanes, every step names one.",
"type": "array",
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 40 }
}
}
},
"groups": {
"description": "Frames around steps of one lane; a step belongs to at most one group.",
"type": "array",
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "nodes"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 40 },
"nodes": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/identifier" } }
}
}
},
"mainPath": {
"description": "The usual way through the flow, as step ids joined by edges, or as {from, to}: the shortest way along the edges between two steps (at a tie the first in the order of the edges). Kept in line and drawn stronger.",
"$ref": "#/$defs/mainPath"
},
"sameRank": {
"description": "Sets of step ids that lie at one position along the flow, such as parallel reviews or all end steps. A layout hint: it adds no edge. A step lies in at most one set, and no edge joins two steps of one set.",
"$ref": "#/$defs/sameRank"
},
"notes": { "description": "Notes on steps (on names a step) or on the whole chart (without on).", "$ref": "#/$defs/notes" },
"orientation": { "enum": ["auto", "portrait", "landscape"], "default": "auto" },
"spacing": { "$ref": "#/$defs/diagramSpacing" },
"valueLabel": { "description": "What the value of the nodes stands for: the name of the color key and of the table column.", "type": "string", "minLength": 1, "maxLength": 40 },
"sharedTrunks": { "description": "Draws edges that leave a step together, or reach one together, on one shared line that branches with a dot at every branch: only those without label, off the main path, with the same dash, weight and role and their other ends in the same lane and group; the branches of a decision keep a line each. Every edge is still drawn and listed.", "type": "boolean", "default": false }
}
},
"state": {
"description": "A state diagram, laid out like a flow chart. A composite state is a frame around the states that name it with in; transitions, initial and mainPath name states that are not composite. initial names the state the machine starts in and draws a dot with an arrow into it; final states get a double outline, choices a diamond. Transitions are written event [guard] / action.",
"type": "object",
"additionalProperties": false,
"required": ["states"],
"properties": {
"states": {
"type": "array",
"minItems": 1,
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"sublabel": { "type": "string", "minLength": 1, "maxLength": 60 },
"kind": { "enum": ["state", "choice", "composite"], "default": "state" },
"final": { "type": "boolean", "default": false },
"in": { "$ref": "#/$defs/identifier" },
"role": { "description": "Not on a composite state, which is a frame.", "$ref": "#/$defs/diagramRole" }
}
}
},
"transitions": {
"type": "array",
"maxItems": 80,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["from", "to"],
"properties": {
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" },
"event": { "type": "string", "minLength": 1, "maxLength": 40 },
"guard": { "type": "string", "minLength": 1, "maxLength": 40 },
"action": { "type": "string", "minLength": 1, "maxLength": 40 },
"dash": { "enum": ["solid", "dashed", "dotted"], "default": "solid" },
"role": { "description": "planned and deprecated draw the line in a pattern of their own and take no dash.", "$ref": "#/$defs/diagramRole" }
}
}
},
"initial": { "$ref": "#/$defs/identifier" },
"mainPath": {
"description": "The usual way through the states, as ids joined by transitions: kept in line and drawn stronger.",
"type": "array",
"items": { "$ref": "#/$defs/identifier" }
},
"orientation": { "enum": ["auto", "portrait", "landscape"], "default": "auto" },
"spacing": { "$ref": "#/$defs/diagramSpacing" }
}
},
"network": {
"description": "A network: nodes as dots joined by edges, with no direction of flow. On a circle (the default) the nodes stand clockwise from twelve o'clock, groups together, in the order that lets the fewest edges cross; in rings, center stands in the middle and every other node on the ring of its distance in edges, nodes no way reaches on one more ring outside. Up to 40 nodes and 120 edges.",
"type": "object",
"additionalProperties": false,
"required": ["nodes"],
"properties": {
"nodes": {
"type": "array",
"minItems": 1,
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"group": { "description": "The group of the node: its color and a legend entry; at most 8 groups.", "type": "string", "minLength": 1, "maxLength": 40 },
"role": { "description": "Drawn as a ring around the dot, in the role's color and pattern; the dot keeps the color of its group.", "$ref": "#/$defs/diagramRole" }
}
}
},
"edges": {
"type": "array",
"maxItems": 120,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["from", "to"],
"properties": {
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" },
"dash": { "enum": ["solid", "dashed", "dotted"], "default": "solid" },
"weight": { "description": "How much the edge carries, at least 0; the line is drawn from 1 px for nothing to 5 px for the heaviest edge.", "type": "number", "minimum": 0 },
"role": { "description": "planned and deprecated draw the line in a pattern of their own and take no dash.", "$ref": "#/$defs/diagramRole" }
}
}
},
"layout": { "enum": ["circle", "rings"], "default": "circle" },
"center": { "description": "The node in the middle of the rings; required with layout rings, refused on a circle.", "$ref": "#/$defs/identifier" },
"directed": { "description": "Whether edges lead from one node to the other: drawn with an arrowhead.", "type": "boolean", "default": false },
"order": { "description": "The order around a circle: groups together with as few crossings as swaps find (crossings), or as listed.", "enum": ["crossings", "listed"], "default": "crossings" }
}
},
"classes": {
"description": "A class or entity-relationship diagram: boxes with a name, a stereotype for the kind, and an attribute and a method compartment, joined by relations whose kind sets the marks at the line's ends, with cardinalities at either end, optionally framed in nested packages. Laid out like a flow chart; up to 40 classes, 100 relations and 12 packages.",
"type": "object",
"additionalProperties": false,
"required": ["classes"],
"properties": {
"classes": {
"type": "array",
"minItems": 1,
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"kind": { "enum": ["class", "interface", "abstract", "enum", "entity"], "default": "class" },
"attributes": { "type": "array", "maxItems": 30, "items": { "type": "string", "minLength": 1, "maxLength": 100 } },
"methods": { "type": "array", "maxItems": 30, "items": { "type": "string", "minLength": 1, "maxLength": 100 } },
"in": { "description": "The id of the package the class lies in.", "$ref": "#/$defs/identifier" },
"role": { "$ref": "#/$defs/diagramRole" }
}
}
},
"packages": {
"description": "Frames that group classes into modules, nesting at most four deep by naming the package they lie in. Identifiers are unique among classes and packages; every package holds at least one class, directly or in a package inside it. Relations join classes, never packages.",
"type": "array",
"maxItems": 12,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"in": { "$ref": "#/$defs/identifier" },
"orientation": { "description": "Lays out the package's classes portrait or landscape whichever way the diagram runs, as one block; relations from outside run on straight to their class. When such a way would cross the block in every orientation the diagram may take, the package follows the diagram (package_orientation_ignored). Not in a package that has an orientation of its own.", "enum": ["portrait", "landscape"] }
}
}
},
"relations": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["from", "to"],
"properties": {
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" },
"kind": { "enum": ["association", "inheritance", "realization", "composition", "aggregation", "dependency"], "default": "association" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"fromCardinality": { "type": "string", "minLength": 1, "maxLength": 12 },
"toCardinality": { "type": "string", "minLength": 1, "maxLength": 12 },
"direction": { "description": "Associations only: navigable to `to` (forward, an open arrowhead at `to`), both ways (open arrowheads at either end), or not said (none, a plain line).", "enum": ["forward", "both", "none"] },
"role": { "description": "The marks at the ends keep their form; a hollow mark stays hollow. A realization or a dependency is dashed by its kind and takes only critical: planned and deprecated would draw their own pattern over it (role_conflict).", "$ref": "#/$defs/diagramRole" }
}
}
},
"notes": { "description": "Notes on classes or packages (on names one) or on the whole diagram (without on).", "$ref": "#/$defs/notes" },
"orientation": { "enum": ["auto", "portrait", "landscape"], "default": "auto" },
"spacing": { "$ref": "#/$defs/diagramSpacing" }
}
},
"scatter": {
"description": "A scatter plot: points on two numeric axes, in up to 4 groups (on every point or none, one palette color each), with up to 8 lines across the plot at a value of x or y and names beside labeled points. Up to 5000 points; above 300 they are drawn small without tooltips, and above 100 the data table lists only the labeled points, or the 20 highest.",
"type": "object",
"additionalProperties": false,
"required": ["points"],
"properties": {
"points": {
"type": "array",
"minItems": 1,
"maxItems": 5000,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["x", "y"],
"properties": {
"x": { "type": "number" },
"y": { "type": "number" },
"group": { "type": "string", "minLength": 1, "maxLength": 60 },
"label": { "type": "string", "minLength": 1, "maxLength": 60 }
}
}
},
"lines": {
"type": "array",
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["axis", "value"],
"properties": {
"axis": { "enum": ["x", "y"] },
"value": { "type": "number" },
"label": { "type": "string", "minLength": 1, "maxLength": 100 }
}
}
},
"xRange": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" }, "description": "The ends of the x axis, [min, max], instead of ends rounded outward to a tick; everything drawn along x must lie within." },
"yRange": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } },
"xTicks": {
"type": "array",
"maxItems": 40,
"description": "Labels for the x axis at chosen positions instead of numbered ticks, such as chromosomes; a label that would run into the one before it is left out.",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["at", "label"],
"properties": {
"at": { "type": "number" },
"label": { "type": "string", "minLength": 1, "maxLength": 40 }
}
}
},
"quadrants": {
"description": "Splits the plot into four areas by a line at x and one at y, such as an impact and effort matrix, and names each area in a corner; the description and the data table say in which area each point lies. With xRange or yRange the line lies inside it.",
"type": "object",
"additionalProperties": false,
"required": ["x", "y"],
"properties": {
"x": { "type": "number" },
"y": { "type": "number" },
"labels": {
"description": "The name of each area, each optional; top is the side of the larger y, right the side of the larger x.",
"type": "object",
"additionalProperties": false,
"properties": {
"topLeft": { "type": "string", "minLength": 1, "maxLength": 40 },
"topRight": { "type": "string", "minLength": 1, "maxLength": 40 },
"bottomLeft": { "type": "string", "minLength": 1, "maxLength": 40 },
"bottomRight": { "type": "string", "minLength": 1, "maxLength": 40 }
}
}
}
},
"xTitle": { "type": "string", "minLength": 1, "maxLength": 100 },
"yTitle": { "type": "string", "minLength": 1, "maxLength": 100 },
"regression": { "type": "boolean", "default": false, "description": "Draw the least-squares line through the points, one for each group; on a logarithmic axis it is fitted to the logarithms." },
"xScale": { "enum": ["linear", "log"], "default": "linear" },
"yScale": { "enum": ["linear", "log"], "default": "linear" }
}
},
"survival": {
"description": "Kaplan-Meier curves: for every group the share still without the event, from observed times; an observation with `event: false` is cut off (censored) and marked on the curve. Up to 4 groups with 2–2000 observations each; `confidence` draws the 95% band (log-log, Greenwood), `atRisk` (default true) writes the number at risk under the time axis.",
"type": "object",
"additionalProperties": false,
"required": ["groups"],
"properties": {
"groups": {
"type": "array",
"minItems": 1,
"maxItems": 4,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "observations"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"observations": {
"type": "array",
"minItems": 2,
"maxItems": 2000,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["time"],
"properties": {
"time": { "type": "number", "minimum": 0 },
"event": { "type": "boolean", "default": true }
}
}
}
}
}
},
"confidence": { "type": "boolean", "default": false },
"logRank": { "type": "boolean", "default": false, "description": "Test whether the curves differ (log-rank, Mantel-Cox; needs two or more groups) and write the statistic and p in the plot and the description." },
"atRisk": { "type": "boolean", "default": true },
"timeTitle": { "type": "string", "minLength": 1, "maxLength": 100 }
}
},
"sankey": {
"description": "A Sankey diagram: nodes in columns by the longest path to them, joined by bands as thick as the flow. The nodes are the labels the links name; up to 100 links and 40 nodes, no link from a node to itself, one link for each pair, no cycle.",
"type": "object",
"additionalProperties": false,
"required": ["links"],
"properties": {
"nodes": {
"type": "array",
"maxItems": 40,
"description": "Nodes whose column, color or order the specification fixes; they come first, in this order.",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"column": { "type": "integer", "minimum": 0, "maximum": 7 },
"color": { "type": "integer", "minimum": 1, "maximum": 4 }
}
}
},
"order": { "enum": ["auto", "listed"], "default": "auto", "description": "auto orders the nodes of a column to cross few bands; listed keeps the order of nodes, then of the links." },
"links": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["from", "to", "value"],
"properties": {
"from": { "type": "string", "minLength": 1, "maxLength": 100 },
"to": { "type": "string", "minLength": 1, "maxLength": 100 },
"value": { "type": "number", "exclusiveMinimum": 0 },
"back": { "type": "boolean", "default": false, "description": "A flow back to an earlier column: drawn as a loop below the diagram; the columns and their order do not follow it." }
}
}
}
}
},
"treemap": {
"description": "A treemap: rectangles whose areas follow the values of the items, packed by the squarified method; the names and values stand inside the rectangles that have room. Up to 100 items (parts included) with positive values; an optional group (up to 4, on every item or on none) colors the rectangles and shows a legend; or items with children, nested up to three levels, colored by the item at the top.",
"type": "object",
"additionalProperties": false,
"required": ["items"],
"properties": {
"items": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": { "$ref": "#/$defs/treemapItem" }
}
}
},
"treemapItem": {
"type": "object",
"additionalProperties": false,
"required": ["label"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"value": { "type": "number", "exclusiveMinimum": 0, "description": "The value of a leaf; an item with children has none." },
"group": { "type": "string", "minLength": 1, "maxLength": 60 },
"children": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/treemapItem" }, "description": "The parts of this item, drawn inside its rectangle; up to three levels deep. A nested treemap takes its colors from the items at the top and has no groups." }
}
},
"parliament": {
"description": "A parliament: the seats of an assembly as dots in a semicircle, in blocks by party from left to right in the order of the list. Up to 8 parties and 800 seats; majority marks the seat that makes a majority, coalition (labels of parties) rings their seats and sums them.",
"type": "object",
"additionalProperties": false,
"required": ["parties"],
"properties": {
"parties": {
"type": "array",
"minItems": 1,
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "seats"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"seats": { "type": "integer", "minimum": 1, "maximum": 800 }
}
}
},
"majority": { "type": "boolean", "default": false },
"coalition": { "type": "array", "items": { "type": "string" } }
}
},
"waffle": {
"description": "A waffle: a grid of squares that each stand for the same share of a whole, filled by the parts in reading order, each part with at least one square. Up to 4 parts; cells 10–400 (default 100), columns 2–40; a total above the sum of the parts leaves the squares of the rest.",
"type": "object",
"additionalProperties": false,
"required": ["parts"],
"properties": {
"parts": {
"type": "array",
"minItems": 1,
"maxItems": 4,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "value"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"value": { "type": "number", "exclusiveMinimum": 0 }
}
}
},
"cells": { "type": "integer", "minimum": 10, "maximum": 400, "default": 100 },
"columns": { "type": "integer", "minimum": 2, "maximum": 40 },
"total": { "type": "number", "exclusiveMinimum": 0 }
}
},
"waterfall": {
"description": "A waterfall: a running total that rises and falls step by step. A delta adds its value, a start sets the total as a bar from zero, a total shows the running total (and, if it names a value, that value must equal it).",
"type": "object",
"additionalProperties": false,
"required": ["steps"],
"properties": {
"steps": {
"type": "array",
"minItems": 2,
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"value": { "type": "number" },
"kind": { "enum": ["delta", "start", "total"], "default": "delta" }
}
}
}
}
},
"timeline": {
"description": "A timeline: phases (start and end), milestones (at), dashed marker lines for days that matter, and which items follow which. Days are ISO 8601 dates, optionally with a time, or Unix seconds. Either every item names a group or none does (at most 4); `after` names the ids of earlier or later items, in no circle.",
"type": "object",
"additionalProperties": false,
"required": ["items"],
"properties": {
"items": {
"type": "array",
"minItems": 1,
"maxItems": 60,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
"start": { "$ref": "#/$defs/timeValue" },
"end": { "$ref": "#/$defs/timeValue" },
"at": { "$ref": "#/$defs/timeValue" },
"group": { "type": "string", "minLength": 1, "maxLength": 60 },
"after": { "type": "array", "items": { "$ref": "#/$defs/identifier" } },
"progress": { "type": "number", "minimum": 0, "maximum": 1, "description": "How much of a phase is done: that share of its bar is drawn darker." },
"rollup": { "type": "array", "items": { "$ref": "#/$defs/identifier" }, "description": "The ids of the phases this phase sums up: its progress is theirs, each weighted by its length. Instead of progress." }
}
}
},
"markers": {
"type": "array",
"maxItems": 6,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label", "at"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"at": { "$ref": "#/$defs/timeValue" }
}
}
},
"groupRows": { "type": "boolean", "default": false, "description": "Put the rows of one group together, in the order the groups first appear. Needs groups." },
"timezone": { "type": "string", "default": "UTC", "description": "The zone the days are read and written in: UTC, a fixed offset such as +02:00, or one of about 55 common IANA names such as Europe/Berlin, with the daylight saving rules in force today. A bare date or local time is the time on the wall there; an instant (Unix seconds, or a time with its own offset) is shifted by the offset in force then." },
"weekends": { "type": "boolean", "default": false, "description": "Shade Saturdays and Sundays behind the rows while the axis spans at most 120 days; a longer axis warns (weekends_hidden)." }
}
},
"tree": {
"description": "A tree: one root and, below it, nodes that each name their parent; the children of a node keep the order of the list. Identifiers are unique, exactly one node has neither a parent nor a partner, the parents run to the root without a circle, and the tree goes at most twelve levels below the root.",
"type": "object",
"additionalProperties": false,
"oneOf": [{ "required": ["nodes"] }, { "required": ["distances"] }],
"properties": {
"nodes": {
"type": "array",
"minItems": 1,
"maxItems": 150,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"sublabel": { "type": "string", "minLength": 1, "maxLength": 60 },
"parent": { "$ref": "#/$defs/identifier" },
"link": { "description": "What joins the node to its parent, such as a share; not on the root.", "type": "string", "minLength": 1, "maxLength": 40 },
"kind": { "enum": ["unit", "person", "external"], "default": "unit" },
"partner": { "description": "The id of the node this one is joined to as a couple: they stand side by side and the children of either hang from the middle of the line between them. A partner has no parent, and is not itself named as a partner.", "$ref": "#/$defs/identifier" },
"collapsed": { "type": "boolean", "default": false, "description": "Draw the node without what hangs below it and below its partner; a small +n says how many nodes are left out. The description and the data table still list them." },
"value": { "description": "A number that colors the node's fill, from light for the smallest value to dark for the largest.", "type": "number" },
"parts": { "description": "The parts of what the node holds, drawn as a stripe inside the bottom of its box; at most 6 per node and 8 names per diagram; a decision takes none.", "type": "array", "maxItems": 6, "items": { "type": "object", "additionalProperties": false, "required": ["label", "value"], "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 40 }, "value": { "type": "number", "minimum": 0 } } } },
"role": { "$ref": "#/$defs/diagramRole" }
}
}
},
"orientation": { "enum": ["auto", "portrait", "landscape"], "default": "auto" },
"layout": {
"description": "layered: one row per level (a column in landscape). radial: a mind map, the root in the middle and every level on a ring around it, each subtree in a sector as wide as its share of the leaves; takes no orientation, partner or link.",
"enum": ["layered", "radial"],
"default": "layered"
},
"valueLabel": { "description": "What the value of the nodes stands for: the name of the color key and of the table column.", "type": "string", "minLength": 1, "maxLength": 40 },
"distances": {
"description": "Instead of nodes: the distances between items, from which chartlet builds a dendrogram by agglomerative clustering. A square matrix in the order of labels, symmetric, 0 on the diagonal, nowhere below 0; 2 to 40 items with unique labels. Takes no nodes, layout, orientation or valueLabel.",
"type": "object",
"additionalProperties": false,
"required": ["labels", "matrix"],
"properties": {
"labels": { "type": "array", "minItems": 2, "maxItems": 40, "items": { "type": "string", "minLength": 1, "maxLength": 60 } },
"matrix": { "type": "array", "items": { "type": "array", "items": { "type": "number", "minimum": 0 } } }
}
},
"linkage": {
"description": "How far apart two clusters of a dendrogram are: the mean distance between their items (average), the largest (complete) or the smallest (single).",
"enum": ["average", "complete", "single"],
"default": "average"
}
}
},
"architecture": {
"description": "An architecture diagram, laid out like a flow chart: components joined by connections inside boundaries that nest by naming the boundary they lie in. Identifiers are unique among components and boundaries; every boundary holds at least one component, directly or in a boundary inside it.",
"type": "object",
"additionalProperties": false,
"required": ["components"],
"properties": {
"components": {
"type": "array",
"minItems": 1,
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"sublabel": { "type": "string", "minLength": 1, "maxLength": 60 },
"kind": {
"enum": ["person", "frontend", "service", "database", "queue", "storage", "cache", "external", "security", "node", "artifact"],
"default": "service"
},
"symbol": {
"description": "A generic symbol drawn above the label that names the component's technology category; the kind keeps its shape and meaning. The description and the data table name the category after the kind.",
"enum": ["browser", "mobile", "api-gateway", "load-balancer", "cdn", "firewall", "identity", "container", "orchestrator", "function", "cloud", "cache", "object-storage", "message-broker", "search-index", "monitoring"]
},
"in": { "$ref": "#/$defs/identifier" },
"role": { "$ref": "#/$defs/diagramRole" },
"tags": { "description": "Names of groups the component belongs to, such as public or payments, by which views include or exclude it; not drawn.", "type": "array", "maxItems": 8, "uniqueItems": true, "items": { "$ref": "#/$defs/identifier" } },
"provides": {
"description": "Interfaces the component provides, each a ball on a stem ahead of its box with the label beside it; connections require one by toInterface. Not on a person or a node.",
"type": "array",
"maxItems": 4,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "description": "Unique among the interfaces of the component; with the component's id it forms the stable id `component.interface`.", "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 40 }
}
}
}
}
}
},
"connections": {
"type": "array",
"maxItems": 80,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["from", "to"],
"properties": {
"id": { "description": "A stable name by which views select the connection; unique among connections.", "$ref": "#/$defs/identifier" },
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"technology": { "type": "string", "minLength": 1, "maxLength": 40 },
"step": { "type": "integer", "minimum": 1, "maximum": 99 },
"dash": { "enum": ["solid", "dashed", "dotted"], "default": "solid" },
"weight": { "description": "How much the edge carries, at least 0; the line is drawn from 1 px for nothing to 5 px for the heaviest edge.", "type": "number", "minimum": 0 },
"role": { "description": "planned and deprecated draw the line in a pattern of their own and take no dash.", "$ref": "#/$defs/diagramRole" },
"direction": { "description": "Which way the connection runs: forward from `from` to `to` (an arrowhead at `to`), both ways as one connection (arrowheads at either end), or none (no arrowhead).", "enum": ["forward", "both", "none"], "default": "forward" },
"tags": { "description": "Names of groups the connection belongs to, by which views include or exclude it; not drawn.", "type": "array", "maxItems": 8, "uniqueItems": true, "items": { "$ref": "#/$defs/identifier" } },
"toInterface": { "description": "The id of an interface `to` provides: `from` requires it, and the connection ends in a socket around its ball instead of an arrowhead. Runs forward and never joins a shared trunk.", "$ref": "#/$defs/identifier" },
"fromSide": { "description": "The side of `from` the connection leaves.", "$ref": "#/$defs/portSide" },
"toSide": { "description": "The side of `to` the connection reaches.", "$ref": "#/$defs/portSide" }
}
}
},
"boundaries": {
"description": "Frames such as a cloud region, a network or a system, nesting at most four deep.",
"type": "array",
"maxItems": 12,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"in": { "$ref": "#/$defs/identifier" }
}
}
},
"mainPath": {
"description": "The usual way a request takes, as component ids joined by connections, or as {from, to}: the shortest way along the connections between two components (at a tie the first in the order of the connections). Kept in line and drawn stronger.",
"$ref": "#/$defs/mainPath"
},
"sameRank": {
"description": "Sets of component ids that lie at one position along the flow, such as the databases of a data tier. A layout hint: it adds no connection. A component lies in at most one set, and no connection joins two components of one set.",
"$ref": "#/$defs/sameRank"
},
"notes": { "description": "Notes on components or boundaries (on names one) or on the whole diagram (without on). A view keeps the notes on the whole diagram, and those on the components and boundaries it shows; a deployment view keeps only those on the whole diagram.", "$ref": "#/$defs/notes" },
"orientation": { "enum": ["auto", "portrait", "landscape"], "default": "auto" },
"spacing": { "$ref": "#/$defs/diagramSpacing" },
"sharedTrunks": { "description": "Draws connections that leave a component together, or reach one together, on one shared line that branches with a dot at every branch: only those without label, technology or step, in the usual direction, off the main path, with the same dash, weight and role and their other ends in the same boundary. Every connection is still drawn and listed.", "type": "boolean", "default": false },
"views": {
"description": "Views on this model. A specification with views renders one of them, chosen by its key, or the default view; never the whole model. A view resolves to an architecture diagram of its own: the listed components in the order of the model, the connections between them (or only the listed ones), the boundaries that hold at least one of them, and the model's main path when the view shows all of it. Nothing outside the view is drawn or described, and no connection is drawn that the model does not have.",
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["key", "title"],
"properties": {
"key": { "description": "A stable name of the view, independent of its title; unique among views.", "$ref": "#/$defs/identifier" },
"title": { "description": "The title of the diagram the view renders, in place of the model's.", "type": "string", "minLength": 1, "maxLength": 200 },
"description": { "description": "The description of the diagram the view renders; without one it is generated from what the view shows. The model's description is never used.", "type": "string", "minLength": 1, "maxLength": 1000 },
"components": { "description": "The ids of the components the view shows. Required unless the view has steps; a dynamic view without it shows the ends of its steps.", "type": "array", "items": { "$ref": "#/$defs/identifier" } },
"connections": { "description": "The ids of the connections the view shows, each between components it shows; without it, every connection between them. Not with steps.", "type": "array", "items": { "$ref": "#/$defs/identifier" } },
"mainPath": { "description": "The way the view draws stronger, along its connections; without one, the model's main path when it lies in the view.", "$ref": "#/$defs/mainPath" },
"steps": {
"description": "A dynamic view: connections of the model in the order they occur, numbered from 1 in place of their own steps. The same connection may occur again with other text. The view shows only these connections.",
"type": "array",
"maxItems": 99,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["connection"],
"properties": {
"connection": { "description": "The id of the connection.", "$ref": "#/$defs/identifier" },
"label": { "description": "What happens in this step, in place of the connection's label.", "type": "string", "minLength": 1, "maxLength": 60 }
}
}
},
"perspective": { "description": "The key of the perspective the view shows, in place of the model's.", "$ref": "#/$defs/identifier" },
"width": { "description": "The width of the diagram the view renders, in place of the model's; checked like it.", "$ref": "#/properties/width" },
"height": { "description": "The height of the diagram the view renders, in place of the model's; checked like it.", "$ref": "#/properties/height" },
"mobile": { "description": "The mobile layout of the diagram the view renders, in place of the model's; checked like it.", "$ref": "#/properties/mobile" },
"include": { "description": "Tags that select more components: the view shows its listed components and every component carrying one of these tags and none of exclude. With connections, also the connections between shown components that carry one. Not with steps.", "type": "array", "items": { "$ref": "#/$defs/identifier" } },
"exclude": { "description": "Tags that leave out components and connections carrying one, unless the view lists them. A view with exclude but neither components nor include starts from every component. Not with steps.", "type": "array", "items": { "$ref": "#/$defs/identifier" } },
"environment": { "description": "Makes the view a deployment view of this environment, such as Production: it shows instances on hosts joined by instance connections, in place of components, connections, steps and mainPath.", "type": "string", "minLength": 1, "maxLength": 60 },
"hosts": { "description": "Deployment view: machines, clusters or zones, nested like boundaries; each holds an instance.", "type": "array", "items": { "$ref": "#/$defs/architecture/properties/boundaries/items" } },
"instances": {
"description": "Deployment view: running instances of the model's components, drawn as the component with its id, such as Orders API (api-1). At most 40 after expansion, like components.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "of"],
"properties": {
"id": { "description": "A stable id, unique among the instances and hosts of the view.", "$ref": "#/$defs/identifier" },
"of": { "description": "The id of the component of the model the instance runs.", "$ref": "#/$defs/identifier" },
"in": { "description": "The id of the host it runs on.", "$ref": "#/$defs/identifier" }
}
}
},
"instanceConnections": { "description": "Deployment view: the connections between instances, from and to naming instance ids; nothing else joins them unless deriveConnections is set. One with the id of a model connection must join instances of its ends and takes the label, technology, dash, role, fromSide and toSide it leaves out from it.", "type": "array", "items": { "$ref": "#/$defs/architecture/properties/connections/items" } },
"deriveConnections": { "description": "Deployment view: also derive instance connections from every model connection whose id instanceConnections does not name. Each instance of its from component, in the order of the instances, joins the nearest instances of its to component: those whose hosts share the most enclosing hosts with its own, counted from the outermost; at a tie all of them, never itself. Derived connections come after the listed ones and count toward the 80 connections.", "type": "boolean", "default": false }
}
}
},
"defaultView": { "description": "The key of the view rendered when none is asked for; without it, the first view.", "$ref": "#/$defs/identifier" },
"perspectives": {
"description": "Questions the model can be seen under, such as which team runs a component or how much technical debt it carries, each with its categories and the components in each. A diagram shows one perspective only when it is selected (perspective here or on a view, or the perspective render option in place of both), with a stripe in the category's color and its name in every box, a legend of the categories used, and the perspective in the description and the table. A component no category lists is shown as not stated. Nothing is derived.",
"type": "array",
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["key", "title", "categories"],
"properties": {
"key": { "description": "A stable name of the perspective; unique among perspectives.", "$ref": "#/$defs/identifier" },
"title": { "description": "What the perspective is called in the legend, the description and the table, such as Team.", "type": "string", "minLength": 1, "maxLength": 40 },
"description": { "description": "A sentence that says what the perspective means, added to the description.", "type": "string", "minLength": 1, "maxLength": 200 },
"categories": {
"description": "The categories in their order, which fixes their colors in every view. A component or a connection lies in at most one category of a perspective.",
"type": "array",
"minItems": 1,
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["label"],
"properties": {
"label": { "description": "The name of the category, unique in the perspective, such as a team.", "type": "string", "minLength": 1, "maxLength": 40 },
"components": { "description": "The ids of the components in the category.", "type": "array", "items": { "$ref": "#/$defs/identifier" } },
"connections": { "description": "The ids of the connections in the category: drawn in its color with its name after the label, and named in the description and the table. A connection no category lists is drawn as without the perspective.", "type": "array", "items": { "$ref": "#/$defs/identifier" } }
}
}
}
}
}
},
"perspective": { "description": "The key of the perspective the diagram shows, and every view without one of its own.", "$ref": "#/$defs/identifier" }
}
},
"sameRank": {
"type": "array",
"items": {
"type": "array",
"minItems": 2,
"uniqueItems": true,
"items": { "$ref": "#/$defs/identifier" }
}
},
"notes": {
"description": "Notes such as an assumption or a limitation. On an element (on names a step, class or component) a note is a box beside it, joined to it by a dotted line that only says the note explains it; on a frame (a package or boundary) it stands inside the frame at its head, without a line; without on it explains the whole diagram and stands in a band below it. No note adds an edge, relation or connection. The text wraps onto as many lines as it needs. The description names every note; the table gives notes on elements in a Notes column and the others in its caption. At most 12 notes.",
"type": "array",
"maxItems": 12,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["text"],
"properties": {
"on": { "$ref": "#/$defs/identifier" },
"text": { "type": "string", "minLength": 1, "maxLength": 160 }
}
}
},
"mainPath": {
"oneOf": [
{ "type": "array", "items": { "$ref": "#/$defs/identifier" } },
{
"type": "object",
"additionalProperties": false,
"required": ["from", "to"],
"properties": {
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" }
}
}
]
},
"flowNode": {
"description": "A step; each kind has its own shape.",
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"sublabel": { "type": "string", "minLength": 1, "maxLength": 60 },
"kind": {
"enum": ["start", "end", "process", "decision", "io", "subprocess", "store", "external"],
"default": "process"
},
"lane": { "$ref": "#/$defs/identifier" },
"value": { "description": "A number that colors the node's fill, from light for the smallest value to dark for the largest.", "type": "number" },
"parts": { "description": "The parts of what the node holds, drawn as a stripe inside the bottom of its box; at most 6 per node and 8 names per diagram; a decision takes none.", "type": "array", "maxItems": 6, "items": { "type": "object", "additionalProperties": false, "required": ["label", "value"], "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 40 }, "value": { "type": "number", "minimum": 0 } } } },
"role": { "$ref": "#/$defs/diagramRole" }
}
},
"flowEdge": {
"type": "object",
"additionalProperties": false,
"required": ["from", "to"],
"properties": {
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"dash": { "enum": ["solid", "dashed", "dotted"], "default": "solid" },
"weight": { "description": "How much the edge carries, at least 0; the line is drawn from 1 px for nothing to 5 px for the heaviest edge.", "type": "number", "minimum": 0 },
"role": { "description": "planned and deprecated draw the line in a pattern of their own and take no dash.", "$ref": "#/$defs/diagramRole" },
"fromSide": { "description": "The side of `from` the edge leaves.", "$ref": "#/$defs/portSide" },
"toSide": { "description": "The side of `to` the edge reaches.", "$ref": "#/$defs/portSide" }
}
},
"diagramSpacing": {
"description": "How much room a layered diagram leaves between its layers and between neighbours in a layer: compact (about 70 %, never below what a phone keeps, and not spread over a larger canvas), normal (default) or roomy (150 %). Steps, texts, margins and the distance between parallel lines keep their size.",
"enum": ["compact", "normal", "roomy"],
"default": "normal"
},
"portSide": {
"description": "A side of a node, named after the flow so that it holds in either orientation: start faces the nodes before, end the nodes after, left and right lie across the flow (left and right in portrait, top and bottom in landscape). Without it the layout chooses. A side along the flow against the edge is ignored (port_side_ignored); an edge from a node to itself takes none. An edge with a side never joins a shared trunk.",
"enum": ["start", "end", "left", "right"]
},
"diagramRole": {
"description": "What a node or an edge means beyond its kind, alike in every diagram. critical: a strong red outline or line and a badge with !; planned: dashed, violet, badge +; deprecated: dotted, gray, badge −. The kind keeps its shape and fill; a legend below the diagram names the roles used, and the description and the table name every role.",
"enum": ["critical", "planned", "deprecated"]
},
"participant": {
"description": "A participant; each kind has its own shape.",
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"sublabel": { "type": "string", "minLength": 1, "maxLength": 60 },
"kind": {
"enum": ["actor", "service", "database", "queue", "external"],
"default": "service"
}
}
},
"message": {
"description": "A message from one participant to another, or to itself. A call activates its receiver until the receiver replies.",
"type": "object",
"additionalProperties": false,
"required": ["from", "to", "label"],
"properties": {
"from": { "$ref": "#/$defs/identifier" },
"to": { "$ref": "#/$defs/identifier" },
"label": { "type": "string", "minLength": 1, "maxLength": 80 },
"kind": { "enum": ["call", "reply", "async"], "default": "call" }
}
},
"fragment": {
"description": "A frame around the messages from and to, counted from 0 and included. Only alt has further branches, each starting at a later message inside the frame.",
"type": "object",
"additionalProperties": false,
"required": ["kind", "from", "to"],
"properties": {
"kind": { "enum": ["alt", "opt", "loop", "par", "critical", "break"] },
"label": { "type": "string", "minLength": 1, "maxLength": 60 },
"from": { "type": "integer", "minimum": 0 },
"to": { "type": "integer", "minimum": 0 },
"else": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["from"],
"properties": {
"from": { "type": "integer", "minimum": 0 },
"label": { "type": "string", "minLength": 1, "maxLength": 60 }
}
}
}
}
},
"value": {
"anyOf": [
{ "type": "null" },
{ "const": 0 },
{ "type": "number", "minimum": 1e-100, "maximum": 1e100 },
{ "type": "number", "minimum": -1e100, "maximum": -1e-100 }
]
},
"categoryAxis": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": { "type": "string", "minLength": 1, "maxLength": 100 }
}
},
"valueAxis": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": { "type": "string", "minLength": 1, "maxLength": 100 },
"format": { "enum": ["number", "percent"], "default": "number" },
"decimals": {
"description": "Fixed decimal places for values in labels, tooltips, description and data table; axis ticks follow the tick step.",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"min": {
"description": "The axis reaches at least down to this value. Ends are rounded outward to a tick; bars always start at zero.",
"type": "number"
},
"max": {
"description": "The axis reaches at least up to this value.",
"type": "number"
},
"scale": {
"description": "linear (default) or log: powers of ten evenly spaced; every value must be above zero.",
"enum": ["linear", "log"],
"default": "linear"
},
"step": {
"description": "Distance between two ticks, instead of a round step chosen from the values.",
"type": "number",
"exclusiveMinimum": 0
},
"exact": {
"description": "min and max are the ends of the axis; every value has to lie between them.",
"type": "boolean",
"default": false
},
"unit": {
"description": "Time charts and small multiples: the unit of the values, written after the top tick label and after the column names of the data table, instead of a title above the plot.",
"type": "string",
"minLength": 1,
"maxLength": 20
},
"reverse": {
"description": "Run the axis the other way: larger values down or left.",
"type": "boolean",
"default": false
},
"thousandsSeparator": {
"description": "Separate thousands in every written value: 12,500 (en) or 12.500 (de).",
"type": "boolean",
"default": false
}
}
},
"timeAxis": {
"description": "The time axis of a type: \"time\" chart: Unix seconds or ISO 8601 timestamps.",
"type": "object",
"additionalProperties": false,
"properties": {
"timezone": {
"description": "UTC or a fixed offset such as +02:00. Timestamps without their own offset are read as wall-clock time in this zone.",
"type": "string",
"pattern": "^(UTC|utc|Z|[+-](0[0-9]|1[0-4]):[0-5][0-9])$",
"default": "UTC"
},
"gaps": {
"description": "show keeps the distances in time; collapse places every observed timestamp at the same distance from the next, so days without observations (weekends, holidays) take no space.",
"enum": ["show", "collapse"],
"default": "show"
},
"title": { "type": "string", "minLength": 1, "maxLength": 100 },
"precision": {
"description": "How finely tooltips, the data table and the description name an observation; absent, the coarsest form that tells the observations apart.",
"enum": ["year", "month", "day", "minute"]
},
"min": {
"description": "A position the time axis reaches at least, such as a round year before the first observation; it extends the axis and never cuts an observation off. Not with collapsed gaps.",
"$ref": "#/$defs/timeValue"
},
"max": {
"description": "A position the time axis reaches at least after the last observation. Not with collapsed gaps.",
"$ref": "#/$defs/timeValue"
},
"step": {
"description": "The distance between time ticks: whole years (1–1000) on a calendar axis, units on a numeric axis; ticks sit on its multiples. Labels that would overlap are left out.",
"type": "number",
"exclusiveMinimum": 0
},
"kind": {
"description": "calendar (default): timestamps. number: every time is a plain number, such as a distance or an age in millions of years.",
"enum": ["calendar", "number"],
"default": "calendar"
},
"reverse": {
"description": "Run the axis from right to left, the largest position at the left.",
"type": "boolean",
"default": false
}
}
},
"timeValue": {
"description": "Unix seconds between 1700-01-01 and 2200-01-01, an ISO 8601 date such as 2026-03-01 or 2026-03-01T12:00:00Z, or a year such as 1850 (January 1st); on a numeric time axis (timeAxis kind number) any number up to 1e9 either way.",
"anyOf": [
{ "type": "integer", "minimum": -8520336000, "maximum": 7258118399 },
{ "type": "number", "minimum": -1000000000, "maximum": 1000000000 },
{ "type": "string", "pattern": "^[0-9]{4}$" },
{ "type": "string", "minLength": 10, "maxLength": 25 }
]
},
"stripes": {
"description": "Warming stripes: one value per consecutive year from firstYear on; null leaves a year empty. The diverging scale has eight equal steps on either side of reference; min and max default to the largest distance from reference, and values beyond them take the outermost step.",
"type": "object",
"additionalProperties": false,
"required": ["firstYear", "values"],
"properties": {
"firstYear": { "type": "integer", "minimum": 1, "maximum": 9999 },
"values": {
"type": "array",
"minItems": 1,
"maxItems": 500,
"items": { "$ref": "#/$defs/value" }
},
"reference": { "type": "number", "default": 0 },
"min": { "type": "number" },
"max": { "type": "number" },
"yearLabels": {
"description": "Label the first and the last year under the stripes.",
"type": "boolean",
"default": true
},
"stretch": {
"description": "The stripes alone, filling the canvas without margins, title or year labels, in an SVG that stretches to the box the page gives it.",
"type": "boolean",
"default": false
}
}
},
"calendar": {
"description": "A calendar heatmap of one year. A day that is absent or null stays an empty cell. reference, min and max work as for stripes.",
"type": "object",
"additionalProperties": false,
"required": ["year", "days"],
"properties": {
"year": { "type": "integer", "minimum": 1700, "maximum": 2199 },
"layout": {
"description": "months: twelve rows of up to 31 days; weeks: seven weekday rows, one column per week.",
"enum": ["months", "weeks"],
"default": "months"
},
"days": {
"type": "array",
"minItems": 1,
"maxItems": 366,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["date", "value"],
"properties": {
"date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" },
"value": { "$ref": "#/$defs/value" }
}
}
},
"reference": { "type": "number", "default": 0 },
"min": { "type": "number" },
"max": { "type": "number" }
}
},
"range": {
"description": "One span of a rangebar chart; mid must lie between low and high.",
"type": "object",
"additionalProperties": false,
"required": ["label", "low", "high"],
"properties": {
"label": { "type": "string", "minLength": 1, "maxLength": 200 },
"low": { "type": "number" },
"high": { "type": "number" },
"mid": { "type": "number" },
"weight": { "description": "A forest plot: the central mark becomes a square whose area follows the weight. Above zero; needs mid.", "type": "number", "exclusiveMinimum": 0 },
"summary": { "description": "An overall result such as a pooled effect: drawn as a diamond from low to high, widest at mid, which it needs.", "type": "boolean", "default": false },
"modeled": { "type": "boolean", "default": false },
"group": {
"description": "The group of the span, drawn in its own palette color with a legend entry. Either every range names a group or none does; at most 4 groups.",
"type": "string",
"minLength": 1,
"maxLength": 60
}
}
},
"pane": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"description": "Heading of a small-multiples panel; required there, not allowed in a time chart, whose panes are named by their valueAxis title.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"note": {
"description": "Small multiples only: a short finding under the panel title, such as a verdict; up to two lines, also in the description.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"noteEmphasis": {
"description": "Small multiples, with a note: draws the note in the text color and semibold instead of muted.",
"type": "boolean",
"default": false
},
"heightRatio": {
"description": "Time charts: the pane's share of the plot height against the other panes. Small multiples keep the default.",
"type": "integer",
"minimum": 1,
"maximum": 10,
"default": 1
},
"values": {
"description": "Small multiples of bars: the panel's value for each of the chart's categories, in their order; null marks a missing value. Instead of layers.",
"type": "array",
"maxItems": 100,
"items": { "$ref": "#/$defs/value" }
},
"valueAxis": { "$ref": "#/$defs/valueAxis" },
"stack": {
"description": "Time charts: \"normal\" stacks the pane's area layers in layer order, each on top of the ones before it. At least two area layers with the same times and curve, a value of zero or more at every time, no lower/upper band.",
"const": "normal"
},
"layers": {
"description": "Up to 6 data layers (8 in a stacked pane) — on a time chart at most 4 line and area layers of the whole chart without their own color — and up to 6 annotation layers (zones, reference lines and point markers together).",
"type": "array",
"minItems": 1,
"maxItems": 14,
"items": { "$ref": "#/$defs/layer" }
}
}
},
"layer": {
"description": "One layer of a pane. Which fields apply depends on mark.",
"type": "object",
"additionalProperties": false,
"required": ["mark"],
"properties": {
"mark": {
"description": "line and area draw data, point draws a dot per observation and no line; ohlc draws candlesticks (time charts only); band is a zone; annotation is a reference line or, with both time and value, a point marker.",
"enum": ["line", "area", "point", "ohlc", "band", "annotation"]
},
"name": { "type": "string", "minLength": 1, "maxLength": 100 },
"color": {
"description": "#rgb, #rrggbb, #rrggbbaa, var(--name) or var(--name, #hex); the print variant draws the hex fallback. Anything else is reported and replaced by the neutral tone.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"points": {
"description": "Observations of a line or area layer.",
"type": "array",
"minItems": 1,
"maxItems": 2000,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["time", "value"],
"properties": {
"time": { "$ref": "#/$defs/timeValue" },
"value": {
"description": "null marks a missing observation: the line, its area and its band break there.",
"$ref": "#/$defs/value"
},
"lower": {
"description": "Lower edge of the uncertainty band; give lower and upper on every point of a layer that has a value, or on none. A point whose value is null has no band.",
"type": "number"
},
"upper": { "description": "Upper edge of the uncertainty band.", "type": "number" }
}
}
},
"data": {
"description": "Candlesticks of an ohlc layer, with increasing time; low at or below open and close, high at or above them.",
"type": "array",
"minItems": 2,
"maxItems": 2000,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["time", "open", "high", "low", "close"],
"properties": {
"time": { "$ref": "#/$defs/timeValue" },
"open": { "type": "number" },
"high": { "type": "number" },
"low": { "type": "number" },
"close": { "type": "number" }
}
}
},
"from": {
"description": "Start of a zone; missing, the zone begins at the plot's left edge.",
"$ref": "#/$defs/timeValue"
},
"to": {
"description": "End of a zone, after from; missing, the zone ends at the plot's right edge.",
"$ref": "#/$defs/timeValue"
},
"top": {
"description": "Upper edge of a zone, above bottom; missing, the zone reaches the top of the plot.",
"type": "number"
},
"bottom": {
"description": "Lower edge of a zone; missing, the zone reaches the bottom of the plot.",
"type": "number"
},
"time": {
"description": "Time of a vertical reference line or of a point marker.",
"$ref": "#/$defs/timeValue"
},
"value": {
"description": "Value of a horizontal reference line or of a point marker.",
"type": "number"
},
"label": {
"description": "Text of a reference line, point marker or zone; required there.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shape": {
"description": "Symbol of a point marker; circle by default. Only a point marker takes one.",
"enum": ["triangle-up", "triangle-down", "square", "circle", "diamond"]
},
"modeled": {
"description": "A line from a model: drawn dashed unless dash says otherwise, its band hatched, and named modeled in legend and description.",
"type": "boolean",
"default": false
},
"stroke": {
"description": "Line weight; thin sets a line back, for example single years under their mean, bold brings one forward, medium suits the lines of small panels.",
"enum": ["regular", "thin", "medium", "bold"],
"default": "regular"
},
"dash": {
"description": "Line pattern. Defaults to dashed for a modeled line and solid for any other.",
"enum": ["solid", "dashed", "dotted"]
},
"curve": {
"description": "Line and area only: linear (default) joins observations directly; step holds each value until the next observation.",
"enum": ["linear", "step"],
"default": "linear"
},
"precision": {
"description": "Data layers on a calendar axis: how this layer's times are written in tooltips, the table and the description; overrides timeAxis.precision.",
"enum": ["year", "month", "day", "minute"]
},
"stepEnd": {
"description": "Line and area with curve \"step\": where the last step ends; the last value holds until then. No observation of its own: no marker, tooltip or table row.",
"$ref": "#/$defs/timeValue"
},
"markers": {
"description": "Line and area only: false draws no markers, such as for a fitted line; tooltips stay on invisible targets.",
"type": "boolean"
}
},
"allOf": [
{
"if": { "properties": { "mark": { "enum": ["line", "area", "point"] } }, "required": ["mark"] },
"then": {
"required": ["points"],
"not": {
"anyOf": [
{ "required": ["data"] },
{ "required": ["from"] },
{ "required": ["to"] },
{ "required": ["top"] },
{ "required": ["bottom"] },
{ "required": ["time"] },
{ "required": ["value"] },
{ "required": ["label"] },
{ "required": ["shape"] }
]
}
}
},
{
"if": { "properties": { "mark": { "const": "ohlc" } }, "required": ["mark"] },
"then": {
"description": "Candlesticks: rising candles are hollow, falling ones filled, in --chartlet-rise and --chartlet-fall.",
"required": ["data"],
"not": {
"anyOf": [
{ "required": ["points"] },
{ "required": ["color"] },
{ "required": ["from"] },
{ "required": ["to"] },
{ "required": ["top"] },
{ "required": ["bottom"] },
{ "required": ["time"] },
{ "required": ["value"] },
{ "required": ["label"] },
{ "required": ["shape"] },
{ "required": ["modeled"] },
{ "required": ["stroke"] },
{ "required": ["dash"] }
]
}
}
},
{
"if": { "properties": { "mark": { "const": "annotation" } }, "required": ["mark"] },
"then": {
"description": "A reference line: value draws a horizontal one, time a vertical one; both draw a point marker, which alone takes a shape. label is required.",
"required": ["label"],
"anyOf": [{ "required": ["value"] }, { "required": ["time"] }],
"if": { "not": { "required": ["time", "value"] } },
"then": { "not": { "required": ["shape"] } },
"not": {
"anyOf": [
{ "required": ["name"] },
{ "required": ["points"] },
{ "required": ["data"] },
{ "required": ["from"] },
{ "required": ["to"] },
{ "required": ["top"] },
{ "required": ["bottom"] },
{ "required": ["modeled"] },
{ "required": ["stroke"] },
{ "required": ["dash"] }
]
}
}
},
{
"if": { "properties": { "mark": { "const": "band" } }, "required": ["mark"] },
"then": {
"description": "A zone between bottom and top, from and to, or both; a missing edge is the plot's edge. label is required.",
"required": ["label"],
"anyOf": [{ "required": ["bottom", "top"] }, { "required": ["from", "to"] }],
"not": {
"anyOf": [
{ "required": ["name"] },
{ "required": ["points"] },
{ "required": ["data"] },
{ "required": ["time"] },
{ "required": ["value"] },
{ "required": ["shape"] },
{ "required": ["modeled"] },
{ "required": ["stroke"] },
{ "required": ["dash"] }
]
}
}
}
]
}
}
}