@maplibre/maplibre-react-native 11.0.0-beta.30 → 11.0.0-beta.31

package/lib/typescript/commonjs/types/MapLibreRNStyles.d.ts

@@ -12,10 +12,16 @@ export type ExpressionName = "array" | "boolean" | "collator" | "format" | "imag
 export type ExpressionField = string | number | boolean | Expression | ExpressionField[] | {
     [key: string]: ExpressionField;
 };
+/**
+ * @deprecated
+ */
 export type Expression = [ExpressionName, ...ExpressionField[]];
 type ExpressionParameters = "zoom" | "feature" | "feature-state" | "global-state" | "sky-radial-progress" | "line-progress" | "heatmap-density";
 type ResolvedImageType = ImageSourcePropType | string;
 export type Value<T, AllowedParameters extends ExpressionParameters[] = []> = T | Expression;
+/**
+ * @deprecated
+ */
 export interface FillLayerStyle {
     /**
      * Sorts features in ascending order based on this value. Features with a higher
@@ -36,7 +42,7 @@ export interface FillLayerStyle {
      */
     fillOpacity?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s fillOpacity property.
+     * The transition affecting any changes to this layer's fillOpacity property.
      */
     fillOpacityTransition?: Transition;
     /**
@@ -48,7 +54,7 @@ export interface FillLayerStyle {
      */
     fillColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s fillColor property.
+     * The transition affecting any changes to this layer's fillColor property.
      */
     fillColorTransition?: Transition;
     /**
@@ -59,7 +65,7 @@ export interface FillLayerStyle {
      */
     fillOutlineColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s fillOutlineColor
+     * The transition affecting any changes to this layer's fillOutlineColor
      * property.
      */
     fillOutlineColorTransition?: Transition;
@@ -69,7 +75,7 @@ export interface FillLayerStyle {
      */
     fillTranslate?: Value<Translation, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s fillTranslate property.
+     * The transition affecting any changes to this layer's fillTranslate property.
      */
     fillTranslateTransition?: Transition;
     /**
@@ -86,10 +92,13 @@ export interface FillLayerStyle {
      */
     fillPattern?: Value<ResolvedImageType, ["zoom", "feature"]>;
     /**
-     * The transition affecting any changes to this layer’s fillPattern property.
+     * The transition affecting any changes to this layer's fillPattern property.
      */
     fillPatternTransition?: Transition;
 }
+/**
+ * @deprecated
+ */
 export interface LineLayerStyle {
     /**
      * The display of line endings.
@@ -121,7 +130,7 @@ export interface LineLayerStyle {
      */
     lineOpacity?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s lineOpacity property.
+     * The transition affecting any changes to this layer's lineOpacity property.
      */
     lineOpacityTransition?: Transition;
     /**
@@ -131,7 +140,7 @@ export interface LineLayerStyle {
      */
     lineColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s lineColor property.
+     * The transition affecting any changes to this layer's lineColor property.
      */
     lineColorTransition?: Transition;
     /**
@@ -140,7 +149,7 @@ export interface LineLayerStyle {
      */
     lineTranslate?: Value<Translation, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s lineTranslate property.
+     * The transition affecting any changes to this layer's lineTranslate property.
      */
     lineTranslateTransition?: Transition;
     /**
@@ -154,7 +163,7 @@ export interface LineLayerStyle {
      */
     lineWidth?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s lineWidth property.
+     * The transition affecting any changes to this layer's lineWidth property.
      */
     lineWidthTransition?: Transition;
     /**
@@ -163,7 +172,7 @@ export interface LineLayerStyle {
      */
     lineGapWidth?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s lineGapWidth property.
+     * The transition affecting any changes to this layer's lineGapWidth property.
      */
     lineGapWidthTransition?: Transition;
     /**
@@ -174,7 +183,7 @@ export interface LineLayerStyle {
      */
     lineOffset?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s lineOffset property.
+     * The transition affecting any changes to this layer's lineOffset property.
      */
     lineOffsetTransition?: Transition;
     /**
@@ -182,7 +191,7 @@ export interface LineLayerStyle {
      */
     lineBlur?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s lineBlur property.
+     * The transition affecting any changes to this layer's lineBlur property.
      */
     lineBlurTransition?: Transition;
     /**
@@ -199,7 +208,7 @@ export interface LineLayerStyle {
      */
     lineDasharray?: Value<number[], ["zoom", "feature"]>;
     /**
-     * The transition affecting any changes to this layer’s lineDasharray property.
+     * The transition affecting any changes to this layer's lineDasharray property.
      */
     lineDasharrayTransition?: Transition;
     /**
@@ -209,7 +218,7 @@ export interface LineLayerStyle {
      */
     linePattern?: Value<ResolvedImageType, ["zoom", "feature"]>;
     /**
-     * The transition affecting any changes to this layer’s linePattern property.
+     * The transition affecting any changes to this layer's linePattern property.
      */
     linePatternTransition?: Transition;
     /**
@@ -220,6 +229,9 @@ export interface LineLayerStyle {
      */
     lineGradient?: Value<string, ["line-progress"]>;
 }
+/**
+ * @deprecated
+ */
 export interface SymbolLayerStyle {
     /**
      * Label placement relative to its geometry.
@@ -539,7 +551,7 @@ export interface SymbolLayerStyle {
      */
     iconOpacity?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s iconOpacity property.
+     * The transition affecting any changes to this layer's iconOpacity property.
      */
     iconOpacityTransition?: Transition;
     /**
@@ -549,7 +561,7 @@ export interface SymbolLayerStyle {
      */
     iconColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s iconColor property.
+     * The transition affecting any changes to this layer's iconColor property.
      */
     iconColorTransition?: Transition;
     /**
@@ -559,7 +571,7 @@ export interface SymbolLayerStyle {
      */
     iconHaloColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s iconHaloColor property.
+     * The transition affecting any changes to this layer's iconHaloColor property.
      */
     iconHaloColorTransition?: Transition;
     /**
@@ -573,7 +585,7 @@ export interface SymbolLayerStyle {
      */
     iconHaloWidth?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s iconHaloWidth property.
+     * The transition affecting any changes to this layer's iconHaloWidth property.
      */
     iconHaloWidthTransition?: Transition;
     /**
@@ -583,7 +595,7 @@ export interface SymbolLayerStyle {
      */
     iconHaloBlur?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s iconHaloBlur property.
+     * The transition affecting any changes to this layer's iconHaloBlur property.
      */
     iconHaloBlurTransition?: Transition;
     /**
@@ -595,7 +607,7 @@ export interface SymbolLayerStyle {
      */
     iconTranslate?: Value<Translation, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s iconTranslate property.
+     * The transition affecting any changes to this layer's iconTranslate property.
      */
     iconTranslateTransition?: Transition;
     /**
@@ -611,7 +623,7 @@ export interface SymbolLayerStyle {
      */
     textOpacity?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s textOpacity property.
+     * The transition affecting any changes to this layer's textOpacity property.
      */
     textOpacityTransition?: Transition;
     /**
@@ -621,7 +633,7 @@ export interface SymbolLayerStyle {
      */
     textColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s textColor property.
+     * The transition affecting any changes to this layer's textColor property.
      */
     textColorTransition?: Transition;
     /**
@@ -631,7 +643,7 @@ export interface SymbolLayerStyle {
      */
     textHaloColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s textHaloColor property.
+     * The transition affecting any changes to this layer's textHaloColor property.
      */
     textHaloColorTransition?: Transition;
     /**
@@ -642,7 +654,7 @@ export interface SymbolLayerStyle {
      */
     textHaloWidth?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s textHaloWidth property.
+     * The transition affecting any changes to this layer's textHaloWidth property.
      */
     textHaloWidthTransition?: Transition;
     /**
@@ -652,7 +664,7 @@ export interface SymbolLayerStyle {
      */
     textHaloBlur?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s textHaloBlur property.
+     * The transition affecting any changes to this layer's textHaloBlur property.
      */
     textHaloBlurTransition?: Transition;
     /**
@@ -664,7 +676,7 @@ export interface SymbolLayerStyle {
      */
     textTranslate?: Value<Translation, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s textTranslate property.
+     * The transition affecting any changes to this layer's textTranslate property.
      */
     textTranslateTransition?: Transition;
     /**
@@ -674,6 +686,9 @@ export interface SymbolLayerStyle {
      */
     textTranslateAnchor?: Value<"map" | "viewport", ["zoom"]>;
 }
+/**
+ * @deprecated
+ */
 export interface CircleLayerStyle {
     /**
      * Sorts features in ascending order based on this value. Features with a higher
@@ -689,7 +704,7 @@ export interface CircleLayerStyle {
      */
     circleRadius?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleRadius property.
+     * The transition affecting any changes to this layer's circleRadius property.
      */
     circleRadiusTransition?: Transition;
     /**
@@ -697,7 +712,7 @@ export interface CircleLayerStyle {
      */
     circleColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleColor property.
+     * The transition affecting any changes to this layer's circleColor property.
      */
     circleColorTransition?: Transition;
     /**
@@ -706,7 +721,7 @@ export interface CircleLayerStyle {
      */
     circleBlur?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleBlur property.
+     * The transition affecting any changes to this layer's circleBlur property.
      */
     circleBlurTransition?: Transition;
     /**
@@ -714,7 +729,7 @@ export interface CircleLayerStyle {
      */
     circleOpacity?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleOpacity property.
+     * The transition affecting any changes to this layer's circleOpacity property.
      */
     circleOpacityTransition?: Transition;
     /**
@@ -723,7 +738,7 @@ export interface CircleLayerStyle {
      */
     circleTranslate?: Value<Translation, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s circleTranslate
+     * The transition affecting any changes to this layer's circleTranslate
      * property.
      */
     circleTranslateTransition?: Transition;
@@ -747,7 +762,7 @@ export interface CircleLayerStyle {
      */
     circleStrokeWidth?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleStrokeWidth
+     * The transition affecting any changes to this layer's circleStrokeWidth
      * property.
      */
     circleStrokeWidthTransition?: Transition;
@@ -756,7 +771,7 @@ export interface CircleLayerStyle {
      */
     circleStrokeColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleStrokeColor
+     * The transition affecting any changes to this layer's circleStrokeColor
      * property.
      */
     circleStrokeColorTransition?: Transition;
@@ -765,11 +780,14 @@ export interface CircleLayerStyle {
      */
     circleStrokeOpacity?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s circleStrokeOpacity
+     * The transition affecting any changes to this layer's circleStrokeOpacity
      * property.
      */
     circleStrokeOpacityTransition?: Transition;
 }
+/**
+ * @deprecated
+ */
 export interface HeatmapLayerStyle {
     /**
      * Whether this layer is displayed.
@@ -781,7 +799,7 @@ export interface HeatmapLayerStyle {
      */
     heatmapRadius?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s heatmapRadius property.
+     * The transition affecting any changes to this layer's heatmapRadius property.
      */
     heatmapRadiusTransition?: Transition;
     /**
@@ -796,7 +814,7 @@ export interface HeatmapLayerStyle {
      */
     heatmapIntensity?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s heatmapIntensity
+     * The transition affecting any changes to this layer's heatmapIntensity
      * property.
      */
     heatmapIntensityTransition?: Transition;
@@ -810,10 +828,13 @@ export interface HeatmapLayerStyle {
      */
     heatmapOpacity?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s heatmapOpacity property.
+     * The transition affecting any changes to this layer's heatmapOpacity property.
      */
     heatmapOpacityTransition?: Transition;
 }
+/**
+ * @deprecated
+ */
 export interface FillExtrusionLayerStyle {
     /**
      * Whether this layer is displayed.
@@ -825,7 +846,7 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionOpacity?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s fillExtrusionOpacity
+     * The transition affecting any changes to this layer's fillExtrusionOpacity
      * property.
      */
     fillExtrusionOpacityTransition?: Transition;
@@ -840,7 +861,7 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionColor?: Value<string, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s fillExtrusionColor
+     * The transition affecting any changes to this layer's fillExtrusionColor
      * property.
      */
     fillExtrusionColorTransition?: Transition;
@@ -850,7 +871,7 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionTranslate?: Value<Translation, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s fillExtrusionTranslate
+     * The transition affecting any changes to this layer's fillExtrusionTranslate
      * property.
      */
     fillExtrusionTranslateTransition?: Transition;
@@ -868,7 +889,7 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionPattern?: Value<ResolvedImageType, ["zoom", "feature"]>;
     /**
-     * The transition affecting any changes to this layer’s fillExtrusionPattern
+     * The transition affecting any changes to this layer's fillExtrusionPattern
      * property.
      */
     fillExtrusionPatternTransition?: Transition;
@@ -877,7 +898,7 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionHeight?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s fillExtrusionHeight
+     * The transition affecting any changes to this layer's fillExtrusionHeight
      * property.
      */
     fillExtrusionHeightTransition?: Transition;
@@ -889,7 +910,7 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionBase?: Value<number, ["zoom", "feature", "feature-state"]>;
     /**
-     * The transition affecting any changes to this layer’s fillExtrusionBase
+     * The transition affecting any changes to this layer's fillExtrusionBase
      * property.
      */
     fillExtrusionBaseTransition?: Transition;
@@ -899,6 +920,9 @@ export interface FillExtrusionLayerStyle {
      */
     fillExtrusionVerticalGradient?: Value<boolean, ["zoom"]>;
 }
+/**
+ * @deprecated
+ */
 export interface RasterLayerStyle {
     /**
      * Whether this layer is displayed.
@@ -909,7 +933,7 @@ export interface RasterLayerStyle {
      */
     rasterOpacity?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s rasterOpacity property.
+     * The transition affecting any changes to this layer's rasterOpacity property.
      */
     rasterOpacityTransition?: Transition;
     /**
@@ -917,7 +941,7 @@ export interface RasterLayerStyle {
      */
     rasterHueRotate?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s rasterHueRotate
+     * The transition affecting any changes to this layer's rasterHueRotate
      * property.
      */
     rasterHueRotateTransition?: Transition;
@@ -927,7 +951,7 @@ export interface RasterLayerStyle {
      */
     rasterBrightnessMin?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s rasterBrightnessMin
+     * The transition affecting any changes to this layer's rasterBrightnessMin
      * property.
      */
     rasterBrightnessMinTransition?: Transition;
@@ -937,7 +961,7 @@ export interface RasterLayerStyle {
      */
     rasterBrightnessMax?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s rasterBrightnessMax
+     * The transition affecting any changes to this layer's rasterBrightnessMax
      * property.
      */
     rasterBrightnessMaxTransition?: Transition;
@@ -946,7 +970,7 @@ export interface RasterLayerStyle {
      */
     rasterSaturation?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s rasterSaturation
+     * The transition affecting any changes to this layer's rasterSaturation
      * property.
      */
     rasterSaturationTransition?: Transition;
@@ -955,7 +979,7 @@ export interface RasterLayerStyle {
      */
     rasterContrast?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s rasterContrast property.
+     * The transition affecting any changes to this layer's rasterContrast property.
      */
     rasterContrastTransition?: Transition;
     /**
@@ -970,6 +994,9 @@ export interface RasterLayerStyle {
      */
     rasterFadeDuration?: Value<number, ["zoom"]>;
 }
+/**
+ * @deprecated
+ */
 export interface HillshadeLayerStyle {
     /**
      * Whether this layer is displayed.
@@ -992,7 +1019,7 @@ export interface HillshadeLayerStyle {
      */
     hillshadeExaggeration?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s hillshadeExaggeration
+     * The transition affecting any changes to this layer's hillshadeExaggeration
      * property.
      */
     hillshadeExaggerationTransition?: Transition;
@@ -1003,7 +1030,7 @@ export interface HillshadeLayerStyle {
      */
     hillshadeShadowColor?: Value<string, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s hillshadeShadowColor
+     * The transition affecting any changes to this layer's hillshadeShadowColor
      * property.
      */
     hillshadeShadowColorTransition?: Transition;
@@ -1014,7 +1041,7 @@ export interface HillshadeLayerStyle {
      */
     hillshadeHighlightColor?: Value<string, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s hillshadeHighlightColor
+     * The transition affecting any changes to this layer's hillshadeHighlightColor
      * property.
      */
     hillshadeHighlightColorTransition?: Transition;
@@ -1024,11 +1051,14 @@ export interface HillshadeLayerStyle {
      */
     hillshadeAccentColor?: Value<string, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s hillshadeAccentColor
+     * The transition affecting any changes to this layer's hillshadeAccentColor
      * property.
      */
     hillshadeAccentColorTransition?: Transition;
 }
+/**
+ * @deprecated
+ */
 export interface BackgroundLayerStyle {
     /**
      * Whether this layer is displayed.
@@ -1041,7 +1071,7 @@ export interface BackgroundLayerStyle {
      */
     backgroundColor?: Value<string, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s backgroundColor
+     * The transition affecting any changes to this layer's backgroundColor
      * property.
      */
     backgroundColorTransition?: Transition;
@@ -1053,7 +1083,7 @@ export interface BackgroundLayerStyle {
      */
     backgroundPattern?: Value<ResolvedImageType, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s backgroundPattern
+     * The transition affecting any changes to this layer's backgroundPattern
      * property.
      */
     backgroundPatternTransition?: Transition;
@@ -1062,11 +1092,14 @@ export interface BackgroundLayerStyle {
      */
     backgroundOpacity?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s backgroundOpacity
+     * The transition affecting any changes to this layer's backgroundOpacity
      * property.
      */
     backgroundOpacityTransition?: Transition;
 }
+/**
+ * @deprecated
+ */
 export interface LightLayerStyle {
     /**
      * Whether extruded geometries are lit relative to the map or viewport.
@@ -1084,7 +1117,7 @@ export interface LightLayerStyle {
      */
     position?: Value<number[], ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s position property.
+     * The transition affecting any changes to this layer's position property.
      */
     positionTransition?: Transition;
     /**
@@ -1092,7 +1125,7 @@ export interface LightLayerStyle {
      */
     color?: Value<string, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s color property.
+     * The transition affecting any changes to this layer's color property.
      */
     colorTransition?: Transition;
     /**
@@ -1101,7 +1134,7 @@ export interface LightLayerStyle {
      */
     intensity?: Value<number, ["zoom"]>;
     /**
-     * The transition affecting any changes to this layer’s intensity property.
+     * The transition affecting any changes to this layer's intensity property.
      */
     intensityTransition?: Transition;
 }