chartlet 0.1.0-alpha.3

Compile structured data into deterministic, accessible static charts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://casoon.github.io/chartlet/schema/v1.json",
  "title": "chartlet v1 alpha specification",
  "type": "object",
  "additionalProperties": false,
  "required": ["schemaVersion", "type", "title"],
  "properties": {
    "schemaVersion": { "const": 1 },
    "type": { "enum": ["bar", "line"] },
    "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 },
    "categoryAxis": { "$ref": "#/$defs/categoryAxis" },
    "valueAxis": { "$ref": "#/$defs/valueAxis" },
    "width": { "type": "integer", "minimum": 320, "maximum": 2400, "default": 800 },
    "height": { "type": "integer", "minimum": 240, "maximum": 1600, "default": 450 },
    "showValues": { "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" }
        }
      }
    },
    "categories": {
      "description": "Unique category labels shared by all series.",
      "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" } }
        }
      }
    },
    "zoomSteps": {
      "description": "Optional pre-computed zoom variants, selectable in the HTML profile.",
      "type": "array",
      "minItems": 2,
      "maxItems": 4,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": ["label", "from", "to"],
        "properties": {
          "label": { "type": "string", "minLength": 1, "maxLength": 40 },
          "from": { "type": "integer", "minimum": 0 },
          "to": { "type": "integer", "minimum": 0 }
        }
      }
    }
  },
  "allOf": [
    {
      "oneOf": [
        {
          "required": ["data"],
          "not": { "anyOf": [{ "required": ["categories"] }, { "required": ["series"] }] }
        },
        {
          "required": ["categories", "series"],
          "not": { "required": ["data"] }
        }
      ]
    },
    {
      "if": { "properties": { "type": { "const": "line" } } },
      "then": { "not": { "anyOf": [{ "required": ["orientation"] }, { "required": ["series"] }] } }
    }
  ],
  "$defs": {
    "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" }
      }
    }
  }
}