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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 16x 16x 16x 16x 16x 1x 1x 1x 1x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 1x 1x 4x 4x 1x 1x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 8x 8x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 17x 17x 17x 17x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 6x 6x 6x 10x 10x 10x 10x 10x 10x 10x 5x 5x 15x 15x 10x 6x 6x 1x 1x 1x 1x | import { fetchWithRetries, trimObject } from "../clientUtils/Util"
import { GitCommit, SubNavId } from "../clientUtils/owidTypes"
import {
DefaultNewExplorerSlug,
ExplorerChoiceParams,
EXPLORERS_ROUTE_FOLDER,
} from "./ExplorerConstants"
import {
columnDefinitionsFromDelimited,
CoreTable,
} from "../coreTable/CoreTable"
import {
CoreMatrix,
CoreTableInputOption,
TableSlug,
} from "../coreTable/CoreTableConstants"
import { ExplorerGrammar } from "./ExplorerGrammar"
import {
CellDef,
GridBoolean,
GRID_CELL_DELIMITER,
GRID_NODE_DELIMITER,
Grammar,
RootKeywordCellDef,
} from "../gridLang/GridLangConstants"
import { OwidTable } from "../coreTable/OwidTable"
import { GridProgram } from "../gridLang/GridProgram"
import { SerializedGridProgram } from "../clientUtils/owidTypes"
import { GrapherInterface } from "../grapher/core/GrapherInterface"
import { GrapherGrammar } from "./GrapherGrammar"
import { ColumnGrammar } from "./ColumnGrammar"
import { DecisionMatrix } from "./ExplorerDecisionMatrix"
import { CoreColumnDef } from "../coreTable/CoreColumnDef"
import { PromiseCache } from "../clientUtils/PromiseCache"
import { FacetAxisDomain } from "../grapher/core/GrapherConstants"
export const EXPLORER_FILE_SUFFIX = ".explorer.tsv"
export interface TableDef {
url?: string
columnDefinitions?: CoreColumnDef[]
inlineData?: string
}
interface ExplorerGrapherInterface extends GrapherInterface {
grapherId?: number
tableSlug?: string
yScaleToggle?: boolean
yAxisMin?: number
facetYDomain?: FacetAxisDomain
relatedQuestionText?: string
relatedQuestionUrl?: string
}
const ExplorerRootDef: CellDef = {
...RootKeywordCellDef,
grammar: ExplorerGrammar,
}
export class ExplorerProgram extends GridProgram {
constructor(slug: string, tsv: string, lastCommit?: GitCommit) {
super(slug, tsv, lastCommit, ExplorerRootDef)
this.decisionMatrix = new DecisionMatrix(
this.decisionMatrixCode ?? "",
lastCommit?.hash
)
}
decisionMatrix: DecisionMatrix
static fromJson(json: SerializedGridProgram) {
return new ExplorerProgram(json.slug, json.program, json.lastCommit)
}
get clone() {
return ExplorerProgram.fromJson(this.toJson())
}
get isNewFile() {
return this.slug === DefaultNewExplorerSlug
}
get filename() {
return this.slug + EXPLORER_FILE_SUFFIX
}
initDecisionMatrix(choiceParams: ExplorerChoiceParams) {
this.decisionMatrix.setValuesFromChoiceParams(choiceParams)
return this
}
get fullPath() {
return makeFullPath(this.slug)
}
get currentlySelectedGrapherRow() {
const row = this.getKeywordIndex(ExplorerGrammar.graphers.keyword)
return row === -1
? undefined
: row + this.decisionMatrix.selectedRowIndex + 2
}
static fromMatrix(slug: string, matrix: CoreMatrix) {
const str = matrix
.map((row) => row.join(GRID_CELL_DELIMITER))
.join(GRID_NODE_DELIMITER)
return new ExplorerProgram(slug, str)
}
get explorerTitle() {
return this.getLineValue(ExplorerGrammar.explorerTitle.keyword)
}
get title() {
return this.getLineValue(ExplorerGrammar.title.keyword)
}
get subNavId(): SubNavId | undefined {
return this.getLineValue(ExplorerGrammar.subNavId.keyword) as SubNavId
}
get googleSheet() {
return this.getLineValue(ExplorerGrammar.googleSheet.keyword)
}
get hideAlertBanner() {
return (
this.getLineValue(ExplorerGrammar.hideAlertBanner.keyword) ===
GridBoolean.true
)
}
get subNavCurrentId() {
return this.getLineValue(ExplorerGrammar.subNavCurrentId.keyword)
}
get thumbnail() {
return this.getLineValue(ExplorerGrammar.thumbnail.keyword)
}
get explorerSubtitle() {
return this.getLineValue(ExplorerGrammar.explorerSubtitle.keyword)
}
get entityType() {
return this.getLineValue(ExplorerGrammar.entityType.keyword)
}
get selection() {
return this.getLine(ExplorerGrammar.selection.keyword)
?.split(this.cellDelimiter)
.slice(1)
}
get pickerColumnSlugs() {
const slugs = this.getLineValue(
ExplorerGrammar.pickerColumnSlugs.keyword
)
return slugs ? slugs.split(" ") : undefined
}
get hideControls() {
return this.getLineValue(ExplorerGrammar.hideControls.keyword)
}
get downloadDataLink() {
return this.getLineValue(ExplorerGrammar.downloadDataLink.keyword)
}
get isPublished() {
return (
this.getLineValue(ExplorerGrammar.isPublished.keyword) ===
GridBoolean.true
)
}
setPublished(value: boolean) {
return this.clone.setLineValue(
ExplorerGrammar.isPublished.keyword,
value ? GridBoolean.true : GridBoolean.false
)
}
get wpBlockId() {
const blockIdString = this.getLineValue(
ExplorerGrammar.wpBlockId.keyword
)
return blockIdString ? parseInt(blockIdString, 10) : undefined
}
get decisionMatrixCode() {
const keywordIndex = this.getKeywordIndex(
ExplorerGrammar.graphers.keyword
)
if (keywordIndex === -1) return undefined
return this.getBlock(keywordIndex)
}
get grapherCount() {
return this.decisionMatrix.numRows || 1
}
get tableCount() {
return this.lines.filter((line) =>
line.startsWith(ExplorerGrammar.table.keyword)
).length
}
get inlineTableCount() {
return this.lines
.filter((line) => line.startsWith(ExplorerGrammar.table.keyword))
.filter((line) => {
const data = this.getTableDef(
line.split(this.cellDelimiter)[1]
)?.inlineData
return data ? data.trim() : false
}).length
}
get tableSlugs(): (TableSlug | undefined)[] {
return this.lines
.filter((line) => line.startsWith(ExplorerGrammar.table.keyword))
.map((line) => line.split(this.cellDelimiter)[2])
}
get columnDefsByTableSlug(): Map<TableSlug | undefined, CoreColumnDef[]> {
const columnDefs = new Map<TableSlug | undefined, CoreColumnDef[]>()
const colDefsRows = this.getAllRowsMatchingWords(
ExplorerGrammar.columns.keyword
)
for (const row of colDefsRows) {
const tableSlugs = this.asArrays[row].slice(1)
const columnDefinitions: CoreColumnDef[] =
columnDefinitionsFromDelimited(this.getBlock(row)).map((row) =>
trimAndParseObject(row, ColumnGrammar)
)
if (tableSlugs.length === 0)
columnDefs.set(undefined, columnDefinitions)
else
tableSlugs.forEach((tableSlug) => {
columnDefs.set(tableSlug, columnDefinitions)
})
}
return columnDefs
}
async replaceTableWithInlineDataAndAutofilledColumnDefsCommand(
tableSlug?: string
) {
const clone = this.clone
const colDefRow = clone.getRowMatchingWords(
ExplorerGrammar.columns.keyword,
tableSlug
)
if (colDefRow > -1) {
clone.deleteBlock(colDefRow)
clone.deleteLine(colDefRow)
}
const table = await clone.constructTable(tableSlug)
const tableDefRow = clone.getRowMatchingWords(
ExplorerGrammar.table.keyword,
undefined,
tableSlug
)
if (tableDefRow > -1) {
clone.deleteBlock(tableDefRow)
clone.deleteLine(tableDefRow)
}
const newCols = table!.autodetectedColumnDefs
const missing = newCols
.appendColumns([
{
slug: ColumnGrammar.notes.keyword,
values: newCols.indices.map(() => `Unreviewed`),
},
])
.select([
ColumnGrammar.slug.keyword,
,
ColumnGrammar.name.keyword,
,
ColumnGrammar.type.keyword,
ColumnGrammar.notes.keyword,
] as string[])
clone.appendBlock(ExplorerGrammar.table.keyword, table!.toTsv())
clone.appendBlock(ExplorerGrammar.columns.keyword, missing.toTsv())
return clone
}
async autofillMissingColumnDefinitionsForTableCommand(tableSlug?: string) {
const clone = this.clone
const remoteTable = await clone.constructTable(tableSlug)
const existingTableDef = this.getTableDef(tableSlug)
const table =
remoteTable ||
(existingTableDef
? new CoreTable(
existingTableDef.inlineData,
existingTableDef.columnDefinitions
)
: undefined)
const newCols = table!.autodetectedColumnDefs
const missing = newCols
.appendColumns([
{
slug: ColumnGrammar.notes.keyword,
values: newCols.indices.map(() => `Unreviewed`),
},
])
.select([
ColumnGrammar.slug.keyword,
,
ColumnGrammar.name.keyword,
,
ColumnGrammar.type.keyword,
ColumnGrammar.notes.keyword,
] as string[])
const colDefsRow = this.getRowMatchingWords(
ExplorerGrammar.columns.keyword,
tableSlug
)
if (colDefsRow !== -1)
clone.updateBlock(
colDefsRow,
new CoreTable(clone.getBlock(colDefsRow))
.concat([missing])
.toTsv()
)
else
clone.appendBlock(
`${ExplorerGrammar.columns.keyword}${
tableSlug ? this.cellDelimiter + tableSlug : ""
}`,
missing.toTsv()
)
return clone
}
get grapherConfig(): ExplorerGrapherInterface {
const rootObject = trimAndParseObject(this.tuplesObject, GrapherGrammar)
Object.keys(rootObject).forEach((key) => {
if (!GrapherGrammar[key]) delete rootObject[key]
})
const selectedGrapherRow = this.decisionMatrix.selectedRow
if (selectedGrapherRow && Object.keys(selectedGrapherRow).length) {
return { ...rootObject, ...selectedGrapherRow }
}
return rootObject
}
/**
* A static method so that all explorers on the page share requests,
* and no duplicate requests are sent.
*/
private static tableDataLoader = new PromiseCache(
async (url: string): Promise<CoreTableInputOption> => {
const response = await fetchWithRetries(url)
if (!response.ok) throw new Error(response.statusText)
const tableInput: CoreTableInputOption = url.endsWith(".json")
? await response.json()
: await response.text()
return tableInput
}
)
async constructTable(tableSlug?: TableSlug): Promise<OwidTable> {
const tableDef = this.getTableDef(tableSlug)
if (!tableDef) {
throw new Error(`Table definitions not found for '${tableSlug}'`)
}
if (tableDef.inlineData) {
return new OwidTable(
tableDef.inlineData,
tableDef.columnDefinitions,
{
tableDescription: `Loaded '${tableSlug}' from inline data`,
tableSlug: tableSlug,
}
).dropEmptyRows()
} else if (tableDef.url) {
const input = await ExplorerProgram.tableDataLoader.get(
tableDef.url
)
return new OwidTable(input, tableDef.columnDefinitions, {
tableDescription: `Loaded from ${tableDef.url}`,
})
}
throw new Error(`No data for table '${tableSlug}'`)
}
getTableDef(tableSlug?: TableSlug): TableDef | undefined {
const tableDefRow = this.getRowMatchingWords(
ExplorerGrammar.table.keyword,
undefined,
tableSlug
)
if (tableDefRow === -1) return undefined
const inlineData = this.getBlock(tableDefRow)
let url = inlineData
? undefined
: this.lines[tableDefRow].split(this.cellDelimiter)[1]
if (url && !url.startsWith("http")) {
const owidDatasetSlug = encodeURIComponent(url)
url = `https://raw.githubusercontent.com/owid/owid-datasets/master/datasets/${owidDatasetSlug}/${owidDatasetSlug}.csv`
}
const columnDefinitions: CoreColumnDef[] | undefined =
this.columnDefsByTableSlug.get(tableSlug)
return {
url,
columnDefinitions,
inlineData,
}
}
}
export const makeFullPath = (slug: string) =>
`${EXPLORERS_ROUTE_FOLDER}/${slug}${EXPLORER_FILE_SUFFIX}`
export const trimAndParseObject = (config: any, grammar: Grammar) => {
// Trim empty properties. Prevents things like clearing "type" which crashes Grapher. The call to grapher.reset will automatically clear things like title, subtitle, if not set.
const trimmedRow = trimObject(config, true) as any
// parse types
Object.keys(trimmedRow).forEach((key) => {
const def = grammar[key]
if (def && def.parse) trimmedRow[key] = def.parse(trimmedRow[key])
// If there no definition but it is a boolean, parse it (todo: always have a def)
else if (!def) {
const value = trimmedRow[key]
if (value === GridBoolean.true) trimmedRow[key] = true
else if (value === GridBoolean.false) trimmedRow[key] = false
}
})
return trimmedRow
}
|