@carto/api-client 0.5.0-alpha.13 → 0.5.0-alpha.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/api-client.cjs +211 -478
- package/build/api-client.cjs.map +1 -1
- package/build/api-client.d.cts +57 -39
- package/build/api-client.d.ts +57 -39
- package/build/api-client.js +210 -470
- package/build/api-client.js.map +1 -1
- package/build/worker.js +110 -389
- package/build/worker.js.map +1 -1
- package/package.json +21 -20
- package/src/filters/tileFeatures.ts +26 -10
- package/src/filters/tileFeaturesRaster.ts +122 -0
- package/src/sources/raster-source.ts +18 -5
- package/src/sources/types.ts +14 -2
- package/src/types.ts +6 -2
- package/src/widget-sources/index.ts +1 -0
- package/src/widget-sources/widget-raster-source.ts +14 -0
- package/src/widget-sources/widget-tileset-source-impl.ts +13 -16
- package/src/widget-sources/widget-tileset-source.ts +20 -7
package/build/api-client.d.cts
CHANGED
|
@@ -96,8 +96,6 @@ type Tile = {
|
|
|
96
96
|
z: number;
|
|
97
97
|
};
|
|
98
98
|
id: string;
|
|
99
|
-
content: unknown;
|
|
100
|
-
zoom: number;
|
|
101
99
|
bbox: {
|
|
102
100
|
west: number;
|
|
103
101
|
east: number;
|
|
@@ -113,6 +111,14 @@ type SpatialIndexTile = Tile & {
|
|
|
113
111
|
id: bigint;
|
|
114
112
|
})[];
|
|
115
113
|
};
|
|
114
|
+
type RasterTile = Tile & {
|
|
115
|
+
id: string;
|
|
116
|
+
index: {
|
|
117
|
+
q: bigint;
|
|
118
|
+
i: string;
|
|
119
|
+
};
|
|
120
|
+
data?: Raster;
|
|
121
|
+
};
|
|
116
122
|
/** @privateRemarks Source: @deck.gl/carto */
|
|
117
123
|
type Raster = {
|
|
118
124
|
blockSize: number;
|
|
@@ -602,8 +608,9 @@ declare enum RasterBandColorinterp {
|
|
|
602
608
|
Alpha = "alpha",
|
|
603
609
|
Palette = "palette"
|
|
604
610
|
}
|
|
611
|
+
type RasterBandType = 'uint8' | 'int8' | 'uint16' | 'int16' | 'uint32' | 'int32' | 'uint64' | 'int64' | 'float32' | 'float64';
|
|
605
612
|
type RasterMetadataBand = {
|
|
606
|
-
type:
|
|
613
|
+
type: RasterBandType;
|
|
607
614
|
name: string;
|
|
608
615
|
stats: RasterMetadataBandStats;
|
|
609
616
|
/**
|
|
@@ -616,7 +623,7 @@ type RasterMetadataBand = {
|
|
|
616
623
|
/**
|
|
617
624
|
* Default color mapping for unique values (or if coloprinterp is `palette`)
|
|
618
625
|
*/
|
|
619
|
-
colortable?: Record<string, number
|
|
626
|
+
colortable?: Record<string, [number, number, number, number]>;
|
|
620
627
|
/**
|
|
621
628
|
* No value representation.
|
|
622
629
|
* Observed values:
|
|
@@ -984,36 +991,6 @@ declare class WidgetQuerySource extends WidgetRemoteSource<LayerQuerySourceOptio
|
|
|
984
991
|
protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
|
|
985
992
|
}
|
|
986
993
|
|
|
987
|
-
type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
|
|
988
|
-
type WidgetTableSourceResult = {
|
|
989
|
-
widgetSource: WidgetTableSource;
|
|
990
|
-
};
|
|
991
|
-
/**
|
|
992
|
-
* Source for Widget API requests on a data source defined as a table.
|
|
993
|
-
*
|
|
994
|
-
* Generally not intended to be constructed directly. Instead, call
|
|
995
|
-
* {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
|
|
996
|
-
* which can be shared with map layers. Sources contain a `widgetSource` property,
|
|
997
|
-
* for use by widget implementations.
|
|
998
|
-
*
|
|
999
|
-
* Example:
|
|
1000
|
-
*
|
|
1001
|
-
* ```javascript
|
|
1002
|
-
* import { vectorTableSource } from '@carto/api-client';
|
|
1003
|
-
*
|
|
1004
|
-
* const data = vectorTableSource({
|
|
1005
|
-
* accessToken: '••••',
|
|
1006
|
-
* connectionName: 'carto_dw',
|
|
1007
|
-
* tableName: 'carto-demo-data.demo_tables.retail_stores'
|
|
1008
|
-
* });
|
|
1009
|
-
*
|
|
1010
|
-
* const { widgetSource } = await data;
|
|
1011
|
-
* ```
|
|
1012
|
-
*/
|
|
1013
|
-
declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
|
|
1014
|
-
protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
|
|
1015
|
-
}
|
|
1016
|
-
|
|
1017
994
|
/**
|
|
1018
995
|
* @internal
|
|
1019
996
|
* @privateRemarks Exported for use in @deck.gl/carto's getDataFilterExtensionProps.
|
|
@@ -1053,6 +1030,7 @@ type TileFeatures = {
|
|
|
1053
1030
|
spatialDataColumn?: string;
|
|
1054
1031
|
spatialFilter: SpatialFilter;
|
|
1055
1032
|
uniqueIdProperty?: string;
|
|
1033
|
+
rasterMetadata?: RasterMetadata;
|
|
1056
1034
|
options?: TileFeatureExtractOptions;
|
|
1057
1035
|
};
|
|
1058
1036
|
/** @privateRemarks Source: @carto/react-core */
|
|
@@ -1061,7 +1039,7 @@ type TileFeatureExtractOptions = {
|
|
|
1061
1039
|
uniqueIdProperty?: string;
|
|
1062
1040
|
};
|
|
1063
1041
|
/** @privateRemarks Source: @carto/react-core */
|
|
1064
|
-
declare function tileFeatures({ tiles, spatialFilter, uniqueIdProperty, tileFormat, spatialDataColumn, spatialDataType, options, }: TileFeatures): FeatureData[];
|
|
1042
|
+
declare function tileFeatures({ tiles, spatialFilter, uniqueIdProperty, tileFormat, spatialDataColumn, spatialDataType, rasterMetadata, options, }: TileFeatures): FeatureData[];
|
|
1065
1043
|
|
|
1066
1044
|
declare const FEATURE_GEOM_PROPERTY = "__geomValue";
|
|
1067
1045
|
declare function tileFeaturesGeometries({ tiles, tileFormat, spatialFilter, uniqueIdProperty, options, }: {
|
|
@@ -1167,12 +1145,12 @@ type WidgetTilesetSourceResult = {
|
|
|
1167
1145
|
* const { widgetSource } = await data;
|
|
1168
1146
|
* ```
|
|
1169
1147
|
*/
|
|
1170
|
-
declare class WidgetTilesetSource extends WidgetSource<
|
|
1148
|
+
declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps> extends WidgetSource<Props> {
|
|
1171
1149
|
protected _localImpl: WidgetTilesetSourceImpl | null;
|
|
1172
1150
|
protected _workerImpl: Worker | null;
|
|
1173
1151
|
protected _workerEnabled: boolean;
|
|
1174
1152
|
protected _workerNextRequestId: number;
|
|
1175
|
-
constructor(props:
|
|
1153
|
+
constructor(props: Props);
|
|
1176
1154
|
destroy(): void;
|
|
1177
1155
|
/**
|
|
1178
1156
|
* Returns an initialized Worker, to be reused for the lifecycle of this
|
|
@@ -1208,6 +1186,46 @@ declare class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
|
|
|
1208
1186
|
getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
|
|
1209
1187
|
}
|
|
1210
1188
|
|
|
1189
|
+
type WidgetRasterSourceProps = WidgetTilesetSourceProps & {
|
|
1190
|
+
rasterMetadata: RasterMetadata;
|
|
1191
|
+
spatialDataType: 'quadbin';
|
|
1192
|
+
};
|
|
1193
|
+
type WidgetRasterSourceResult = {
|
|
1194
|
+
widgetSource: WidgetRasterSource;
|
|
1195
|
+
};
|
|
1196
|
+
declare class WidgetRasterSource extends WidgetTilesetSource<WidgetRasterSourceProps> {
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
|
|
1200
|
+
type WidgetTableSourceResult = {
|
|
1201
|
+
widgetSource: WidgetTableSource;
|
|
1202
|
+
};
|
|
1203
|
+
/**
|
|
1204
|
+
* Source for Widget API requests on a data source defined as a table.
|
|
1205
|
+
*
|
|
1206
|
+
* Generally not intended to be constructed directly. Instead, call
|
|
1207
|
+
* {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
|
|
1208
|
+
* which can be shared with map layers. Sources contain a `widgetSource` property,
|
|
1209
|
+
* for use by widget implementations.
|
|
1210
|
+
*
|
|
1211
|
+
* Example:
|
|
1212
|
+
*
|
|
1213
|
+
* ```javascript
|
|
1214
|
+
* import { vectorTableSource } from '@carto/api-client';
|
|
1215
|
+
*
|
|
1216
|
+
* const data = vectorTableSource({
|
|
1217
|
+
* accessToken: '••••',
|
|
1218
|
+
* connectionName: 'carto_dw',
|
|
1219
|
+
* tableName: 'carto-demo-data.demo_tables.retail_stores'
|
|
1220
|
+
* });
|
|
1221
|
+
*
|
|
1222
|
+
* const { widgetSource } = await data;
|
|
1223
|
+
* ```
|
|
1224
|
+
*/
|
|
1225
|
+
declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
|
|
1226
|
+
protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1211
1229
|
type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
|
|
1212
1230
|
type H3QuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
|
|
1213
1231
|
declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<H3QuerySourceResponse>;
|
|
@@ -1221,7 +1239,7 @@ type H3TilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
|
|
|
1221
1239
|
declare const h3TilesetSource: (options: H3TilesetSourceOptions) => Promise<H3TilesetSourceResponse>;
|
|
1222
1240
|
|
|
1223
1241
|
type RasterSourceOptions = SourceOptions & TilesetSourceOptions & FilterOptions;
|
|
1224
|
-
type RasterSourceResponse = TilejsonResult;
|
|
1242
|
+
type RasterSourceResponse = TilejsonResult & WidgetRasterSourceResult;
|
|
1225
1243
|
declare const rasterSource: (options: RasterSourceOptions) => Promise<RasterSourceResponse>;
|
|
1226
1244
|
|
|
1227
1245
|
type QuadbinQuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
|
|
@@ -1396,4 +1414,4 @@ declare function makeIntervalComplete(intervals: FilterInterval[]): FilterInterv
|
|
|
1396
1414
|
*/
|
|
1397
1415
|
declare function transformToTileCoords<T extends Geometry>(geometry: T, bbox: BBox): T;
|
|
1398
1416
|
|
|
1399
|
-
export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, ApiVersion, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GeojsonResult, type GetFilterOptions, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type JsonResult, type MapType, type NamedQueryParameter, type PositionalQueryParameter, Provider, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RemoveFilterOptions, SOURCE_DEFAULTS, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SortColumnType, type SortDirection, type SourceOptions, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, type SpatialIndexTile, type StringSearchOptions, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type TilejsonResult, type TilesetSourceOptions, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, getDataFilterExtensionProps, getFilter, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
|
|
1417
|
+
export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, ApiVersion, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GeojsonResult, type GetFilterOptions, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type JsonResult, type MapType, type NamedQueryParameter, type PositionalQueryParameter, Provider, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, SOURCE_DEFAULTS, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SortColumnType, type SortDirection, type SourceOptions, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, type SpatialIndexTile, type StringSearchOptions, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type TilejsonResult, type TilesetSourceOptions, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRasterSource, type WidgetRasterSourceProps, type WidgetRasterSourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, getDataFilterExtensionProps, getFilter, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
|
package/build/api-client.d.ts
CHANGED
|
@@ -96,8 +96,6 @@ type Tile = {
|
|
|
96
96
|
z: number;
|
|
97
97
|
};
|
|
98
98
|
id: string;
|
|
99
|
-
content: unknown;
|
|
100
|
-
zoom: number;
|
|
101
99
|
bbox: {
|
|
102
100
|
west: number;
|
|
103
101
|
east: number;
|
|
@@ -113,6 +111,14 @@ type SpatialIndexTile = Tile & {
|
|
|
113
111
|
id: bigint;
|
|
114
112
|
})[];
|
|
115
113
|
};
|
|
114
|
+
type RasterTile = Tile & {
|
|
115
|
+
id: string;
|
|
116
|
+
index: {
|
|
117
|
+
q: bigint;
|
|
118
|
+
i: string;
|
|
119
|
+
};
|
|
120
|
+
data?: Raster;
|
|
121
|
+
};
|
|
116
122
|
/** @privateRemarks Source: @deck.gl/carto */
|
|
117
123
|
type Raster = {
|
|
118
124
|
blockSize: number;
|
|
@@ -602,8 +608,9 @@ declare enum RasterBandColorinterp {
|
|
|
602
608
|
Alpha = "alpha",
|
|
603
609
|
Palette = "palette"
|
|
604
610
|
}
|
|
611
|
+
type RasterBandType = 'uint8' | 'int8' | 'uint16' | 'int16' | 'uint32' | 'int32' | 'uint64' | 'int64' | 'float32' | 'float64';
|
|
605
612
|
type RasterMetadataBand = {
|
|
606
|
-
type:
|
|
613
|
+
type: RasterBandType;
|
|
607
614
|
name: string;
|
|
608
615
|
stats: RasterMetadataBandStats;
|
|
609
616
|
/**
|
|
@@ -616,7 +623,7 @@ type RasterMetadataBand = {
|
|
|
616
623
|
/**
|
|
617
624
|
* Default color mapping for unique values (or if coloprinterp is `palette`)
|
|
618
625
|
*/
|
|
619
|
-
colortable?: Record<string, number
|
|
626
|
+
colortable?: Record<string, [number, number, number, number]>;
|
|
620
627
|
/**
|
|
621
628
|
* No value representation.
|
|
622
629
|
* Observed values:
|
|
@@ -984,36 +991,6 @@ declare class WidgetQuerySource extends WidgetRemoteSource<LayerQuerySourceOptio
|
|
|
984
991
|
protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
|
|
985
992
|
}
|
|
986
993
|
|
|
987
|
-
type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
|
|
988
|
-
type WidgetTableSourceResult = {
|
|
989
|
-
widgetSource: WidgetTableSource;
|
|
990
|
-
};
|
|
991
|
-
/**
|
|
992
|
-
* Source for Widget API requests on a data source defined as a table.
|
|
993
|
-
*
|
|
994
|
-
* Generally not intended to be constructed directly. Instead, call
|
|
995
|
-
* {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
|
|
996
|
-
* which can be shared with map layers. Sources contain a `widgetSource` property,
|
|
997
|
-
* for use by widget implementations.
|
|
998
|
-
*
|
|
999
|
-
* Example:
|
|
1000
|
-
*
|
|
1001
|
-
* ```javascript
|
|
1002
|
-
* import { vectorTableSource } from '@carto/api-client';
|
|
1003
|
-
*
|
|
1004
|
-
* const data = vectorTableSource({
|
|
1005
|
-
* accessToken: '••••',
|
|
1006
|
-
* connectionName: 'carto_dw',
|
|
1007
|
-
* tableName: 'carto-demo-data.demo_tables.retail_stores'
|
|
1008
|
-
* });
|
|
1009
|
-
*
|
|
1010
|
-
* const { widgetSource } = await data;
|
|
1011
|
-
* ```
|
|
1012
|
-
*/
|
|
1013
|
-
declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
|
|
1014
|
-
protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
|
|
1015
|
-
}
|
|
1016
|
-
|
|
1017
994
|
/**
|
|
1018
995
|
* @internal
|
|
1019
996
|
* @privateRemarks Exported for use in @deck.gl/carto's getDataFilterExtensionProps.
|
|
@@ -1053,6 +1030,7 @@ type TileFeatures = {
|
|
|
1053
1030
|
spatialDataColumn?: string;
|
|
1054
1031
|
spatialFilter: SpatialFilter;
|
|
1055
1032
|
uniqueIdProperty?: string;
|
|
1033
|
+
rasterMetadata?: RasterMetadata;
|
|
1056
1034
|
options?: TileFeatureExtractOptions;
|
|
1057
1035
|
};
|
|
1058
1036
|
/** @privateRemarks Source: @carto/react-core */
|
|
@@ -1061,7 +1039,7 @@ type TileFeatureExtractOptions = {
|
|
|
1061
1039
|
uniqueIdProperty?: string;
|
|
1062
1040
|
};
|
|
1063
1041
|
/** @privateRemarks Source: @carto/react-core */
|
|
1064
|
-
declare function tileFeatures({ tiles, spatialFilter, uniqueIdProperty, tileFormat, spatialDataColumn, spatialDataType, options, }: TileFeatures): FeatureData[];
|
|
1042
|
+
declare function tileFeatures({ tiles, spatialFilter, uniqueIdProperty, tileFormat, spatialDataColumn, spatialDataType, rasterMetadata, options, }: TileFeatures): FeatureData[];
|
|
1065
1043
|
|
|
1066
1044
|
declare const FEATURE_GEOM_PROPERTY = "__geomValue";
|
|
1067
1045
|
declare function tileFeaturesGeometries({ tiles, tileFormat, spatialFilter, uniqueIdProperty, options, }: {
|
|
@@ -1167,12 +1145,12 @@ type WidgetTilesetSourceResult = {
|
|
|
1167
1145
|
* const { widgetSource } = await data;
|
|
1168
1146
|
* ```
|
|
1169
1147
|
*/
|
|
1170
|
-
declare class WidgetTilesetSource extends WidgetSource<
|
|
1148
|
+
declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps> extends WidgetSource<Props> {
|
|
1171
1149
|
protected _localImpl: WidgetTilesetSourceImpl | null;
|
|
1172
1150
|
protected _workerImpl: Worker | null;
|
|
1173
1151
|
protected _workerEnabled: boolean;
|
|
1174
1152
|
protected _workerNextRequestId: number;
|
|
1175
|
-
constructor(props:
|
|
1153
|
+
constructor(props: Props);
|
|
1176
1154
|
destroy(): void;
|
|
1177
1155
|
/**
|
|
1178
1156
|
* Returns an initialized Worker, to be reused for the lifecycle of this
|
|
@@ -1208,6 +1186,46 @@ declare class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
|
|
|
1208
1186
|
getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
|
|
1209
1187
|
}
|
|
1210
1188
|
|
|
1189
|
+
type WidgetRasterSourceProps = WidgetTilesetSourceProps & {
|
|
1190
|
+
rasterMetadata: RasterMetadata;
|
|
1191
|
+
spatialDataType: 'quadbin';
|
|
1192
|
+
};
|
|
1193
|
+
type WidgetRasterSourceResult = {
|
|
1194
|
+
widgetSource: WidgetRasterSource;
|
|
1195
|
+
};
|
|
1196
|
+
declare class WidgetRasterSource extends WidgetTilesetSource<WidgetRasterSourceProps> {
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
|
|
1200
|
+
type WidgetTableSourceResult = {
|
|
1201
|
+
widgetSource: WidgetTableSource;
|
|
1202
|
+
};
|
|
1203
|
+
/**
|
|
1204
|
+
* Source for Widget API requests on a data source defined as a table.
|
|
1205
|
+
*
|
|
1206
|
+
* Generally not intended to be constructed directly. Instead, call
|
|
1207
|
+
* {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
|
|
1208
|
+
* which can be shared with map layers. Sources contain a `widgetSource` property,
|
|
1209
|
+
* for use by widget implementations.
|
|
1210
|
+
*
|
|
1211
|
+
* Example:
|
|
1212
|
+
*
|
|
1213
|
+
* ```javascript
|
|
1214
|
+
* import { vectorTableSource } from '@carto/api-client';
|
|
1215
|
+
*
|
|
1216
|
+
* const data = vectorTableSource({
|
|
1217
|
+
* accessToken: '••••',
|
|
1218
|
+
* connectionName: 'carto_dw',
|
|
1219
|
+
* tableName: 'carto-demo-data.demo_tables.retail_stores'
|
|
1220
|
+
* });
|
|
1221
|
+
*
|
|
1222
|
+
* const { widgetSource } = await data;
|
|
1223
|
+
* ```
|
|
1224
|
+
*/
|
|
1225
|
+
declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
|
|
1226
|
+
protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1211
1229
|
type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
|
|
1212
1230
|
type H3QuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
|
|
1213
1231
|
declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<H3QuerySourceResponse>;
|
|
@@ -1221,7 +1239,7 @@ type H3TilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
|
|
|
1221
1239
|
declare const h3TilesetSource: (options: H3TilesetSourceOptions) => Promise<H3TilesetSourceResponse>;
|
|
1222
1240
|
|
|
1223
1241
|
type RasterSourceOptions = SourceOptions & TilesetSourceOptions & FilterOptions;
|
|
1224
|
-
type RasterSourceResponse = TilejsonResult;
|
|
1242
|
+
type RasterSourceResponse = TilejsonResult & WidgetRasterSourceResult;
|
|
1225
1243
|
declare const rasterSource: (options: RasterSourceOptions) => Promise<RasterSourceResponse>;
|
|
1226
1244
|
|
|
1227
1245
|
type QuadbinQuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
|
|
@@ -1396,4 +1414,4 @@ declare function makeIntervalComplete(intervals: FilterInterval[]): FilterInterv
|
|
|
1396
1414
|
*/
|
|
1397
1415
|
declare function transformToTileCoords<T extends Geometry>(geometry: T, bbox: BBox): T;
|
|
1398
1416
|
|
|
1399
|
-
export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, ApiVersion, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GeojsonResult, type GetFilterOptions, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type JsonResult, type MapType, type NamedQueryParameter, type PositionalQueryParameter, Provider, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RemoveFilterOptions, SOURCE_DEFAULTS, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SortColumnType, type SortDirection, type SourceOptions, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, type SpatialIndexTile, type StringSearchOptions, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type TilejsonResult, type TilesetSourceOptions, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, getDataFilterExtensionProps, getFilter, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
|
|
1417
|
+
export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, ApiVersion, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GeojsonResult, type GetFilterOptions, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type JsonResult, type MapType, type NamedQueryParameter, type PositionalQueryParameter, Provider, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, SOURCE_DEFAULTS, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SortColumnType, type SortDirection, type SourceOptions, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, type SpatialIndexTile, type StringSearchOptions, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type TilejsonResult, type TilesetSourceOptions, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRasterSource, type WidgetRasterSourceProps, type WidgetRasterSourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, getDataFilterExtensionProps, getFilter, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
|