@feltmaps/js-sdk 1.10.2 → 1.11.0-next.1

package/dist/controller-bundled.d.ts

@@ -6100,12 +6100,28 @@ interface RasterLayerSource {
     bands: Array<RasterBand>;
 }
 /**
- * The RasterBand interface describes the metadata for a raster band, necessary for
- * calculating the encoded raster value from the red, green, and blue values of the pixel.
+ * The RasterBand interface describes one band of a raster: how to identify it when
+ * asking for statistics, what to call it, and the values needed to calculate the
+ * encoded raster value from the red, green, and blue values of a pixel.
  *
  * @group Layer sources
  */
 interface RasterBand {
+    /**
+     * The identifier for this band, such as `"band:1"`.
+     *
+     * Pass this to the raster statistics methods, such as
+     * {@link LayersController.getRasterAggregates}, and use it to refer to the band
+     * inside a filter.
+     */
+    id: string;
+    /**
+     * The name of the band, such as "Red" or "Elevation".
+     *
+     * Felt takes this from the raster itself when the file names its bands, and
+     * falls back to "Band 1", "Band 2" and so on.
+     */
+    displayName: string;
     /**
      * Encoding base value as a floating point number
      */
@@ -8188,6 +8204,519 @@ interface GetLayerPrecomputedCalculationParams extends TypeOf<typeof GetLayerPre
     gridConfig: GridConfig;
 }
 
+declare const RasterAggregationMethodSchema: ZodEnum<["avg", "min", "max", "sum", "median", "stddev", "majority", "area"]>;
+/**
+ * A statistic that can be calculated for a raster band.
+ *
+ * `area` is the ground area of the selected pixels, in square metres.
+ *
+ * `majority`, the most common value, needs a band holding whole numbers.
+ *
+ * @group Stats
+ */
+type RasterAggregationMethod = TypeOf<typeof RasterAggregationMethodSchema>;
+declare const GetRasterAggregatesParamsSchema: ZodObject<objectUtil.extendShape<{
+    layerId: ZodString;
+    bandId: ZodString;
+    boundary: ZodOptional<ZodUnion<[ZodTuple<[ZodNumber, ZodNumber, ZodNumber, ZodNumber], null>, ZodObject<{
+        type: ZodLiteral<"Polygon">;
+        coordinates: ZodArray<ZodEffects<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    }, {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    }>, ZodObject<{
+        type: ZodLiteral<"MultiPolygon">;
+        coordinates: ZodArray<ZodArray<ZodEffects<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    }, {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    }>, ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">]>>;
+    filters: ZodOptional<ZodUnion<[ZodType<FilterTernary, ZodTypeDef, FilterTernary>, ZodUnion<[ZodTuple<[ZodUnion<[ZodString, ZodNull]>, ZodEnum<["in", "ni"]>, ZodUnion<[ZodArray<ZodUnion<[ZodNumber, ZodString, ZodBoolean, ZodNull]>, "many">, ZodNull]>], null>, ZodTuple<[ZodUnion<[ZodString, ZodNull]>, ZodEnum<["lt", "gt", "le", "ge", "eq", "ne", "cn", "nc", "is", "isnt"]>, ZodUnion<[ZodNumber, ZodString, ZodBoolean, ZodNull]>], null>]>, ZodNull, ZodBoolean]>>;
+}, {
+    aggregation: ZodObject<{
+        methods: ZodArray<ZodEnum<["avg", "min", "max", "sum", "median", "stddev", "majority", "area"]>, "many">;
+        percentiles: ZodOptional<ZodArray<ZodNumber, "many">>;
+    }, "strip", ZodTypeAny, {
+        methods: ("avg" | "max" | "min" | "sum" | "median" | "stddev" | "majority" | "area")[];
+        percentiles?: number[] | undefined;
+    }, {
+        methods: ("avg" | "max" | "min" | "sum" | "median" | "stddev" | "majority" | "area")[];
+        percentiles?: number[] | undefined;
+    }>;
+}>, "strip", ZodTypeAny, {
+    layerId: string;
+    aggregation: {
+        methods: ("avg" | "max" | "min" | "sum" | "median" | "stddev" | "majority" | "area")[];
+        percentiles?: number[] | undefined;
+    };
+    bandId: string;
+    filters?: boolean | FilterTernary | [string | null, "in" | "ni", (string | number | boolean | null)[] | null] | [string | null, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", string | number | boolean | null] | null | undefined;
+    boundary?: [number, number, number, number] | [number, number][] | {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    } | undefined;
+}, {
+    layerId: string;
+    aggregation: {
+        methods: ("avg" | "max" | "min" | "sum" | "median" | "stddev" | "majority" | "area")[];
+        percentiles?: number[] | undefined;
+    };
+    bandId: string;
+    filters?: boolean | FilterTernary | [string | null, "in" | "ni", (string | number | boolean | null)[] | null] | [string | null, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", string | number | boolean | null] | null | undefined;
+    boundary?: [number, number, number, number] | [number, number][] | {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    } | undefined;
+}>;
+/**
+ * The parameters for calculating statistics for a raster band, passed to the
+ * {@link LayersController.getRasterAggregates} method.
+ *
+ * @group Stats
+ */
+interface GetRasterAggregatesParams<T extends RasterAggregationMethod> extends zInfer<typeof GetRasterAggregatesParamsSchema> {
+    /**
+     * The ID of the band to calculate statistics for, read from the `bands` on a
+     * raster layer's source.
+     */
+    bandId: string;
+    /**
+     * The spatial boundary for the pixels to include. Omit this to cover the whole
+     * raster.
+     */
+    boundary?: GeometryFilter;
+    /**
+     * Filters on band values for the pixels to include, such as
+     * `["band:1", "gt", 100]`.
+     */
+    filters?: Filters;
+    /**
+     * Which statistics to calculate for the band.
+     */
+    aggregation: {
+        /**
+         * The statistics to calculate for the band.
+         */
+        methods: T[];
+        /**
+         * Percentile ranks between 0 and 100 to calculate, such as `[10, 50, 90]`.
+         */
+        percentiles?: number[];
+    };
+}
+declare const RasterPercentileSchema: ZodObject<{
+    /**
+     * The percentile rank that was requested.
+     */
+    rank: ZodNumber;
+    /**
+     * The band value at this rank.
+     */
+    value: ZodNullable<ZodNumber>;
+}, "strip", ZodTypeAny, {
+    value: number | null;
+    rank: number;
+}, {
+    value: number | null;
+    rank: number;
+}>;
+/**
+ * One percentile from the response to the
+ * {@link LayersController.getRasterAggregates} method.
+ *
+ * @group Stats
+ */
+interface RasterPercentile extends zInfer<typeof RasterPercentileSchema> {
+}
+/**
+ * The response from the {@link LayersController.getRasterAggregates} method.
+ *
+ * @group Stats
+ */
+interface GetRasterAggregatesResult<T extends RasterAggregationMethod> {
+    /**
+     * The value calculated for each requested statistic.
+     *
+     * `null` is returned when the boundary and filters selected no pixels, as
+     * opposed to zero, so as not to confuse an empty selection with a real zero.
+     */
+    stats: Record<T, number | null>;
+    /**
+     * The requested percentiles, in the order they were requested. Present only
+     * when percentile ranks were requested.
+     */
+    percentiles?: Array<RasterPercentile>;
+}
+declare const GetRasterHistogramParamsSchema: ZodObject<objectUtil.extendShape<{
+    layerId: ZodString;
+    bandId: ZodString;
+    boundary: ZodOptional<ZodUnion<[ZodTuple<[ZodNumber, ZodNumber, ZodNumber, ZodNumber], null>, ZodObject<{
+        type: ZodLiteral<"Polygon">;
+        coordinates: ZodArray<ZodEffects<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    }, {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    }>, ZodObject<{
+        type: ZodLiteral<"MultiPolygon">;
+        coordinates: ZodArray<ZodArray<ZodEffects<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    }, {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    }>, ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">]>>;
+    filters: ZodOptional<ZodUnion<[ZodType<FilterTernary, ZodTypeDef, FilterTernary>, ZodUnion<[ZodTuple<[ZodUnion<[ZodString, ZodNull]>, ZodEnum<["in", "ni"]>, ZodUnion<[ZodArray<ZodUnion<[ZodNumber, ZodString, ZodBoolean, ZodNull]>, "many">, ZodNull]>], null>, ZodTuple<[ZodUnion<[ZodString, ZodNull]>, ZodEnum<["lt", "gt", "le", "ge", "eq", "ne", "cn", "nc", "is", "isnt"]>, ZodUnion<[ZodNumber, ZodString, ZodBoolean, ZodNull]>], null>]>, ZodNull, ZodBoolean]>>;
+}, {
+    steps: ZodUnion<[ZodObject<{
+        type: ZodLiteral<"equal-intervals">;
+        count: ZodNumber;
+    }, "strip", ZodTypeAny, {
+        type: "equal-intervals";
+        count: number;
+    }, {
+        type: "equal-intervals";
+        count: number;
+    }>, ZodArray<ZodNumber, "many">]>;
+}>, "strip", ZodTypeAny, {
+    layerId: string;
+    steps: number[] | {
+        type: "equal-intervals";
+        count: number;
+    };
+    bandId: string;
+    filters?: boolean | FilterTernary | [string | null, "in" | "ni", (string | number | boolean | null)[] | null] | [string | null, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", string | number | boolean | null] | null | undefined;
+    boundary?: [number, number, number, number] | [number, number][] | {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    } | undefined;
+}, {
+    layerId: string;
+    steps: number[] | {
+        type: "equal-intervals";
+        count: number;
+    };
+    bandId: string;
+    filters?: boolean | FilterTernary | [string | null, "in" | "ni", (string | number | boolean | null)[] | null] | [string | null, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", string | number | boolean | null] | null | undefined;
+    boundary?: [number, number, number, number] | [number, number][] | {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    } | undefined;
+}>;
+/**
+ * The parameters for requesting a histogram of a raster band's values, passed to
+ * the {@link LayersController.getRasterHistogramData} method.
+ *
+ * @group Stats
+ */
+interface GetRasterHistogramParams extends zInfer<typeof GetRasterHistogramParamsSchema> {
+    /**
+     * The ID of the band to bin, read from the `bands` on a raster layer's source.
+     */
+    bandId: string;
+    /**
+     * The spatial boundary for the pixels to include. Omit this to cover the whole
+     * raster.
+     */
+    boundary?: GeometryFilter;
+    /**
+     * Filters on band values for the pixels to include.
+     */
+    filters?: Filters;
+    /**
+     * How to divide the band's values into bins, either as a number of equal
+     * intervals or as the bin edges themselves.
+     */
+    steps: {
+        type: "equal-intervals";
+        count: number;
+    } | number[];
+}
+declare const RasterHistogramBinSchema: ZodObject<{
+    /**
+     * The left edge of the bin.
+     */
+    min: ZodNumber;
+    /**
+     * The right edge of the bin.
+     */
+    max: ZodNumber;
+    /**
+     * The number of pixels in the bin.
+     */
+    value: ZodNumber;
+}, "strip", ZodTypeAny, {
+    value: number;
+    max: number;
+    min: number;
+}, {
+    value: number;
+    max: number;
+    min: number;
+}>;
+/**
+ * One bin from the response to the
+ * {@link LayersController.getRasterHistogramData} method.
+ *
+ * @group Stats
+ */
+interface RasterHistogramBin extends zInfer<typeof RasterHistogramBinSchema> {
+}
+/**
+ * The response from the {@link LayersController.getRasterHistogramData} method.
+ *
+ * @group Stats
+ */
+interface GetRasterHistogramResult {
+    /**
+     * The bins, in ascending order of value.
+     */
+    bins: Array<RasterHistogramBin>;
+}
+declare const GetRasterCategoriesParamsSchema: ZodObject<objectUtil.extendShape<{
+    layerId: ZodString;
+    bandId: ZodString;
+    boundary: ZodOptional<ZodUnion<[ZodTuple<[ZodNumber, ZodNumber, ZodNumber, ZodNumber], null>, ZodObject<{
+        type: ZodLiteral<"Polygon">;
+        coordinates: ZodArray<ZodEffects<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    }, {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    }>, ZodObject<{
+        type: ZodLiteral<"MultiPolygon">;
+        coordinates: ZodArray<ZodArray<ZodEffects<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    }, {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    }>, ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">]>>;
+    filters: ZodOptional<ZodUnion<[ZodType<FilterTernary, ZodTypeDef, FilterTernary>, ZodUnion<[ZodTuple<[ZodUnion<[ZodString, ZodNull]>, ZodEnum<["in", "ni"]>, ZodUnion<[ZodArray<ZodUnion<[ZodNumber, ZodString, ZodBoolean, ZodNull]>, "many">, ZodNull]>], null>, ZodTuple<[ZodUnion<[ZodString, ZodNull]>, ZodEnum<["lt", "gt", "le", "ge", "eq", "ne", "cn", "nc", "is", "isnt"]>, ZodUnion<[ZodNumber, ZodString, ZodBoolean, ZodNull]>], null>]>, ZodNull, ZodBoolean]>>;
+}, {
+    limit: ZodOptional<ZodNumber>;
+}>, "strip", ZodTypeAny, {
+    layerId: string;
+    bandId: string;
+    filters?: boolean | FilterTernary | [string | null, "in" | "ni", (string | number | boolean | null)[] | null] | [string | null, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", string | number | boolean | null] | null | undefined;
+    boundary?: [number, number, number, number] | [number, number][] | {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    } | undefined;
+    limit?: number | undefined;
+}, {
+    layerId: string;
+    bandId: string;
+    filters?: boolean | FilterTernary | [string | null, "in" | "ni", (string | number | boolean | null)[] | null] | [string | null, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", string | number | boolean | null] | null | undefined;
+    boundary?: [number, number, number, number] | [number, number][] | {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    } | undefined;
+    limit?: number | undefined;
+}>;
+/**
+ * The parameters for counting the distinct values of a raster band, passed to the
+ * {@link LayersController.getRasterCategoryData} method.
+ *
+ * @group Stats
+ */
+interface GetRasterCategoriesParams extends zInfer<typeof GetRasterCategoriesParamsSchema> {
+    /**
+     * The ID of the band to count values for, read from the `bands` on a raster
+     * layer's source.
+     */
+    bandId: string;
+    /**
+     * The spatial boundary for the pixels to include. Omit this to cover the whole
+     * raster.
+     */
+    boundary?: GeometryFilter;
+    /**
+     * Filters on band values for the pixels to include.
+     */
+    filters?: Filters;
+    /**
+     * The maximum number of categories to return. The most frequent categories are
+     * kept.
+     */
+    limit?: number;
+}
+declare const RasterCategorySchema: ZodObject<{
+    /**
+     * The band value this category counts.
+     */
+    key: ZodNumber;
+    /**
+     * The number of pixels holding this value.
+     */
+    value: ZodNumber;
+    /**
+     * The ground area of this category's pixels, in square metres. Absent for a
+     * line boundary, which samples points and so has no area.
+     */
+    areaM2: ZodOptional<ZodNumber>;
+}, "strip", ZodTypeAny, {
+    value: number;
+    key: number;
+    areaM2?: number | undefined;
+}, {
+    value: number;
+    key: number;
+    areaM2?: number | undefined;
+}>;
+/**
+ * One category from the response to the
+ * {@link LayersController.getRasterCategoryData} method.
+ *
+ * @group Stats
+ */
+interface RasterCategory extends zInfer<typeof RasterCategorySchema> {
+}
+/**
+ * The response from the {@link LayersController.getRasterCategoryData} method.
+ *
+ * @group Stats
+ */
+interface GetRasterCategoriesResult {
+    /**
+     * The categories, most frequent first.
+     */
+    categories: Array<RasterCategory>;
+    /**
+     * How many distinct values the band holds within the scope, which is larger
+     * than the number of categories returned when `limit` drops some.
+     */
+    total: number;
+}
+declare const GetRasterProfileParamsSchema: ZodObject<{
+    layerId: ZodString;
+    bandId: ZodString;
+    boundary: ZodUnion<[ZodObject<{
+        type: ZodLiteral<"LineString">;
+        coordinates: ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "LineString";
+        coordinates: [number, number][];
+    }, {
+        type: "LineString";
+        coordinates: [number, number][];
+    }>, ZodObject<{
+        type: ZodLiteral<"MultiLineString">;
+        coordinates: ZodArray<ZodArray<ZodTuple<[ZodNumber, ZodNumber], null>, "many">, "many">;
+    }, "strip", ZodTypeAny, {
+        type: "MultiLineString";
+        coordinates: [number, number][][];
+    }, {
+        type: "MultiLineString";
+        coordinates: [number, number][][];
+    }>]>;
+}, "strip", ZodTypeAny, {
+    layerId: string;
+    boundary: {
+        type: "LineString";
+        coordinates: [number, number][];
+    } | {
+        type: "MultiLineString";
+        coordinates: [number, number][][];
+    };
+    bandId: string;
+}, {
+    layerId: string;
+    boundary: {
+        type: "LineString";
+        coordinates: [number, number][];
+    } | {
+        type: "MultiLineString";
+        coordinates: [number, number][][];
+    };
+    bandId: string;
+}>;
+/**
+ * The parameters for sampling a raster band along a line, passed to the
+ * {@link LayersController.getRasterProfile} method.
+ *
+ * @group Stats
+ */
+interface GetRasterProfileParams extends zInfer<typeof GetRasterProfileParamsSchema> {
+    /**
+     * The ID of the band to sample, read from the `bands` on a raster layer's
+     * source.
+     */
+    bandId: string;
+    /**
+     * The line to sample the band along. The band is sampled at roughly one sample
+     * per pixel along the line's length.
+     */
+    boundary: LineStringGeometry | MultiLineStringGeometry;
+}
+declare const RasterProfileSampleSchema: ZodObject<{
+    /**
+     * How far along the line this sample was taken, in ground metres from the
+     * line's start.
+     */
+    distanceM: ZodNumber;
+    /**
+     * The band's value at this sample, or `null` where the raster holds no data or
+     * the line runs outside the raster.
+     */
+    value: ZodNullable<ZodNumber>;
+}, "strip", ZodTypeAny, {
+    value: number | null;
+    distanceM: number;
+}, {
+    value: number | null;
+    distanceM: number;
+}>;
+/**
+ * One sample from the response to the {@link LayersController.getRasterProfile}
+ * method.
+ *
+ * @group Stats
+ */
+interface RasterProfileSample extends zInfer<typeof RasterProfileSampleSchema> {
+}
+/**
+ * The response from the {@link LayersController.getRasterProfile} method.
+ *
+ * @group Stats
+ */
+interface GetRasterProfileResult {
+    /**
+     * The samples, ordered from the line's start.
+     */
+    samples: Array<RasterProfileSample>;
+}
+
 /**
  * The Layers controller allows you to get information about the layers on the
  * map, and make changes to their visibility.
@@ -9007,6 +9536,112 @@ interface LayersController {
         sum: number | null;
         count: number | null;
     }>;
+    /**
+     * Calculates statistics for a raster band.
+     *
+     * @remarks
+     * Summarizes the pixel values of one band of a raster layer. Omit the boundary
+     * to summarize the whole raster, or pass a bounding box or polygon to summarize
+     * part of it. Filters restrict the summary to pixels whose band values match a
+     * condition.
+     *
+     * @example
+     * ```typescript
+     * // Band IDs come from the layer, so read them rather than writing them out
+     * const layer = await felt.getLayer("elevation");
+     * const bandId = layer.source.bands[0].id;
+     *
+     * // The elevation range of the whole raster, since no boundary is given
+     * const elevation = await felt.getRasterAggregates({
+     *   layerId: layer.id,
+     *   bandId,
+     *   aggregation: { methods: ["min", "max", "avg"] },
+     * });
+     *
+     * // How much ground inside a parcel sits above 2,000 metres
+     * const highGround = await felt.getRasterAggregates({
+     *   layerId: layer.id,
+     *   bandId,
+     *   aggregation: { methods: ["area"] },
+     *   boundary: parcel,
+     *   filters: [bandId, "gt", 2000],
+     * });
+     *
+     * // The elevation that the steepest tenth of the raster sits above
+     * const steep = await felt.getRasterAggregates({
+     *   layerId: layer.id,
+     *   bandId,
+     *   aggregation: { methods: [], percentiles: [90] },
+     * });
+     * ```
+     */
+    getRasterAggregates<T extends RasterAggregationMethod>(params: GetRasterAggregatesParams<T>): Promise<GetRasterAggregatesResult<T>>;
+    /**
+     * Calculates a histogram of a raster band's values.
+     *
+     * @remarks
+     * Divides a band's values into bins and counts the pixels falling into each one.
+     * You can pass a number of equal intervals, or the bin edges themselves when you
+     * already know how you want the values divided.
+     *
+     * @example
+     * ```typescript
+     * // The whole raster's elevation distribution in ten equal intervals
+     * const elevation = await felt.getRasterHistogramData({
+     *   layerId: layer.id,
+     *   bandId,
+     *   steps: { type: "equal-intervals", count: 10 },
+     * });
+     *
+     * // The same bins, counting only the pixels inside a watershed
+     * const inWatershed = await felt.getRasterHistogramData({
+     *   layerId: layer.id,
+     *   bandId,
+     *   steps: [0, 500, 1000, 1500, 2000, 3000],
+     *   boundary: watershed,
+     * });
+     * ```
+     */
+    getRasterHistogramData(params: GetRasterHistogramParams): Promise<GetRasterHistogramResult>;
+    /**
+     * Counts the pixels holding each distinct value of a raster band.
+     *
+     * @remarks
+     * This suits a band whose values are class codes, such as a land cover raster.
+     * Each category reports how many pixels hold the value and how much ground they
+     * cover. A band whose values are not whole numbers cannot be counted this way,
+     * and throws.
+     *
+     * @example
+     * ```typescript
+     * // How much of a county each land cover class covers
+     * const landCover = await felt.getRasterCategoryData({
+     *   layerId: layer.id,
+     *   bandId,
+     *   boundary: county,
+     *   limit: 10,
+     * });
+     * ```
+     */
+    getRasterCategoryData(params: GetRasterCategoriesParams): Promise<GetRasterCategoriesResult>;
+    /**
+     * Samples a raster band's values along a line.
+     *
+     * @remarks
+     * Returns the values themselves rather than a summary of them, each paired with
+     * how far along the line it was taken. This is what an elevation profile along a
+     * route is drawn from.
+     *
+     * @example
+     * ```typescript
+     * const profile = await felt.getRasterProfile({
+     *   layerId: layer.id,
+     *   bandId,
+     *   boundary: route,
+     * });
+     * ```
+     */
+    getRasterProfile(params: GetRasterProfileParams): Promise<GetRasterProfileResult>;
     /**
      * Get the schema for a layer.
      *
@@ -14956,20 +15591,46 @@ declare const UiControlsOptionsSchema: ZodObject<{
      * @defaultValue true
      */
     scaleBar: ZodOptional<ZodBoolean>;
+    /**
+     * Whether or not the map can be rotated.
+     *
+     * @remarks
+     * This affects all rotation interactions — dragging with the right mouse
+     * button or Ctrl held, two-finger touch rotation, and keyboard shortcuts —
+     * as well as the compass control, which is hidden when rotation is
+     * disabled.
+     *
+     * @defaultValue true
+     */
+    rotation: ZodOptional<ZodBoolean>;
+    /**
+     * Whether or not the right-click context menu is available on the map.
+     *
+     * @remarks
+     * When disabled, right-clicking the map opens neither Felt's context menu
+     * nor the browser's own.
+     *
+     * @defaultValue true
+     */
+    contextMenu: ZodOptional<ZodBoolean>;
 }, "strip", ZodTypeAny, {
+    rotation?: boolean | undefined;
     showLegend?: boolean | undefined;
     cooperativeGestures?: boolean | undefined;
     fullScreenButton?: boolean | undefined;
     geolocation?: boolean | undefined;
     zoomControls?: boolean | undefined;
     scaleBar?: boolean | undefined;
+    contextMenu?: boolean | undefined;
 }, {
+    rotation?: boolean | undefined;
     showLegend?: boolean | undefined;
     cooperativeGestures?: boolean | undefined;
     fullScreenButton?: boolean | undefined;
     geolocation?: boolean | undefined;
     zoomControls?: boolean | undefined;
     scaleBar?: boolean | undefined;
+    contextMenu?: boolean | undefined;
 }>;
 /**
  * The options for which parts of the Felt UI can be shown when interacting with
@@ -15806,4 +16467,4 @@ interface FeltController extends ViewportController, UiController, LayersControl
     iframe: HTMLIFrameElement | null;
 }
 
-export { type GeoJsonDataVectorSource as $, type PlaceElementRead as A, type BasemapsController as B, type ColorBasemap as C, type PlaceElementUpdate as D, type Element as E, type FeltController as F, type GetElementGroupsConstraint as G, type HighlighterElementCreate as H, type ImageElementCreate as I, type PolygonElementCreate as J, type PolygonElementRead as K, type LinkElementRead as L, type MarkerElementCreate as M, type NoteElementCreate as N, type PolygonElementUpdate as O, type PathElementCreate as P, type TextElementRead as Q, type TextElementUpdate as R, type ElementsController as S, type TextElementCreate as T, type UiControlsOptions as U, type ViewportCenterZoom as V, type MapInteractionEvent as W, type InteractionsController as X, type CreateLayersFromGeoJsonParams as Y, type DataOnlyLayer as Z, type FeltTiledVectorSource as _, type Basemap as a, type SelectionController as a$, type GeoJsonFileVectorSource as a0, type GeoJsonUrlVectorSource as a1, type GetLayerGroupsConstraint as a2, type GetLayersConstraint as a3, type GetRenderedFeaturesConstraint as a4, type Layer as a5, type LayerChangeCallbackParams as a6, type LayerCommon as a7, type LayerGroup as a8, type LayerGroupChangeCallbackParams as a9, type LayerBoundaries as aA, type LayerFilters as aB, type AggregatedGridConfig as aC, type AggregationConfig as aD, type AggregationMethod as aE, type CountGridConfig as aF, type GetLayerCalculationParams as aG, type GetLayerCategoriesGroup as aH, type GetLayerCategoriesParams as aI, type GetLayerHistogramBin as aJ, type GetLayerHistogramParams as aK, type GetLayerPrecomputedCalculationParams as aL, type GridConfig as aM, type GridType as aN, type MultiAggregationConfig as aO, type PrecomputedAggregationMethod as aP, type ValueConfiguration as aQ, type LayersController as aR, type MapDetails as aS, type MiscController as aT, type ElementGroupNode as aU, type ElementNode as aV, type EntityNode as aW, type FeatureNode as aX, type FeatureSelection as aY, type LayerGroupNode as aZ, type LayerNode as a_, type LayerProcessingStatus as aa, type LegendDisplay as ab, type LegendItem as ac, type LegendItemChangeCallbackParams as ad, type LegendItemIdentifier as ae, type LegendItemsConstraint as af, type RasterBand as ag, type RasterLayer as ah, type RasterLayerSource as ai, type UpdateLayerParams as aj, type VectorLayer as ak, type LayerFeature as al, type RasterValue as am, type LayerSchema as an, type LayerSchemaAttribute as ao, type LayerSchemaBooleanAttribute as ap, type LayerSchemaCommonAttribute as aq, type LayerSchemaDateAttribute as ar, type LayerSchemaDateTimeAttribute as as, type LayerSchemaNumericAttribute as at, type LayerSchemaTextAttribute as au, type FilterExpression as av, type FilterLogicGate as aw, type FilterTernary as ax, type Filters as ay, type GeometryFilter as az, type ColorBasemapInput as b, type UIPanelElement as b$, type FeltBoundary as b0, type FeltZoom as b1, type GeoJsonFeature as b2, type GeoJsonGeometry as b3, type GeoJsonProperties as b4, type LatLng as b5, type LineStringGeometry as b6, type LngLatTuple as b7, type MultiLineStringGeometry as b8, type MultiPointGeometry as b9, type CreatePanelElementsParams as bA, type DeletePanelElementsParams as bB, type UiOnMapInteractionsOptions as bC, type UpdateActionTriggerParams as bD, type UpdateFeatureActionParams as bE, type UpdatePanelElementsParams as bF, type PlacementForUIElement as bG, type UIPanel as bH, type UIPanelCreateOrUpdate as bI, type UIButtonElement as bJ, type UIButtonElementCreate as bK, type UIButtonElementUpdate as bL, type UITextElement as bM, type UITextElementCreate as bN, type UITextElementUpdate as bO, type UIFlexibleSpaceElement as bP, type UIFlexibleSpaceElementCreate as bQ, type UIFlexibleSpaceElementUpdate as bR, type UIDividerElement as bS, type UIDividerElementCreate as bT, type UIDividerElementUpdate as bU, type UITextInputElement as bV, type UITextInputElementCreate as bW, type UITextInputElementUpdate as bX, type UISelectElement as bY, type UISelectElementCreate as bZ, type UISelectElementUpdate as b_, type MultiPolygonGeometry as ba, type PointGeometry as bb, type PolygonGeometry as bc, type SetVisibilityRequest as bd, type SortConfig as be, type SortDirection as bf, type CircleToolSettings as bg, type ConfigurableToolType as bh, type HighlighterToolSettings as bi, type InputToolSettings as bj, type LineToolSettings as bk, type MarkerToolSettings as bl, type NoteToolSettings as bm, type PinToolSettings as bn, type PlaceFrame as bo, type PlaceSymbol as bp, type PolygonToolSettings as bq, type RouteToolSettings as br, type TextToolSettings as bs, type ToolSettingsChangeEvent as bt, type ToolSettingsMap as bu, type ToolType as bv, type ToolsController as bw, type CreateActionTriggerParams as bx, type CreateFeatureActionParams as by, type CreateOrUpdatePanelParams as bz, type CustomTileBasemap as c, type UIPanelElementCreate as c0, type UIPanelElementUpdate as c1, type UIGridContainerElement as c2, type UIGridContainerElementCreate as c3, type UIGridContainerElementUpdate as c4, type UIButtonRowElement as c5, type UIButtonRowElementCreate as c6, type UIButtonRowElementUpdate as c7, type UICheckboxGroupElement as c8, type UICheckboxGroupElementCreate as c9, type MakeClonableSchema as cA, type UIButtonRowElementCreateClonable as cB, type PromiseOrNot as cC, type UnionToIntersection as cD, type UICheckboxGroupElementUpdate as ca, type UIRadioGroupElement as cb, type UIRadioGroupElementCreate as cc, type UIRadioGroupElementUpdate as cd, type UIToggleGroupElement as ce, type UIToggleGroupElementCreate as cf, type UIToggleGroupElementUpdate as cg, type UIIframeElement as ch, type UIIframeElementCreate as ci, type UIIframeElementUpdate as cj, type UIControlElementOption as ck, type UIActionTriggerCreate as cl, type UIFeatureAction as cm, type UIFeatureActionCreate as cn, type UiController as co, type SetViewportCenterZoomParams as cp, type ViewportConstraints as cq, type ViewportFitBoundsParams as cr, type ViewportState as cs, type ViewportController as ct, type UnwrapPromise as cu, uiActionTriggerSchema as cv, uiFeatureActionSchema as cw, type UIPanelElementCreateClonable as cx, uiPanelCreateSchema as cy, type UIButtonElementCreateClonable as cz, type CustomTileBasemapInput as d, type FeltBasemap as e, type CircleElementCreate as f, type CircleElementRead as g, type CircleElementUpdate as h, type ElementChangeCallbackParams as i, type ElementCreate as j, type ElementGroup as k, type ElementGroupChangeCallbackParams as l, type ElementUpdate as m, type GetElementsConstraint as n, type HighlighterElementRead as o, type HighlighterElementUpdate as p, type ImageElementRead as q, type ImageElementUpdate as r, type MarkerElementRead as s, type MarkerElementUpdate as t, type NoteElementRead as u, type NoteElementUpdate as v, type PathElementRead as w, type PathElementUpdate as x, type PlaceElementCreate as y, type zInfer as z };
+export { type GeoJsonDataVectorSource as $, type PlaceElementRead as A, type BasemapsController as B, type ColorBasemap as C, type PlaceElementUpdate as D, type Element as E, type FeltController as F, type GetElementGroupsConstraint as G, type HighlighterElementCreate as H, type ImageElementCreate as I, type PolygonElementCreate as J, type PolygonElementRead as K, type LinkElementRead as L, type MarkerElementCreate as M, type NoteElementCreate as N, type PolygonElementUpdate as O, type PathElementCreate as P, type TextElementRead as Q, type TextElementUpdate as R, type ElementsController as S, type TextElementCreate as T, type UiControlsOptions as U, type ViewportCenterZoom as V, type MapInteractionEvent as W, type InteractionsController as X, type CreateLayersFromGeoJsonParams as Y, type DataOnlyLayer as Z, type FeltTiledVectorSource as _, type Basemap as a, type RasterHistogramBin as a$, type GeoJsonFileVectorSource as a0, type GeoJsonUrlVectorSource as a1, type GetLayerGroupsConstraint as a2, type GetLayersConstraint as a3, type GetRenderedFeaturesConstraint as a4, type Layer as a5, type LayerChangeCallbackParams as a6, type LayerCommon as a7, type LayerGroup as a8, type LayerGroupChangeCallbackParams as a9, type LayerBoundaries as aA, type LayerFilters as aB, type AggregatedGridConfig as aC, type AggregationConfig as aD, type AggregationMethod as aE, type CountGridConfig as aF, type GetLayerCalculationParams as aG, type GetLayerCategoriesGroup as aH, type GetLayerCategoriesParams as aI, type GetLayerHistogramBin as aJ, type GetLayerHistogramParams as aK, type GetLayerPrecomputedCalculationParams as aL, type GridConfig as aM, type GridType as aN, type MultiAggregationConfig as aO, type PrecomputedAggregationMethod as aP, type ValueConfiguration as aQ, type GetRasterAggregatesParams as aR, type GetRasterAggregatesResult as aS, type GetRasterCategoriesParams as aT, type GetRasterCategoriesResult as aU, type GetRasterHistogramParams as aV, type GetRasterHistogramResult as aW, type GetRasterProfileParams as aX, type GetRasterProfileResult as aY, type RasterAggregationMethod as aZ, type RasterCategory as a_, type LayerProcessingStatus as aa, type LegendDisplay as ab, type LegendItem as ac, type LegendItemChangeCallbackParams as ad, type LegendItemIdentifier as ae, type LegendItemsConstraint as af, type RasterBand as ag, type RasterLayer as ah, type RasterLayerSource as ai, type UpdateLayerParams as aj, type VectorLayer as ak, type LayerFeature as al, type RasterValue as am, type LayerSchema as an, type LayerSchemaAttribute as ao, type LayerSchemaBooleanAttribute as ap, type LayerSchemaCommonAttribute as aq, type LayerSchemaDateAttribute as ar, type LayerSchemaDateTimeAttribute as as, type LayerSchemaNumericAttribute as at, type LayerSchemaTextAttribute as au, type FilterExpression as av, type FilterLogicGate as aw, type FilterTernary as ax, type Filters as ay, type GeometryFilter as az, type ColorBasemapInput as b, type UITextElementUpdate as b$, type RasterPercentile as b0, type RasterProfileSample as b1, type LayersController as b2, type MapDetails as b3, type MiscController as b4, type ElementGroupNode as b5, type ElementNode as b6, type EntityNode as b7, type FeatureNode as b8, type FeatureSelection as b9, type PinToolSettings as bA, type PlaceFrame as bB, type PlaceSymbol as bC, type PolygonToolSettings as bD, type RouteToolSettings as bE, type TextToolSettings as bF, type ToolSettingsChangeEvent as bG, type ToolSettingsMap as bH, type ToolType as bI, type ToolsController as bJ, type CreateActionTriggerParams as bK, type CreateFeatureActionParams as bL, type CreateOrUpdatePanelParams as bM, type CreatePanelElementsParams as bN, type DeletePanelElementsParams as bO, type UiOnMapInteractionsOptions as bP, type UpdateActionTriggerParams as bQ, type UpdateFeatureActionParams as bR, type UpdatePanelElementsParams as bS, type PlacementForUIElement as bT, type UIPanel as bU, type UIPanelCreateOrUpdate as bV, type UIButtonElement as bW, type UIButtonElementCreate as bX, type UIButtonElementUpdate as bY, type UITextElement as bZ, type UITextElementCreate as b_, type LayerGroupNode as ba, type LayerNode as bb, type SelectionController as bc, type FeltBoundary as bd, type FeltZoom as be, type GeoJsonFeature as bf, type GeoJsonGeometry as bg, type GeoJsonProperties as bh, type LatLng as bi, type LineStringGeometry as bj, type LngLatTuple as bk, type MultiLineStringGeometry as bl, type MultiPointGeometry as bm, type MultiPolygonGeometry as bn, type PointGeometry as bo, type PolygonGeometry as bp, type SetVisibilityRequest as bq, type SortConfig as br, type SortDirection as bs, type CircleToolSettings as bt, type ConfigurableToolType as bu, type HighlighterToolSettings as bv, type InputToolSettings as bw, type LineToolSettings as bx, type MarkerToolSettings as by, type NoteToolSettings as bz, type CustomTileBasemap as c, type UIFlexibleSpaceElement as c0, type UIFlexibleSpaceElementCreate as c1, type UIFlexibleSpaceElementUpdate as c2, type UIDividerElement as c3, type UIDividerElementCreate as c4, type UIDividerElementUpdate as c5, type UITextInputElement as c6, type UITextInputElementCreate as c7, type UITextInputElementUpdate as c8, type UISelectElement as c9, type UIFeatureActionCreate as cA, type UiController as cB, type SetViewportCenterZoomParams as cC, type ViewportConstraints as cD, type ViewportFitBoundsParams as cE, type ViewportState as cF, type ViewportController as cG, type UnwrapPromise as cH, uiActionTriggerSchema as cI, uiFeatureActionSchema as cJ, type UIPanelElementCreateClonable as cK, uiPanelCreateSchema as cL, type UIButtonElementCreateClonable as cM, type MakeClonableSchema as cN, type UIButtonRowElementCreateClonable as cO, type PromiseOrNot as cP, type UnionToIntersection as cQ, type UISelectElementCreate as ca, type UISelectElementUpdate as cb, type UIPanelElement as cc, type UIPanelElementCreate as cd, type UIPanelElementUpdate as ce, type UIGridContainerElement as cf, type UIGridContainerElementCreate as cg, type UIGridContainerElementUpdate as ch, type UIButtonRowElement as ci, type UIButtonRowElementCreate as cj, type UIButtonRowElementUpdate as ck, type UICheckboxGroupElement as cl, type UICheckboxGroupElementCreate as cm, type UICheckboxGroupElementUpdate as cn, type UIRadioGroupElement as co, type UIRadioGroupElementCreate as cp, type UIRadioGroupElementUpdate as cq, type UIToggleGroupElement as cr, type UIToggleGroupElementCreate as cs, type UIToggleGroupElementUpdate as ct, type UIIframeElement as cu, type UIIframeElementCreate as cv, type UIIframeElementUpdate as cw, type UIControlElementOption as cx, type UIActionTriggerCreate as cy, type UIFeatureAction as cz, type CustomTileBasemapInput as d, type FeltBasemap as e, type CircleElementCreate as f, type CircleElementRead as g, type CircleElementUpdate as h, type ElementChangeCallbackParams as i, type ElementCreate as j, type ElementGroup as k, type ElementGroupChangeCallbackParams as l, type ElementUpdate as m, type GetElementsConstraint as n, type HighlighterElementRead as o, type HighlighterElementUpdate as p, type ImageElementRead as q, type ImageElementUpdate as r, type MarkerElementRead as s, type MarkerElementUpdate as t, type NoteElementRead as u, type NoteElementUpdate as v, type PathElementRead as w, type PathElementUpdate as x, type PlaceElementCreate as y, type zInfer as z };