References
ComputationType
Re-exports ComputationTypeType Aliases
ValuePortType
Ƭ ValuePortType:Extract<ComputationType, { kind: "value" }>
Not exported: an exported type refers to it.
CapturedValue
Ƭ CapturedValue:Readonly<{ type: ValuePortType ; [capturedValue]: true }>
An authoring reference, never an in-memory raster or a storage handle.
Arithmetic
Ƭ Arithmetic:"add" | "subtract" | "multiply" | "divide" | "remainder"
Not exported: an exported type refers to it.
DatePart
Ƭ DatePart:"year" | "month" | "day"
Not exported: an exported type refers to it.
TimeBucket
Ƭ TimeBucket:"minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"
Not exported: an exported type refers to it.
RasterReductionMeasure
Ƭ RasterReductionMeasure:"sum" | "mean" | "minimum" | "maximum"
Not exported: an exported type refers to it.
RasterExtent
Ƭ RasterExtent:Object
Type declaration
RasterGrid
Ƭ RasterGrid:Object
Type declaration
RasterBand
Ƭ RasterBand:Object
Type declaration
RasterType
Ƭ RasterType:Object
Type declaration
RasterResampling
Ƭ RasterResampling:"nearest" | "bilinear" | "cubic" | "average"
RasterMosaic
Ƭ RasterMosaic:"first" | "last" | "mean" | "sum"
RasterInclusion
Ƭ RasterInclusion:"center" | "all_touched"
RasterOperation
Ƭ RasterOperation: {kind: "select_bands" ; bands: string[] } | { kind: "window" ; extent: RasterExtent } | { kind: "resample" ; grid: RasterGrid ; resampling: RasterResampling } | { kind: "mosaic" ; precedence: RasterMosaic } | { kind: "map" ; inputs: string[] ; expression: NormalizedScalar ; band: RasterBand } | { kind: "mask" ; inclusion: RasterInclusion } | { kind: "cells" } | { kind: "zonal_statistics" ; inclusion: RasterInclusion ; measures: RasterReductionMeasure[] }
RasterAnalysis
Ƭ RasterAnalysis:Object
Type declaration
RasterBinding
Ƭ RasterBinding:Object
Type declaration
NativeOperation
Ƭ NativeOperation: {kind: "compare" ; operation: ScalarOperation } | { kind: "arithmetic" ; operation: Arithmetic } | { kind: "negate" } | { kind: "membership" } | { kind: "require_boolean" } | { kind: "require_present" } | { kind: "is_true" } | { kind: "like" ; pattern: string } | { kind: "date_part" ; part: DatePart } | { kind: "bucket" ; unit: TimeBucket } | { kind: "mean_change" } | { kind: "array_contains" } | { kind: "array_length" } | { kind: "geometry" ; operation: GeometryOperation ; space: GeometrySpace } | { kind: "spatial" ; operation: SpatialOperation ; space: GeometrySpace }
Not exported: an exported type refers to it.
NormalizedScalar
Ƭ NormalizedScalar: {kind: "clock" ; every_ms: number } | { kind: "array" ; operation: ArrayOperation ; input: NormalizedScalar ; body: NormalizedScalar ; initial: NormalizedScalar | null } | { kind: "array_binding" ; depth: number ; binding: ArrayBinding ; path: string[] } | { kind: "field" ; path: string[] } | { kind: "outer_field" ; depth: number ; path: string[] } | { kind: "local" ; name: string } | { kind: "outer_local" ; depth: number ; name: string } | { kind: "argument" ; name: string } | { kind: "literal" ; value: LiteralValue } | { kind: "apply" ; operation: ScalarOperation ; arguments: NormalizedScalar[] } | { kind: "native" ; operation: NativeOperation ; arguments: NormalizedScalar[] } | { kind: "case" ; branches: NormalizedBranch[] ; otherwise: NormalizedScalar } | { kind: "membership" ; value: NormalizedScalar ; members: LiteralValue[] } | { kind: "timestamp" ; operation: TimestampOperation ; value: NormalizedScalar } | { kind: "read" ; port: string ; arguments: { [key in string]?: NormalizedScalar } }
Not exported: an exported type refers to it.
NormalizedBranch
Ƭ NormalizedBranch:Object
Not exported: an exported type refers to it.
Type declaration
DecimalDomain
Ƭ DecimalDomain:Object
Not exported: an exported type refers to it.
Type declaration
LiteralValue
Ƭ LiteralValue: {kind: "missing" } | { kind: "null" } | { kind: "integer" ; value: string } | { kind: "float" ; value: string } | { kind: "boolean" ; value: boolean } | { kind: "text" ; value: string } | { kind: "reference" ; value: { table: string ; id: string } } | { kind: "bytes" ; value: string } | { kind: "geometry" ; value: { space: GeometrySpace ; wkb: string } } | { kind: "position" ; value: { space: GeometrySpace ; point_wkb: string ; accuracy_m: string | null } } | { kind: "list" ; value: LiteralValue[] } | { kind: "object" ; value: { [key in string]?: LiteralValue } } | { kind: "decimal" ; value: { text: string ; domain: DecimalDomain } } | { kind: "date" ; value: string } | { kind: "timestamp" ; value: string }
Not exported: an exported type refers to it.
ScalarOperation
Ƭ ScalarOperation:"struct" | "struct_update" | "split" | "parse_json" | "try_parse_json" | "regex_matches" | "regex_extract" | "regex_replace" | "json_at" | "try_json_at" | "json_keys" | "json_array_length" | { cast: { target: CastTarget ; on_invalid: InvalidValue } } | "equal" | "not_equal" | "less" | "less_equal" | "greater" | "greater_equal" | "add" | "subtract" | "multiply" | "divide" | "remainder" | "negate" | "and" | "or" | "not" | "coalesce" | "is_null" | "is_missing" | "least" | "greatest" | "trim" | "trim_left" | "trim_right" | "lower" | "upper" | "length" | "concat" | "substring" | "replace" | "array" | "array_length" | "array_at" | "array_contains" | "array_concat" | "array_slice" | "array_reverse" | "year" | "month" | "day" | "add_days" | "add_micros" | "difference_days"
Not exported: an exported type refers to it.
ArrayOperation
Ƭ ArrayOperation:"map" | "filter" | "reduce"
Not exported: an exported type refers to it.
ArrayBinding
Ƭ ArrayBinding:"element" | "index" | "accumulator"
Not exported: an exported type refers to it.
TimestampToken
Ƭ TimestampToken: {kind: "literal" ; text: string } | { kind: "year" } | { kind: "month" } | { kind: "day" } | { kind: "hour" } | { kind: "minute" } | { kind: "second" } | { kind: "fraction" ; digits: FractionDigits } | { kind: "offset" ; precision: OffsetPrecision }
Not exported: an exported type refers to it.
FractionDigits
Ƭ FractionDigits:number
Not exported: an exported type refers to it.
TimestampFidelity
Ƭ TimestampFidelity:"exact" | "display"
Not exported: an exported type refers to it.
TimestampOperation
Ƭ TimestampOperation: {kind: "parse" ; tokens: TimestampToken[] ; timezone: string | null ; on_invalid: InvalidValue } | { kind: "format" ; tokens: TimestampToken[] ; timezone: string ; fidelity: TimestampFidelity } | { kind: "to_date" ; timezone: string }
Not exported: an exported type refers to it.
InvalidValue
Ƭ InvalidValue:"error" | "null"
Not exported: an exported type refers to it.
Functions
rasterOperation
▸ rasterOperation(operation, ...inputs): CapturedValue
Parameters
Returns
CapturedValue
mapRaster
▸ mapRaster<Inputs>(inputs, expression, band): CapturedValue
Type parameters
Parameters
Returns
CapturedValue
rasterType
▸ rasterType(frame, bands, presence?): ComputationType
Parameters
Returns
ComputationType
validateRasterGrid
▸ validateRasterGrid(grid): RasterGrid
Parameters
Returns
RasterGrid
rasterPhysicalTransform
▸ rasterPhysicalTransform(grid): RasterGrid["transform"]
Parameters
Returns
RasterGrid["transform"]
alignedRasterGrids
▸ alignedRasterGrids(left, right): boolean
Parameters
Returns
boolean
windowRasterGrid
▸ windowRasterGrid(grid, extent): RasterGrid
Parameters
Returns
RasterGrid
analyzeRaster
▸ analyzeRaster(operator, inputs): RasterAnalysis
Parameters
Returns
RasterAnalysis
bindRaster
▸ bindRaster(operator, inputTypes, inputGrids): RasterBinding
Parameters
Returns
RasterBinding
analyzeRasterMap
▸ analyzeRasterMap<Inputs>(inputs, expression, band): RasterAnalysis
expression uses the ordinary q fields, arithmetic, case and null rules.
Type parameters
Parameters
Returns
RasterAnalysis