Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9x 9x 9x 9x 9x 9x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import {
Grammar,
StringCellDef,
SlugsDeclarationCellDef,
IntegerCellDef,
SlugDeclarationCellDef,
BooleanCellDef,
EnumCellDef,
NumericCellDef,
CellDef,
UrlCellDef,
} from "../gridLang/GridLangConstants"
import {
ChartTypeName,
FacetAxisDomain,
FacetStrategy,
GrapherTabOption,
StackMode,
} from "../grapher/core/GrapherConstants"
import { ColorSchemes } from "../grapher/color/ColorSchemes"
import { SortBy, SortOrder } from "../clientUtils/owidTypes"
const toTerminalOptions = (keywords: string[]): CellDef[] => {
return keywords.map((keyword) => ({
keyword,
cssClass: "",
description: "",
}))
}
export const GrapherGrammar: Grammar = {
title: {
...StringCellDef,
keyword: "title",
description: "Chart title",
valuePlaceholder: "Life Expectancy around the world.",
},
subtitle: {
...StringCellDef,
keyword: "subtitle",
description: "Chart subtitle",
valuePlaceholder: "Life Expectancy has risen over time.",
},
ySlugs: {
...SlugsDeclarationCellDef,
description: "ColumnSlug(s) for the yAxis",
keyword: "ySlugs",
},
type: {
...StringCellDef,
keyword: "type",
description: `The type of chart to show such as LineChart or ScatterPlot.`,
terminalOptions: toTerminalOptions(Object.values(ChartTypeName)),
},
grapherId: {
...IntegerCellDef,
description: "ID of a legacy Grapher to load",
keyword: "grapherId",
},
tableSlug: {
...SlugDeclarationCellDef,
description: "Slug of the table to use.",
keyword: "tableSlug",
},
hasMapTab: {
...BooleanCellDef,
keyword: "hasMapTab",
description: "Show the map tab?",
},
tab: {
...EnumCellDef,
keyword: "tab",
description: "Which tab to show by default",
terminalOptions: toTerminalOptions(Object.values(GrapherTabOption)),
},
hasChartTab: {
...BooleanCellDef,
keyword: "hasChartTab",
description: "Show the chart tab?",
},
xSlug: {
...SlugDeclarationCellDef,
description: "ColumnSlug for the xAxis",
keyword: "xSlug",
},
colorSlug: {
...SlugDeclarationCellDef,
description: "ColumnSlug for the color",
keyword: "colorSlug",
},
sizeSlug: {
...SlugDeclarationCellDef,
description: "ColumnSlug for the size of points on scatters",
keyword: "sizeSlug",
},
tableSlugs: {
...SlugsDeclarationCellDef,
description:
"ColumnSlug(s) for the Table tab. If not specified all active slugs will be used.",
keyword: "tableSlugs",
},
sourceDesc: {
...StringCellDef,
keyword: "sourceDesc",
description: "Short comma-separated list of source names",
},
facet: {
...EnumCellDef,
description: "Facet by column or entities",
keyword: "facet",
terminalOptions: toTerminalOptions(Object.values(FacetStrategy)),
},
hideTitleAnnotation: {
...BooleanCellDef,
description: "Hide automatic time/entity",
keyword: "hideTitleAnnotation",
},
backgroundSeriesLimit: {
...IntegerCellDef,
description:
"Set this to limit the number of background series shown on ScatterPlots.",
keyword: "backgroundSeriesLimit",
},
yScaleToggle: {
...BooleanCellDef,
keyword: "yScaleToggle",
description: "Set to 'true' if the user can change the yAxis",
},
yAxisMin: {
...NumericCellDef,
keyword: "yAxisMin",
description: "Set the minimum value for the yAxis",
},
facetYDomain: {
...EnumCellDef,
keyword: "facetYDomain",
description:
"Whether facets axes default to shared or independent domain",
terminalOptions: toTerminalOptions(Object.values(FacetAxisDomain)),
},
selectedFacetStrategy: {
...EnumCellDef,
keyword: "selectedFacetStrategy",
description: "Whether the chart should be faceted or not",
terminalOptions: toTerminalOptions(Object.values(FacetStrategy)),
},
baseColorScheme: {
...EnumCellDef,
keyword: "baseColorScheme",
description:
"The default color scheme if no color overrides are specified",
terminalOptions: toTerminalOptions(Object.keys(ColorSchemes)),
},
note: {
...StringCellDef,
keyword: "note",
description: "Chart footnote",
},
sortBy: {
...EnumCellDef,
keyword: "sortBy",
description: "Specify what to sort the entities by",
terminalOptions: toTerminalOptions(Object.values(SortBy)),
},
sortOrder: {
...EnumCellDef,
keyword: "sortOrder",
description: "Whether to sort entities ascending or descending",
terminalOptions: toTerminalOptions(Object.values(SortOrder)),
},
sortColumnSlug: {
...SlugDeclarationCellDef,
keyword: "sortColumnSlug",
description:
"This setting is only respected when `sortBy` is set to `column`",
},
stackMode: {
...EnumCellDef,
keyword: "stackMode",
description:
"Show chart in absolute (default) or relative mode. Only works for some chart types.",
terminalOptions: toTerminalOptions(Object.values(StackMode)),
},
hideTotalValueLabel: {
...BooleanCellDef,
keyword: "hideTotalValueLabel",
description:
"Hide the total value that is normally displayed to the right of the bars in a stacked bar chart.",
},
timelineMinTime: {
...IntegerCellDef,
keyword: "timelineMinTime",
description:
"Set the minimum time for the timeline. For days, use days since 21 Jan 2020, e.g. 24 Jan 2020 is '3'.",
},
timelineMaxTime: {
...IntegerCellDef,
keyword: "timelineMaxTime",
description:
"Set the maximum time for the timeline. For days, use days since 21 Jan 2020, e.g. 24 Jan 2020 is '3'.",
},
defaultView: {
...BooleanCellDef,
keyword: "defaultView",
description: "Whether this view is used as the default view.",
},
relatedQuestionText: {
...StringCellDef,
keyword: "relatedQuestionText",
description:
"The text used for the related question (at the very bottom of the chart)",
},
relatedQuestionUrl: {
...UrlCellDef,
keyword: "relatedQuestionUrl",
description: "The link of the related question text",
},
} as const
|