OPF
SpecDefinition referenceView source

Dataset Ref

Chart data taken from a top-level dataset. Engines inline it before plotting; 'chart.mapping' names columns after the 'fields' selection.

Metadata

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

Field index

FieldTypeReq.Description
datasetref:DatasetIdyesId of the dataset. An unknown id is a 'dataset-unknown' error.
fieldsref:DatasetFields—The dataset columns to use, by name and in order. Absent uses every column.

dataset

typeref:DatasetIdrequiredyesdefault—

Id of the dataset. An unknown id is a 'dataset-unknown' error.

fields

typeref:DatasetFieldsrequirednodefault—

The dataset columns to use, by name and in order. Absent uses every column.

Complete definition constraints
Exact schema constraints
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "dataset"
  ],
  "description": "Chart data taken from a top-level dataset. Engines inline it before plotting; 'chart.mapping' names columns after the 'fields' selection.",
  "properties": {
    "dataset": {
      "$ref": "#/$defs/DatasetId",
      "description": "Id of the dataset. An unknown id is a 'dataset-unknown' error."
    },
    "fields": {
      "$ref": "#/$defs/DatasetFields",
      "description": "The dataset columns to use, by name and in order. Absent uses every column."
    }
  },
  "examples": [
    {
      "dataset": "revenue"
    },
    {
      "dataset": "revenue",
      "fields": [
        "Quarter",
        "Revenue"
      ]
    }
  ]
}