SpecDefinition referenceView source

Chart Axis Titles

Titles for the axes of a chart. 'category' is the axis that carries the row labels (the horizontal axis of a column or line chart, the vertical axis of a bar chart, the X axis of a scatter chart); 'value' is the other axis; 'secondary' is the secondary value axis of a combo chart.

Metadata

Definition: #/$defs/ChartAxisTitles
Form: object
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
category	string	—	Title of the category (X) axis.
value	string	—	Title of the value (Y) axis. On a combo chart, the primary (left) value axis.
secondary	string	—	Combo charts only: title of the secondary value axis at the right of the plot, drawn rotated like the primary value axis title. Dropped with a 'chart-option-adapted' diagnostic on any other chart type and on a combo chart without 'secondaryAxis'.

`category`

typestringrequirednodefault—

Title of the category (X) axis.

Field fragment · category.json

{
  "category": "Quarter"
}

`value`

typestringrequirednodefault—

Title of the value (Y) axis. On a combo chart, the primary (left) value axis.

Field fragment · value.json

{
  "value": "Revenue ($M)"
}

`secondary`

typestringrequirednodefault—

Combo charts only: title of the secondary value axis at the right of the plot, drawn rotated like the primary value axis title. Dropped with a 'chart-option-adapted' diagnostic on any other chart type and on a combo chart without 'secondaryAxis'.

Field fragment · secondary.json

{
  "secondary": "Margin (%)"
}

Complete definition constraints

Exact schema constraints

{
  "type": "object",
  "additionalProperties": false,
  "description": "Titles for the axes of a chart. 'category' is the axis that carries the row labels (the horizontal axis of a column or line chart, the vertical axis of a bar chart, the X axis of a scatter chart); 'value' is the other axis; 'secondary' is the secondary value axis of a combo chart.",
  "properties": {
    "category": {
      "type": "string",
      "description": "Title of the category (X) axis.",
      "examples": [
        "Quarter",
        "Region"
      ]
    },
    "value": {
      "type": "string",
      "description": "Title of the value (Y) axis. On a combo chart, the primary (left) value axis.",
      "examples": [
        "Revenue ($M)",
        "Customers"
      ]
    },
    "secondary": {
      "type": "string",
      "description": "Combo charts only: title of the secondary value axis at the right of the plot, drawn rotated like the primary value axis title. Dropped with a 'chart-option-adapted' diagnostic on any other chart type and on a combo chart without 'secondaryAxis'.",
      "examples": [
        "Margin (%)"
      ]
    }
  }
}