Set default tileResolution=0.5, expand TSDoc descriptions

modules/carto/src/constants.ts

@@ -1,4 +1,5 @@
 export const DEFAULT_TILE_SIZE = 512;
+export const DEFAULT_TILE_RESOLUTION = 0.5;
 
 export const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
 export const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;

modules/carto/src/sources/types.ts

@@ -76,7 +76,17 @@ export type QuerySourceOptions = {
   sqlQuery: string;
 
   /**
-   * Relative resolution of a tile. Higher values increase density and data size. Default = 1.
+   * Relative resolution of a tile. Higher values increase density and data size. At tileResolution `1`, tile geometry is
+   * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
+   * the quantization grid proportionately.
+   *
+   * Supported `tileResolution` values, with corresponding grid sizes:
+   *
+   * - 0.25: 256x256
+   * - 0.5: 512x512
+   * - 1: 1024x1024
+   * - 2: 2048x2048
+   * - 4: 4096x4096
    */
   tileResolution?: TileResolution;
 
@@ -128,7 +138,17 @@ export type TableSourceOptions = {
   spatialDataColumn?: string;
 
   /**
-   * Relative resolution of a tile. Higher values increase density and data size. Default = 1.
+   * Relative resolution of a tile. Higher values increase density and data size. At tileResolution `1`, tile geometry is
+   * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
+   * the quantization grid proportionately.
+   *
+   * Supported `tileResolution` values, with corresponding grid sizes:
+   *
+   * - 0.25: 256x256
+   * - 0.5: 512x512
+   * - 1: 1024x1024
+   * - 2: 2048x2048
+   * - 4: 4096x4096
    */
   tileResolution?: TileResolution;
 };
@@ -165,7 +185,6 @@ export interface Tilejson {
   center: [number, number, number];
   vector_layers: VectorLayer[];
   tilestats: Tilestats;
-  /** Relative resolution of a tile. Higher values increase density and data size. */
   tileResolution?: TileResolution;
 }
 

modules/carto/src/sources/vector-query-source.ts

@@ -1,4 +1,5 @@
 /* eslint-disable camelcase */
+import {DEFAULT_TILE_RESOLUTION} from '../constants';
 import {baseSource} from './base-source';
 import type {
   FilterOptions,
@@ -31,7 +32,7 @@ export const vectorQuerySource = async function (
     filters,
     spatialDataColumn = 'geom',
     sqlQuery,
-    tileResolution = 1,
+    tileResolution = DEFAULT_TILE_RESOLUTION,
     queryParameters
   } = options;
 

modules/carto/src/sources/vector-table-source.ts

@@ -1,4 +1,5 @@
 /* eslint-disable camelcase */
+import {DEFAULT_TILE_RESOLUTION} from '../constants';
 import {baseSource} from './base-source';
 import type {
   FilterOptions,
@@ -21,7 +22,13 @@ type UrlParameters = {
 export const vectorTableSource = async function (
   options: VectorTableSourceOptions
 ): Promise<TilejsonResult> {
-  const {columns, filters, spatialDataColumn = 'geom', tableName, tileResolution = 1} = options;
+  const {
+    columns,
+    filters,
+    spatialDataColumn = 'geom',
+    tableName,
+    tileResolution = DEFAULT_TILE_RESOLUTION
+  } = options;
 
   const urlParameters: UrlParameters = {
     name: tableName,