basemapkit 0.1.3 → 0.2.0

package/dist/basemapkit.d.ts

@@ -110,7 +110,45 @@ export type GetStyleOptions = {
      * `glyphs` option unnecessary.
      */
     hideLabels?: boolean;
+    /**
+     * Adding terrain to the style. This includes options for both hillshading and bumpy terrain
+     */
+    terrain?: {
+        /**
+         * The public URL of a pmtiles files for raster terrain, encoded on RGB channels of either PNG or WebP. To use if sourcing tiles directly with
+         * range-request using the `pmtiles`'s protocol. Alternatively, the option `tileJson` can be used and will take precedence.
+         */
+        pmtiles?: string;
+        /**
+         * The public URL to a tile JSON file for raster terrain tiles, encoded on RGB channels of either PNG or WebP. To use if classic z/x/y MVT tiles are served through
+         * Maplibre's Martin or the pmtiles CLI. Will take precedence on the option `pmtiles` if both are provided.
+         */
+        tilejson?: string;
+        /**
+         * Encoding of the terrain raster data. Default: "mapbox"
+         */
+        encoding?: "mapbox" | "terrarium";
+        /**
+         * Enable or disable the hillshading. Enabled by default if one of the source options `terrain.pmtiles` or `terrain.tilejson` is provided.
+         * It cannot be enabled if none of the source option is provided.
+         */
+        hillshading?: boolean;
+        /**
+         * The terrain exaggeration is disabled by default, making the terrain flat even if one of the source options `terrain.pmtiles` or `terrain.tilejson` is provided.
+         * A value of `1` produces at-scale realistic terrain elevation.
+         * It cannot be enabled if none of the source option is provided.
+         */
+        exaggeration?: number;
+    };
 };
+/**
+ * Identifier of the terrain source within the Basemapkit source definition
+ */
+export declare const BASEMAPKIT_BASEMAP_SOURCE_ID = "__bmk_bm_src";
+/**
+ * Identifier of the terrain source within the Basemapkit style definition.
+ */
+export declare const BASEMAPKIT_TERRAIN_SOURCE_ID = "__bmk_tr_src";
 /**
  * Options relative to building a style
  */