OwidTable¶
Extends¶
CoreTable<OwidRow,OwidColumnDef>
Constructors¶
Constructor¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
CoreTableInputOption |
inputColumnDefs? |
string | OwidColumnDef[] |
advancedOptions? |
AdvancedOptions |
Returns¶
OwidTable
Inherited from¶
Properties¶
| Property | Type |
|---|---|
tableDescription |
string |
Accessors¶
autodetectedColumnDefs¶
Get Signature¶
Returns¶
CoreTable
Inherited from¶
transformCategory¶
Get Signature¶
Returns¶
TransformType
Inherited from¶
canReuseInputColumnStore¶
Get Signature¶
Returns¶
boolean
Inherited from¶
columnStore¶
Get Signature¶
Returns¶
CoreColumnStore
Inherited from¶
tableSlug¶
Get Signature¶
Returns¶
string | undefined
Inherited from¶
rows¶
Get Signature¶
Returns¶
ROW_TYPE[]
Inherited from¶
indices¶
Get Signature¶
Returns¶
number[]
Inherited from¶
firstRow¶
Get Signature¶
Returns¶
ROW_TYPE
Inherited from¶
lastRow¶
Get Signature¶
Returns¶
ROW_TYPE
Inherited from¶
numRows¶
Get Signature¶
Returns¶
number
Inherited from¶
numColumns¶
Get Signature¶
Returns¶
number
Inherited from¶
timeColumn¶
Get Signature¶
get timeColumn():
| TimeColumn<CoreTable<CoreRow, CoreColumnDef>, CoreColumnDef>
| MissingColumn<CoreTable<CoreRow, CoreColumnDef>, CoreColumnDef>;
Returns¶
| TimeColumn<CoreTable<CoreRow, CoreColumnDef>, CoreColumnDef>
| MissingColumn<CoreTable<CoreRow, CoreColumnDef>, CoreColumnDef>
Inherited from¶
numColumnsWithErrorValues¶
Get Signature¶
Returns¶
number
Inherited from¶
numErrorValues¶
Get Signature¶
Returns¶
number
Inherited from¶
numValidCells¶
Get Signature¶
Returns¶
number
Inherited from¶
colStoreIsEqualToParent¶
Get Signature¶
Returns¶
boolean
Inherited from¶
rootTable¶
Get Signature¶
Returns¶
this
Inherited from¶
defs¶
Get Signature¶
Returns¶
COL_DEF_TYPE[]
Inherited from¶
columnNames¶
Get Signature¶
Returns¶
string[]
Inherited from¶
columnTypes¶
Get Signature¶
Returns¶
(ColumnTypeNames | undefined)[]
Inherited from¶
columnJsTypes¶
Get Signature¶
Returns¶
JsTypes[]
Inherited from¶
columnSlugs¶
Get Signature¶
Returns¶
string[]
Inherited from¶
numericColumnSlugs¶
Get Signature¶
Returns¶
string[]
Inherited from¶
columnsAsArray¶
Get Signature¶
Returns¶
CoreColumn<this, COL_DEF_TYPE>[]
Inherited from¶
ancestors¶
Get Signature¶
Returns¶
this[]
Inherited from¶
availableEntityNames¶
Get Signature¶
Returns¶
any[]
availableEntityNameSet¶
Get Signature¶
Returns¶
Set<string>
entityNameColumn¶
Get Signature¶
Returns¶
OwidColumn
entityNameSlug¶
Get Signature¶
Returns¶
string
entityCodeColumn¶
Get Signature¶
Returns¶
OwidColumn
entityCodeSlug¶
Get Signature¶
Returns¶
string
entityIdColumn¶
Get Signature¶
Returns¶
OwidColumn
entityIdSlug¶
Get Signature¶
Returns¶
string
minTime¶
Get Signature¶
Returns¶
number | undefined
maxTime¶
Get Signature¶
Returns¶
number | undefined
timeRange¶
Get Signature¶
The first and last time in the table, undefined if it has no times
Returns¶
TimeRange | undefined
rowIndicesByEntityName¶
Get Signature¶
Returns¶
Map<string, number[]>
entityNameColorIndex¶
Get Signature¶
Returns¶
Map<string, string>
entityNameToCodeMap¶
Get Signature¶
Returns¶
Map<string, string>
columnDisplayNameToColorMap¶
Get Signature¶
Returns¶
Map<string, string>
isBlank¶
Get Signature¶
Returns¶
boolean
Methods¶
[iterator]()¶
Returns¶
Generator<CoreRow, void, unknown>
Inherited from¶
getTimesAtIndices()¶
Parameters¶
| Parameter | Type |
|---|---|
indices |
number[] |
Returns¶
number[]
Inherited from¶
getValuesAtIndices()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string |
indices |
number[] |
Returns¶
CoreValueType[]
Inherited from¶
get()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string | undefined |
Returns¶
CoreColumn<OwidTable, OwidColumnDef>
Inherited from¶
has()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string | undefined |
Returns¶
boolean
Inherited from¶
getFirstColumnWithType()¶
Parameters¶
| Parameter | Type |
|---|---|
columnTypeName |
ColumnTypeNames |
Returns¶
| CoreColumn<OwidTable, OwidColumnDef>
| undefined
Inherited from¶
rowIndex()¶
Returns a string map (aka index) where the keys are the combined string values of columnSlug[], and the values are the indices for the rows that match.
{country: "USA", population: 100}
So table.rowIndex(["country", "population"]).get("USA 100") would return [0].
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
Map<string, number[]>
Inherited from¶
grep()¶
Parameters¶
| Parameter | Type |
|---|---|
searchStringOrRegex |
string | RegExp |
Returns¶
this
Inherited from¶
rowFilter()¶
Parameters¶
| Parameter | Type |
|---|---|
predicate |
(row, index) => boolean |
opName |
string |
Returns¶
this
Inherited from¶
columnFilter()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string |
predicate |
(value, index) => boolean |
opName |
string |
Returns¶
this
Inherited from¶
sortBy()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
this
Inherited from¶
getColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
CoreColumn<OwidTable, OwidColumnDef>[]
Inherited from¶
domainFor()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
ValueRange
Inherited from¶
dump()¶
Parameters¶
| Parameter | Type |
|---|---|
rowLimit? |
number |
Returns¶
void
Inherited from¶
dumpPipeline()¶
Returns¶
void
Inherited from¶
dumpColumns()¶
Returns¶
void
Inherited from¶
rowsFrom()¶
Parameters¶
| Parameter | Type |
|---|---|
start |
number |
end |
number |
Returns¶
any
Inherited from¶
dumpRows()¶
Parameters¶
| Parameter | Type |
|---|---|
rowLimit? |
number |
Returns¶
void
Inherited from¶
dumpInputTable()¶
Returns¶
void
Inherited from¶
rowsAt()¶
Parameters¶
| Parameter | Type |
|---|---|
indices |
number[] |
Returns¶
OwidRow[]
Inherited from¶
findRows()¶
Parameters¶
| Parameter | Type |
|---|---|
query |
CoreQuery |
Returns¶
OwidRow[]
Inherited from¶
findRowsIndices()¶
Parameters¶
| Parameter | Type |
|---|---|
query |
CoreQuery |
Returns¶
any
Inherited from¶
indexOf()¶
Parameters¶
| Parameter | Type |
|---|---|
row |
OwidRow |
Returns¶
any
Inherited from¶
where()¶
Parameters¶
| Parameter | Type |
|---|---|
query |
CoreQuery |
Returns¶
this
Inherited from¶
appendRows()¶
Parameters¶
| Parameter | Type |
|---|---|
rows |
OwidRow[] |
opDescription |
string |
Returns¶
this
Inherited from¶
updateDefs()¶
Parameters¶
| Parameter | Type |
|---|---|
fn |
(def) => OwidColumnDef |
Returns¶
this
Inherited from¶
select()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
this
Inherited from¶
dropColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
message? |
string |
Returns¶
this
Inherited from¶
isRowEmpty()¶
Parameters¶
| Parameter | Type |
|---|---|
index |
number |
Returns¶
boolean
Inherited from¶
dropEmptyRows()¶
Returns¶
this
Inherited from¶
dropRowsWithErrorValuesForAnyColumn()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
this
Inherited from¶
dropRowsWithErrorValuesForAllColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
this
Inherited from¶
renameColumn()¶
Parameters¶
| Parameter | Type |
|---|---|
oldSlug |
string |
newSlug |
string |
Returns¶
this
Inherited from¶
renameColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
columnRenameMap |
{ [columnSlug: string]: string; } |
Returns¶
this
Inherited from¶
dropRowsAt()¶
Parameters¶
| Parameter | Type |
|---|---|
indices |
number[] |
message? |
string |
Returns¶
this
Inherited from¶
replaceCells()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
replaceFn |
(val, index) => CoreValueType |
Returns¶
this
Inherited from¶
combineColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
def |
OwidColumnDef |
combineFn |
(row, time) => CoreValueType |
Returns¶
this
Inherited from¶
replaceNonPositiveCellsForLogScale()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs? |
string[] |
Returns¶
this
Inherited from¶
replaceNegativeCellsWithErrorValues()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs? |
string[] |
Returns¶
this
Inherited from¶
replaceNonNumericCellsWithErrorValues()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
this
Inherited from¶
replaceRandomCells()¶
Parameters¶
| Parameter | Type |
|---|---|
howMany? |
number |
columnSlugs? |
string[] |
seed? |
number |
replacementGenerator? |
() => any |
Returns¶
this
Inherited from¶
appendColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
defs |
OwidColumnDef[] |
Returns¶
this
Inherited from¶
duplicateColumn()¶
Parameters¶
| Parameter | Type |
|---|---|
slug |
string |
overrides |
OwidColumnDef |
Returns¶
this
Inherited from¶
appendColumnsIfNew()¶
Parameters¶
| Parameter | Type |
|---|---|
defs |
OwidColumnDef[] |
Returns¶
this
Inherited from¶
toMatrix()¶
Returns¶
any[][]
Inherited from¶
toTypedMatrix()¶
Returns¶
any[][]
Inherited from¶
concat()¶
Parameters¶
| Parameter | Type |
|---|---|
tables |
CoreTable<CoreRow, CoreColumnDef>[] |
message? |
string |
Returns¶
this
Inherited from¶
complete()¶
Ensure a row exists for all values in columnSlug1 × columnSlug2 × ...
For example, if we have a table:
After complete(["entityName", "year"]), we'd get:
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
[string, string] |
Returns¶
this
Inherited from¶
getPreposition()¶
Parameters¶
| Parameter | Type |
|---|---|
col |
| CoreColumn<CoreTable<CoreRow, CoreColumnDef>, CoreColumnDef> | TimeColumn<CoreTable<CoreRow, CoreColumnDef>, CoreColumnDef> |
Returns¶
string
Inherited from¶
isOwidTable()¶
Returns¶
boolean
Overrides¶
fromUrl()¶
Parameters¶
| Parameter | Type |
|---|---|
url |
string |
columnDefs? |
OwidColumnDef[] |
Returns¶
Promise<OwidTable>
getAnnotationColumnSlug()¶
Parameters¶
| Parameter | Type |
|---|---|
columnDef |
OwidColumnDef |
Returns¶
string | undefined
getAnnotationColumnForColumn()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string |
Returns¶
OwidColumn
getTimesUniqSortedAscForColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
number[]
timeDomainFor()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
[number | undefined, number | undefined]
originalTimeDomainFor()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
[number | undefined, number | undefined]
filterByEntityNames()¶
Parameters¶
| Parameter | Type |
|---|---|
names |
string[] |
Returns¶
this
filterByEntityNamesUsingIncludeExcludePattern()¶
Parameters¶
| Parameter | Type |
|---|---|
__namedParameters |
{ excluded?: string[]; included?: string[]; } |
__namedParameters.excluded? |
string[] |
__namedParameters.included? |
string[] |
Returns¶
this
filterByTimeRange()¶
Parameters¶
| Parameter | Type |
|---|---|
start |
number |
end |
number |
Returns¶
this
filterByTargetTimes()¶
Parameters¶
| Parameter | Type |
|---|---|
targetTimes |
number[] |
tolerance? |
number |
Returns¶
this
hasAnyColumnNoValidValue()¶
Parameters¶
| Parameter | Type |
|---|---|
slugs |
string[] |
Returns¶
boolean
dropAllRows()¶
Returns¶
this
dropRowsWithErrorValuesForColumn()¶
Parameters¶
| Parameter | Type |
|---|---|
slug |
string |
Returns¶
this
dropEntitiesThatHaveNoDataInSomeColumn()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
this
dropEntitiesThatHaveSomeMissingOrErrorValueInAllColumns()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
this
toPercentageFromEachEntityForEachTime()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string |
Returns¶
this
toPercentageFromEachColumnForEachEntityAndTime()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
this
toTotalGrowthForEachColumnComparedToStartTime()¶
Parameters¶
| Parameter | Type |
|---|---|
startTimeBound |
number |
columnSlugs |
string[] |
Returns¶
this
keepMinTimeAndMaxTimeForEachEntityOnly()¶
Returns¶
this
toAverageAnnualChangeForEachEntity()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
this
toPrettyCsv()¶
Parameters¶
| Parameter | Type |
|---|---|
options? |
{ excludeColumns?: string[]; sortBy?: string[]; useShortNames?: boolean; } |
options.excludeColumns? |
string[] |
options.sortBy? |
string[] |
options.useShortNames? |
boolean |
Returns¶
string
toCsv()¶
Parameters¶
| Parameter | Type |
|---|---|
options? |
{ delimiter?: string; formatColumnName?: (col) => string; } |
options.delimiter? |
string |
options.formatColumnName? |
(col) => string |
Returns¶
string
getColorForEntityName()¶
Parameters¶
| Parameter | Type |
|---|---|
entityName |
string |
Returns¶
string | undefined
getLatestValueForEntity()¶
Parameters¶
| Parameter | Type |
|---|---|
entityName |
string |
columnSlug |
string |
Returns¶
CoreValueType | undefined
entitiesWith()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugs |
string[] |
Returns¶
Set<string>
interpolateColumnWithTolerance()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string |
__namedParameters? |
ToleranceOptions |
Returns¶
this
interpolateColumnLinearly()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlug |
string |
extrapolate? |
boolean |
Returns¶
this
interpolateColumnsByClosestTimeMatch()¶
Parameters¶
| Parameter | Type |
|---|---|
columnSlugA |
string |
columnSlugB |
string |
Returns¶
this
sampleEntityName()¶
Parameters¶
| Parameter | Type |
|---|---|
howMany? |
number |
Returns¶
any[]