@emuanalytics/flow-rdf-core 4.0.0-preview.6 → 4.0.0

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.
Files changed (27) hide show
  1. package/dist/index.cjs +676 -665
  2. package/dist/index.d.cts +2 -2
  3. package/dist/index.d.mts +2 -2
  4. package/dist/index.d.ts +2 -2
  5. package/dist/index.mjs +643 -643
  6. package/dist/lib/map/plugins/index.cjs +35 -34
  7. package/dist/lib/map/plugins/index.d.cts +2 -2
  8. package/dist/lib/map/plugins/index.d.mts +2 -2
  9. package/dist/lib/map/plugins/index.d.ts +2 -2
  10. package/dist/lib/map/plugins/index.mjs +6 -6
  11. package/dist/lib/utils/index.cjs +31 -29
  12. package/dist/lib/utils/index.d.cts +10 -9
  13. package/dist/lib/utils/index.d.mts +10 -9
  14. package/dist/lib/utils/index.d.ts +10 -9
  15. package/dist/lib/utils/index.mjs +4 -3
  16. package/dist/shared/{flow-rdf-core.769a4928.d.mts → flow-rdf-core.04b30d7a.d.cts} +801 -802
  17. package/dist/shared/{flow-rdf-core.769a4928.d.ts → flow-rdf-core.04b30d7a.d.mts} +801 -802
  18. package/dist/shared/{flow-rdf-core.769a4928.d.cts → flow-rdf-core.04b30d7a.d.ts} +801 -802
  19. package/dist/shared/{flow-rdf-core.ea06a1d3.mjs → flow-rdf-core.187cb345.mjs} +1 -1
  20. package/dist/shared/{flow-rdf-core.bd95d618.mjs → flow-rdf-core.1f0901c5.mjs} +1 -1
  21. package/dist/shared/{flow-rdf-core.b80085b4.mjs → flow-rdf-core.25e5f6d7.mjs} +9 -1
  22. package/dist/shared/{flow-rdf-core.1f72b20b.cjs → flow-rdf-core.55c169ca.cjs} +2 -2
  23. package/dist/shared/{flow-rdf-core.1f9c0593.cjs → flow-rdf-core.9b5dad76.cjs} +26 -34
  24. package/dist/shared/{flow-rdf-core.84eded74.cjs → flow-rdf-core.a82b9be4.cjs} +4 -4
  25. package/dist/shared/{flow-rdf-core.ce91eb14.mjs → flow-rdf-core.e2b1bb7f.mjs} +2 -9
  26. package/dist/shared/{flow-rdf-core.3042be4a.cjs → flow-rdf-core.f50908f0.cjs} +9 -0
  27. package/package.json +5 -1
package/dist/index.mjs CHANGED
@@ -3,19 +3,19 @@ import { isObservable, isComputed, isObservableArray, isObservableSet, isObserva
3
3
  export { makeAutoObservable, makeObservable } from 'mobx';
4
4
  import Debug from 'debug';
5
5
  import { Client } from '@emuanalytics/flow-engine-client';
6
- import { i as isUndefined, f as isString, o as isNumber, s as isBoolean, j as isArray, b as isNil, y as isPlainObject, d as isDefined, g as isStringFull, z as isURL, e as ensureArray } from './shared/flow-rdf-core.b80085b4.mjs';
7
- import { R as ReactiveExpression, F as FlowError, f as MapStyleChangeEvent, r as randomId, P as PluginManager, e as MapLayer, d as MapDataSource, g as MapSourceEvent, M as MapEvent, c as FlowMapError, b as MapFeatureStream, a as assert, h as MapLoadingEvent, i as MapMouseEvent, j as die } from './shared/flow-rdf-core.ce91eb14.mjs';
6
+ import { i as isUndefined, f as isString, o as isNumber, s as isBoolean, j as isArray, b as isNil, A as randomId, y as isPlainObject, d as isDefined, g as isStringFull, z as isURL, e as ensureArray } from './shared/flow-rdf-core.25e5f6d7.mjs';
7
+ import { R as ReactiveExpression, F as FlowError, f as MapStyleChangeEvent, P as PluginManager, e as MapLayer, d as MapDataSource, g as MapSourceEvent, M as MapEvent, c as FlowMapError, b as MapFeatureStream, a as assert, h as MapLoadingEvent, i as MapMouseEvent, j as die } from './shared/flow-rdf-core.e2b1bb7f.mjs';
8
8
  import maplibre from '@emuanalytics/maplibre-gl';
9
9
  import EventEmitter from 'eventemitter3';
10
10
  import { toStream } from 'mobx-utils';
11
- import { t as throttle, a as debounceWithArgs } from './shared/flow-rdf-core.ea06a1d3.mjs';
11
+ import { t as throttle, a as debounceWithArgs } from './shared/flow-rdf-core.187cb345.mjs';
12
12
  import lzString from 'lz-string';
13
+ // import 'nanoid';
13
14
  // import '@emuanalytics/maplibre-gl-style-spec';
14
15
  import 'parsimmon';
15
16
  import 'colorbrewer';
16
- // import 'nanoid';
17
17
 
18
- const version = "4.0.0-preview.6";
18
+ const version = "4.0.0";
19
19
 
20
20
  const CONSOLE_HIGHLIGHT_STYLE$1 = `
21
21
  padding: 2px 4px;
@@ -704,77 +704,77 @@ function expr(expr2) {
704
704
 
705
705
  class FillLayerStyleBuilder extends MapLayerStyleBuilder {
706
706
  /**
707
- * Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
708
- *
709
- * @param value - fill-sort-key value
710
- */
707
+ * Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
708
+ *
709
+ * @param value - fill-sort-key value
710
+ */
711
711
  fillSortKey(value) {
712
712
  this.addStyle("fill-sort-key", value);
713
713
  return this;
714
714
  }
715
715
  /**
716
- * Whether or not the fill should be antialiased.
717
- *
718
- * @param value - fill-antialias value (default `true`)
719
- */
716
+ * Whether or not the fill should be antialiased.
717
+ *
718
+ * @param value - fill-antialias value (default `true`)
719
+ */
720
720
  fillAntialias(value) {
721
721
  this.addStyle("fill-antialias", value);
722
722
  return this;
723
723
  }
724
724
  /**
725
- * The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used.
726
- *
727
- * @param value - fill-opacity value (default `1`)
728
- */
725
+ * The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used.
726
+ *
727
+ * @param value - fill-opacity value (default `1`)
728
+ */
729
729
  fillOpacity(value) {
730
730
  this.addStyle("fill-opacity", value);
731
731
  return this;
732
732
  }
733
733
  /**
734
- * The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
735
- *
736
- * @param value - fill-color value (default `#000000`)
737
- */
734
+ * The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
735
+ *
736
+ * @param value - fill-color value (default `#000000`)
737
+ */
738
738
  fillColor(value) {
739
739
  this.addStyle("fill-color", value);
740
740
  return this;
741
741
  }
742
742
  /**
743
- * The outline color of the fill. Matches the value of `fill-color` if unspecified.
744
- *
745
- * @param value - fill-outline-color value
746
- */
743
+ * The outline color of the fill. Matches the value of `fill-color` if unspecified.
744
+ *
745
+ * @param value - fill-outline-color value
746
+ */
747
747
  fillOutlineColor(value) {
748
748
  this.addStyle("fill-outline-color", value);
749
749
  return this;
750
750
  }
751
751
  /**
752
- * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
753
- *
754
- * @param value - fill-translate value in pixels (default `0,0`)
755
- */
752
+ * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
753
+ *
754
+ * @param value - fill-translate value in pixels (default `0,0`)
755
+ */
756
756
  fillTranslate(value) {
757
757
  this.addStyle("fill-translate", value);
758
758
  return this;
759
759
  }
760
760
  /**
761
- * Controls the frame of reference for `fill-translate`.
762
- *
763
- * Values:
764
- * - map: The fill is translated relative to the map.
765
- * - viewport: The fill is translated relative to the viewport.
766
- *
767
- * @param value - fill-translate-anchor value (default `map`)
768
- */
761
+ * Controls the frame of reference for `fill-translate`.
762
+ *
763
+ * Values:
764
+ * - map: The fill is translated relative to the map.
765
+ * - viewport: The fill is translated relative to the viewport.
766
+ *
767
+ * @param value - fill-translate-anchor value (default `map`)
768
+ */
769
769
  fillTranslateAnchor(value) {
770
770
  this.addStyle("fill-translate-anchor", value);
771
771
  return this;
772
772
  }
773
773
  /**
774
- * Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
775
- *
776
- * @param value - fill-pattern value
777
- */
774
+ * Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
775
+ *
776
+ * @param value - fill-pattern value
777
+ */
778
778
  fillPattern(value) {
779
779
  this.addStyle("fill-pattern", value);
780
780
  return this;
@@ -783,159 +783,159 @@ class FillLayerStyleBuilder extends MapLayerStyleBuilder {
783
783
  MapLayerStyleBuilder.registerStyleBuilder("fill", FillLayerStyleBuilder);
784
784
  class LineLayerStyleBuilder extends MapLayerStyleBuilder {
785
785
  /**
786
- * The display of line endings.
787
- *
788
- * Values:
789
- * - butt: A cap with a squared-off end which is drawn to the exact endpoint of the line.
790
- * - round: A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
791
- * - square: A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
792
- *
793
- * @param value - line-cap value (default `butt`)
794
- */
786
+ * The display of line endings.
787
+ *
788
+ * Values:
789
+ * - butt: A cap with a squared-off end which is drawn to the exact endpoint of the line.
790
+ * - round: A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
791
+ * - square: A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
792
+ *
793
+ * @param value - line-cap value (default `butt`)
794
+ */
795
795
  lineCap(value) {
796
796
  this.addStyle("line-cap", value);
797
797
  return this;
798
798
  }
799
799
  /**
800
- * The display of lines when joining.
801
- *
802
- * Values:
803
- * - bevel: A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
804
- * - round: A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
805
- * - miter: A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
806
- *
807
- * @param value - line-join value (default `miter`)
808
- */
800
+ * The display of lines when joining.
801
+ *
802
+ * Values:
803
+ * - bevel: A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
804
+ * - round: A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
805
+ * - miter: A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
806
+ *
807
+ * @param value - line-join value (default `miter`)
808
+ */
809
809
  lineJoin(value) {
810
810
  this.addStyle("line-join", value);
811
811
  return this;
812
812
  }
813
813
  /**
814
- * Used to automatically convert miter joins to bevel joins for sharp angles.
815
- *
816
- * @param value - line-miter-limit value (default `2`)
817
- */
814
+ * Used to automatically convert miter joins to bevel joins for sharp angles.
815
+ *
816
+ * @param value - line-miter-limit value (default `2`)
817
+ */
818
818
  lineMiterLimit(value) {
819
819
  this.addStyle("line-miter-limit", value);
820
820
  return this;
821
821
  }
822
822
  /**
823
- * Used to automatically convert round joins to miter joins for shallow angles.
824
- *
825
- * @param value - line-round-limit value (default `1.05`)
826
- */
823
+ * Used to automatically convert round joins to miter joins for shallow angles.
824
+ *
825
+ * @param value - line-round-limit value (default `1.05`)
826
+ */
827
827
  lineRoundLimit(value) {
828
828
  this.addStyle("line-round-limit", value);
829
829
  return this;
830
830
  }
831
831
  /**
832
- * Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
833
- *
834
- * @param value - line-sort-key value
835
- */
832
+ * Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
833
+ *
834
+ * @param value - line-sort-key value
835
+ */
836
836
  lineSortKey(value) {
837
837
  this.addStyle("line-sort-key", value);
838
838
  return this;
839
839
  }
840
840
  /**
841
- * The opacity at which the line will be drawn.
842
- *
843
- * @param value - line-opacity value (default `1`)
844
- */
841
+ * The opacity at which the line will be drawn.
842
+ *
843
+ * @param value - line-opacity value (default `1`)
844
+ */
845
845
  lineOpacity(value) {
846
846
  this.addStyle("line-opacity", value);
847
847
  return this;
848
848
  }
849
849
  /**
850
- * The color with which the line will be drawn.
851
- *
852
- * @param value - line-color value (default `#000000`)
853
- */
850
+ * The color with which the line will be drawn.
851
+ *
852
+ * @param value - line-color value (default `#000000`)
853
+ */
854
854
  lineColor(value) {
855
855
  this.addStyle("line-color", value);
856
856
  return this;
857
857
  }
858
858
  /**
859
- * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
860
- *
861
- * @param value - line-translate value in pixels (default `0,0`)
862
- */
859
+ * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
860
+ *
861
+ * @param value - line-translate value in pixels (default `0,0`)
862
+ */
863
863
  lineTranslate(value) {
864
864
  this.addStyle("line-translate", value);
865
865
  return this;
866
866
  }
867
867
  /**
868
- * Controls the frame of reference for `line-translate`.
869
- *
870
- * Values:
871
- * - map: The line is translated relative to the map.
872
- * - viewport: The line is translated relative to the viewport.
873
- *
874
- * @param value - line-translate-anchor value (default `map`)
875
- */
868
+ * Controls the frame of reference for `line-translate`.
869
+ *
870
+ * Values:
871
+ * - map: The line is translated relative to the map.
872
+ * - viewport: The line is translated relative to the viewport.
873
+ *
874
+ * @param value - line-translate-anchor value (default `map`)
875
+ */
876
876
  lineTranslateAnchor(value) {
877
877
  this.addStyle("line-translate-anchor", value);
878
878
  return this;
879
879
  }
880
880
  /**
881
- * Stroke thickness.
882
- *
883
- * @param value - line-width value in pixels (default `1`)
884
- */
881
+ * Stroke thickness.
882
+ *
883
+ * @param value - line-width value in pixels (default `1`)
884
+ */
885
885
  lineWidth(value) {
886
886
  this.addStyle("line-width", value);
887
887
  return this;
888
888
  }
889
889
  /**
890
- * Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
891
- *
892
- * @param value - line-gap-width value in pixels
893
- */
890
+ * Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
891
+ *
892
+ * @param value - line-gap-width value in pixels
893
+ */
894
894
  lineGapWidth(value) {
895
895
  this.addStyle("line-gap-width", value);
896
896
  return this;
897
897
  }
898
898
  /**
899
- * The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
900
- *
901
- * @param value - line-offset value in pixels
902
- */
899
+ * The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
900
+ *
901
+ * @param value - line-offset value in pixels
902
+ */
903
903
  lineOffset(value) {
904
904
  this.addStyle("line-offset", value);
905
905
  return this;
906
906
  }
907
907
  /**
908
- * Blur applied to the line, in pixels.
909
- *
910
- * @param value - line-blur value in pixels
911
- */
908
+ * Blur applied to the line, in pixels.
909
+ *
910
+ * @param value - line-blur value in pixels
911
+ */
912
912
  lineBlur(value) {
913
913
  this.addStyle("line-blur", value);
914
914
  return this;
915
915
  }
916
916
  /**
917
- * Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
918
- *
919
- * @param value - line-dasharray value in line widths
920
- */
917
+ * Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
918
+ *
919
+ * @param value - line-dasharray value in line widths
920
+ */
921
921
  lineDasharray(value) {
922
922
  this.addStyle("line-dasharray", value);
923
923
  return this;
924
924
  }
925
925
  /**
926
- * Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
927
- *
928
- * @param value - line-pattern value
929
- */
926
+ * Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
927
+ *
928
+ * @param value - line-pattern value
929
+ */
930
930
  linePattern(value) {
931
931
  this.addStyle("line-pattern", value);
932
932
  return this;
933
933
  }
934
934
  /**
935
- * Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
936
- *
937
- * @param value - line-gradient value
938
- */
935
+ * Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
936
+ *
937
+ * @param value - line-gradient value
938
+ */
939
939
  lineGradient(value) {
940
940
  this.addStyle("line-gradient", value);
941
941
  return this;
@@ -944,350 +944,350 @@ class LineLayerStyleBuilder extends MapLayerStyleBuilder {
944
944
  MapLayerStyleBuilder.registerStyleBuilder("line", LineLayerStyleBuilder);
945
945
  class SymbolLayerStyleBuilder extends MapLayerStyleBuilder {
946
946
  /**
947
- * Label placement relative to its geometry.
948
- *
949
- * Values:
950
- * - point: The label is placed at the point where the geometry is located.
951
- * - line: The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.
952
- * - line-center: The label is placed at the center of the line of the geometry. Can only be used on `LineString` and `Polygon` geometries. Note that a single feature in a vector tile may contain multiple line geometries.
953
- *
954
- * @param value - symbol-placement value (default `point`)
955
- */
947
+ * Label placement relative to its geometry.
948
+ *
949
+ * Values:
950
+ * - point: The label is placed at the point where the geometry is located.
951
+ * - line: The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.
952
+ * - line-center: The label is placed at the center of the line of the geometry. Can only be used on `LineString` and `Polygon` geometries. Note that a single feature in a vector tile may contain multiple line geometries.
953
+ *
954
+ * @param value - symbol-placement value (default `point`)
955
+ */
956
956
  symbolPlacement(value) {
957
957
  this.addStyle("symbol-placement", value);
958
958
  return this;
959
959
  }
960
960
  /**
961
- * Distance between two symbol anchors.
962
- *
963
- * @param value - symbol-spacing value in pixels (default `250`)
964
- */
961
+ * Distance between two symbol anchors.
962
+ *
963
+ * @param value - symbol-spacing value in pixels (default `250`)
964
+ */
965
965
  symbolSpacing(value) {
966
966
  this.addStyle("symbol-spacing", value);
967
967
  return this;
968
968
  }
969
969
  /**
970
- * If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like MapLibre GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
971
- *
972
- * @param value - symbol-avoid-edges value
973
- */
970
+ * If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like MapLibre GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
971
+ *
972
+ * @param value - symbol-avoid-edges value
973
+ */
974
974
  symbolAvoidEdges(value) {
975
975
  this.addStyle("symbol-avoid-edges", value);
976
976
  return this;
977
977
  }
978
978
  /**
979
- * Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When `icon-allow-overlap` or `text-allow-overlap` is `false`, features with a lower sort key will have priority during placement. When `icon-allow-overlap` or `text-allow-overlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.
980
- *
981
- * @param value - symbol-sort-key value
982
- */
979
+ * Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When `icon-allow-overlap` or `text-allow-overlap` is `false`, features with a lower sort key will have priority during placement. When `icon-allow-overlap` or `text-allow-overlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.
980
+ *
981
+ * @param value - symbol-sort-key value
982
+ */
983
983
  symbolSortKey(value) {
984
984
  this.addStyle("symbol-sort-key", value);
985
985
  return this;
986
986
  }
987
987
  /**
988
- * Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use `symbol-sort-key`.
989
- *
990
- * Values:
991
- * - auto: Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.
992
- * - viewport-y: Sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.
993
- * - source: Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data.
994
- *
995
- * @param value - symbol-z-order value (default `auto`)
996
- */
988
+ * Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use `symbol-sort-key`.
989
+ *
990
+ * Values:
991
+ * - auto: Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.
992
+ * - viewport-y: Sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.
993
+ * - source: Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data.
994
+ *
995
+ * @param value - symbol-z-order value (default `auto`)
996
+ */
997
997
  symbolZOrder(value) {
998
998
  this.addStyle("symbol-z-order", value);
999
999
  return this;
1000
1000
  }
1001
1001
  /**
1002
- * If true, the icon will be visible even if it collides with other previously drawn symbols.
1003
- *
1004
- * @param value - icon-allow-overlap value
1005
- */
1002
+ * If true, the icon will be visible even if it collides with other previously drawn symbols.
1003
+ *
1004
+ * @param value - icon-allow-overlap value
1005
+ */
1006
1006
  iconAllowOverlap(value) {
1007
1007
  this.addStyle("icon-allow-overlap", value);
1008
1008
  return this;
1009
1009
  }
1010
1010
  /**
1011
- * Allows for control over whether to show an icon when it overlaps other symbols on the map. If `icon-overlap` is not set, `icon-allow-overlap` is used instead.
1012
- *
1013
- * Values:
1014
- * - never: The icon will be hidden if it collides with any other previously drawn symbol.
1015
- * - always: The icon will be visible even if it collides with any other previously drawn symbol.
1016
- * - cooperative: If the icon collides with another previously drawn symbol, the overlap mode for that symbol is checked. If the previous symbol was placed using `never` overlap mode, the new icon is hidden. If the previous symbol was placed using `always` or `cooperative` overlap mode, the new icon is visible.
1017
- *
1018
- * @param value - icon-overlap value
1019
- */
1011
+ * Allows for control over whether to show an icon when it overlaps other symbols on the map. If `icon-overlap` is not set, `icon-allow-overlap` is used instead.
1012
+ *
1013
+ * Values:
1014
+ * - never: The icon will be hidden if it collides with any other previously drawn symbol.
1015
+ * - always: The icon will be visible even if it collides with any other previously drawn symbol.
1016
+ * - cooperative: If the icon collides with another previously drawn symbol, the overlap mode for that symbol is checked. If the previous symbol was placed using `never` overlap mode, the new icon is hidden. If the previous symbol was placed using `always` or `cooperative` overlap mode, the new icon is visible.
1017
+ *
1018
+ * @param value - icon-overlap value
1019
+ */
1020
1020
  iconOverlap(value) {
1021
1021
  this.addStyle("icon-overlap", value);
1022
1022
  return this;
1023
1023
  }
1024
1024
  /**
1025
- * If true, other symbols can be visible even if they collide with the icon.
1026
- *
1027
- * @param value - icon-ignore-placement value
1028
- */
1025
+ * If true, other symbols can be visible even if they collide with the icon.
1026
+ *
1027
+ * @param value - icon-ignore-placement value
1028
+ */
1029
1029
  iconIgnorePlacement(value) {
1030
1030
  this.addStyle("icon-ignore-placement", value);
1031
1031
  return this;
1032
1032
  }
1033
1033
  /**
1034
- * If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
1035
- *
1036
- * @param value - icon-optional value
1037
- */
1034
+ * If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
1035
+ *
1036
+ * @param value - icon-optional value
1037
+ */
1038
1038
  iconOptional(value) {
1039
1039
  this.addStyle("icon-optional", value);
1040
1040
  return this;
1041
1041
  }
1042
1042
  /**
1043
- * In combination with `symbol-placement`, determines the rotation behavior of icons.
1044
- *
1045
- * Values:
1046
- * - map: When `symbol-placement` is set to `point`, aligns icons east-west. When `symbol-placement` is set to `line` or `line-center`, aligns icon x-axes with the line.
1047
- * - viewport: Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.
1048
- * - auto: When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.
1049
- *
1050
- * @param value - icon-rotation-alignment value (default `auto`)
1051
- */
1043
+ * In combination with `symbol-placement`, determines the rotation behavior of icons.
1044
+ *
1045
+ * Values:
1046
+ * - map: When `symbol-placement` is set to `point`, aligns icons east-west. When `symbol-placement` is set to `line` or `line-center`, aligns icon x-axes with the line.
1047
+ * - viewport: Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.
1048
+ * - auto: When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.
1049
+ *
1050
+ * @param value - icon-rotation-alignment value (default `auto`)
1051
+ */
1052
1052
  iconRotationAlignment(value) {
1053
1053
  this.addStyle("icon-rotation-alignment", value);
1054
1054
  return this;
1055
1055
  }
1056
1056
  /**
1057
- * Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by `icon-size`. 1 is the original size; 3 triples the size of the image.
1058
- *
1059
- * @param value - icon-size value in factor of the original icon size (default `1`)
1060
- */
1057
+ * Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by `icon-size`. 1 is the original size; 3 triples the size of the image.
1058
+ *
1059
+ * @param value - icon-size value in factor of the original icon size (default `1`)
1060
+ */
1061
1061
  iconSize(value) {
1062
1062
  this.addStyle("icon-size", value);
1063
1063
  return this;
1064
1064
  }
1065
1065
  /**
1066
- * Scales the icon to fit around the associated text.
1067
- *
1068
- * Values:
1069
- * - none: The icon is displayed at its intrinsic aspect ratio.
1070
- * - width: The icon is scaled in the x-dimension to fit the width of the text.
1071
- * - height: The icon is scaled in the y-dimension to fit the height of the text.
1072
- * - both: The icon is scaled in both x- and y-dimensions.
1073
- *
1074
- * @param value - icon-text-fit value (default `none`)
1075
- */
1066
+ * Scales the icon to fit around the associated text.
1067
+ *
1068
+ * Values:
1069
+ * - none: The icon is displayed at its intrinsic aspect ratio.
1070
+ * - width: The icon is scaled in the x-dimension to fit the width of the text.
1071
+ * - height: The icon is scaled in the y-dimension to fit the height of the text.
1072
+ * - both: The icon is scaled in both x- and y-dimensions.
1073
+ *
1074
+ * @param value - icon-text-fit value (default `none`)
1075
+ */
1076
1076
  iconTextFit(value) {
1077
1077
  this.addStyle("icon-text-fit", value);
1078
1078
  return this;
1079
1079
  }
1080
1080
  /**
1081
- * Size of the additional area added to dimensions determined by `icon-text-fit`, in clockwise order: top, right, bottom, left.
1082
- *
1083
- * @param value - icon-text-fit-padding value in pixels (default `0,0,0,0`)
1084
- */
1081
+ * Size of the additional area added to dimensions determined by `icon-text-fit`, in clockwise order: top, right, bottom, left.
1082
+ *
1083
+ * @param value - icon-text-fit-padding value in pixels (default `0,0,0,0`)
1084
+ */
1085
1085
  iconTextFitPadding(value) {
1086
1086
  this.addStyle("icon-text-fit-padding", value);
1087
1087
  return this;
1088
1088
  }
1089
1089
  /**
1090
- * Name of image in sprite to use for drawing an image background.
1091
- *
1092
- * @param value - icon-image value
1093
- */
1090
+ * Name of image in sprite to use for drawing an image background.
1091
+ *
1092
+ * @param value - icon-image value
1093
+ */
1094
1094
  iconImage(value) {
1095
1095
  this.addStyle("icon-image", value);
1096
1096
  return this;
1097
1097
  }
1098
1098
  /**
1099
- * Rotates the icon clockwise.
1100
- *
1101
- * @param value - icon-rotate value in degrees
1102
- */
1099
+ * Rotates the icon clockwise.
1100
+ *
1101
+ * @param value - icon-rotate value in degrees
1102
+ */
1103
1103
  iconRotate(value) {
1104
1104
  this.addStyle("icon-rotate", value);
1105
1105
  return this;
1106
1106
  }
1107
1107
  /**
1108
- * Size of additional area round the icon bounding box used for detecting symbol collisions. Values are declared using CSS margin shorthand syntax: a single value applies to all four sides; two values apply to [top/bottom, left/right]; three values apply to [top, left/right, bottom]; four values apply to [top, right, bottom, left]. For backwards compatibility, a single bare number is accepted, and treated the same as a one-element array - padding applied to all sides.
1109
- *
1110
- * @param value - icon-padding value in pixels (default `2`)
1111
- */
1108
+ * Size of additional area round the icon bounding box used for detecting symbol collisions. Values are declared using CSS margin shorthand syntax: a single value applies to all four sides; two values apply to [top/bottom, left/right]; three values apply to [top, left/right, bottom]; four values apply to [top, right, bottom, left]. For backwards compatibility, a single bare number is accepted, and treated the same as a one-element array - padding applied to all sides.
1109
+ *
1110
+ * @param value - icon-padding value in pixels (default `2`)
1111
+ */
1112
1112
  iconPadding(value) {
1113
1113
  this.addStyle("icon-padding", value);
1114
1114
  return this;
1115
1115
  }
1116
1116
  /**
1117
- * If true, the icon may be flipped to prevent it from being rendered upside-down.
1118
- *
1119
- * @param value - icon-keep-upright value
1120
- */
1117
+ * If true, the icon may be flipped to prevent it from being rendered upside-down.
1118
+ *
1119
+ * @param value - icon-keep-upright value
1120
+ */
1121
1121
  iconKeepUpright(value) {
1122
1122
  this.addStyle("icon-keep-upright", value);
1123
1123
  return this;
1124
1124
  }
1125
1125
  /**
1126
- * Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of `icon-size` to obtain the final offset in pixels. When combined with `icon-rotate` the offset will be as if the rotated direction was up.
1127
- *
1128
- * @param value - icon-offset value (default `0,0`)
1129
- */
1126
+ * Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of `icon-size` to obtain the final offset in pixels. When combined with `icon-rotate` the offset will be as if the rotated direction was up.
1127
+ *
1128
+ * @param value - icon-offset value (default `0,0`)
1129
+ */
1130
1130
  iconOffset(value) {
1131
1131
  this.addStyle("icon-offset", value);
1132
1132
  return this;
1133
1133
  }
1134
1134
  /**
1135
- * Part of the icon placed closest to the anchor.
1136
- *
1137
- * Values:
1138
- * - center: The center of the icon is placed closest to the anchor.
1139
- * - left: The left side of the icon is placed closest to the anchor.
1140
- * - right: The right side of the icon is placed closest to the anchor.
1141
- * - top: The top of the icon is placed closest to the anchor.
1142
- * - bottom: The bottom of the icon is placed closest to the anchor.
1143
- * - top-left: The top left corner of the icon is placed closest to the anchor.
1144
- * - top-right: The top right corner of the icon is placed closest to the anchor.
1145
- * - bottom-left: The bottom left corner of the icon is placed closest to the anchor.
1146
- * - bottom-right: The bottom right corner of the icon is placed closest to the anchor.
1147
- *
1148
- * @param value - icon-anchor value (default `center`)
1149
- */
1135
+ * Part of the icon placed closest to the anchor.
1136
+ *
1137
+ * Values:
1138
+ * - center: The center of the icon is placed closest to the anchor.
1139
+ * - left: The left side of the icon is placed closest to the anchor.
1140
+ * - right: The right side of the icon is placed closest to the anchor.
1141
+ * - top: The top of the icon is placed closest to the anchor.
1142
+ * - bottom: The bottom of the icon is placed closest to the anchor.
1143
+ * - top-left: The top left corner of the icon is placed closest to the anchor.
1144
+ * - top-right: The top right corner of the icon is placed closest to the anchor.
1145
+ * - bottom-left: The bottom left corner of the icon is placed closest to the anchor.
1146
+ * - bottom-right: The bottom right corner of the icon is placed closest to the anchor.
1147
+ *
1148
+ * @param value - icon-anchor value (default `center`)
1149
+ */
1150
1150
  iconAnchor(value) {
1151
1151
  this.addStyle("icon-anchor", value);
1152
1152
  return this;
1153
1153
  }
1154
1154
  /**
1155
- * Orientation of icon when map is pitched.
1156
- *
1157
- * Values:
1158
- * - map: The icon is aligned to the plane of the map.
1159
- * - viewport: The icon is aligned to the plane of the viewport.
1160
- * - auto: Automatically matches the value of `icon-rotation-alignment`.
1161
- *
1162
- * @param value - icon-pitch-alignment value (default `auto`)
1163
- */
1155
+ * Orientation of icon when map is pitched.
1156
+ *
1157
+ * Values:
1158
+ * - map: The icon is aligned to the plane of the map.
1159
+ * - viewport: The icon is aligned to the plane of the viewport.
1160
+ * - auto: Automatically matches the value of `icon-rotation-alignment`.
1161
+ *
1162
+ * @param value - icon-pitch-alignment value (default `auto`)
1163
+ */
1164
1164
  iconPitchAlignment(value) {
1165
1165
  this.addStyle("icon-pitch-alignment", value);
1166
1166
  return this;
1167
1167
  }
1168
1168
  /**
1169
- * Orientation of text when map is pitched.
1170
- *
1171
- * Values:
1172
- * - map: The text is aligned to the plane of the map.
1173
- * - viewport: The text is aligned to the plane of the viewport.
1174
- * - auto: Automatically matches the value of `text-rotation-alignment`.
1175
- *
1176
- * @param value - text-pitch-alignment value (default `auto`)
1177
- */
1169
+ * Orientation of text when map is pitched.
1170
+ *
1171
+ * Values:
1172
+ * - map: The text is aligned to the plane of the map.
1173
+ * - viewport: The text is aligned to the plane of the viewport.
1174
+ * - auto: Automatically matches the value of `text-rotation-alignment`.
1175
+ *
1176
+ * @param value - text-pitch-alignment value (default `auto`)
1177
+ */
1178
1178
  textPitchAlignment(value) {
1179
1179
  this.addStyle("text-pitch-alignment", value);
1180
1180
  return this;
1181
1181
  }
1182
1182
  /**
1183
- * In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.
1184
- *
1185
- * Values:
1186
- * - map: When `symbol-placement` is set to `point`, aligns text east-west. When `symbol-placement` is set to `line` or `line-center`, aligns text x-axes with the line.
1187
- * - viewport: Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.
1188
- * - viewport-glyph: When `symbol-placement` is set to `point`, aligns text to the x-axis of the viewport. When `symbol-placement` is set to `line` or `line-center`, aligns glyphs to the x-axis of the viewport and places them along the line.
1189
- * - auto: When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.
1190
- *
1191
- * @param value - text-rotation-alignment value (default `auto`)
1192
- */
1183
+ * In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.
1184
+ *
1185
+ * Values:
1186
+ * - map: When `symbol-placement` is set to `point`, aligns text east-west. When `symbol-placement` is set to `line` or `line-center`, aligns text x-axes with the line.
1187
+ * - viewport: Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.
1188
+ * - viewport-glyph: When `symbol-placement` is set to `point`, aligns text to the x-axis of the viewport. When `symbol-placement` is set to `line` or `line-center`, aligns glyphs to the x-axis of the viewport and places them along the line.
1189
+ * - auto: When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.
1190
+ *
1191
+ * @param value - text-rotation-alignment value (default `auto`)
1192
+ */
1193
1193
  textRotationAlignment(value) {
1194
1194
  this.addStyle("text-rotation-alignment", value);
1195
1195
  return this;
1196
1196
  }
1197
1197
  /**
1198
- * Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
1199
- *
1200
- * @param value - text-field value
1201
- */
1198
+ * Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
1199
+ *
1200
+ * @param value - text-field value
1201
+ */
1202
1202
  textField(value) {
1203
1203
  this.addStyle("text-field", value);
1204
1204
  return this;
1205
1205
  }
1206
1206
  /**
1207
- * Font stack to use for displaying text.
1208
- *
1209
- * @param value - text-font value (default `Open Sans Regular,Arial Unicode MS Regular`)
1210
- */
1207
+ * Font stack to use for displaying text.
1208
+ *
1209
+ * @param value - text-font value (default `Open Sans Regular,Arial Unicode MS Regular`)
1210
+ */
1211
1211
  textFont(value) {
1212
1212
  this.addStyle("text-font", value);
1213
1213
  return this;
1214
1214
  }
1215
1215
  /**
1216
- * Font size.
1217
- *
1218
- * @param value - text-size value in pixels (default `16`)
1219
- */
1216
+ * Font size.
1217
+ *
1218
+ * @param value - text-size value in pixels (default `16`)
1219
+ */
1220
1220
  textSize(value) {
1221
1221
  this.addStyle("text-size", value);
1222
1222
  return this;
1223
1223
  }
1224
1224
  /**
1225
- * The maximum line width for text wrapping.
1226
- *
1227
- * @param value - text-max-width value in ems (default `10`)
1228
- */
1225
+ * The maximum line width for text wrapping.
1226
+ *
1227
+ * @param value - text-max-width value in ems (default `10`)
1228
+ */
1229
1229
  textMaxWidth(value) {
1230
1230
  this.addStyle("text-max-width", value);
1231
1231
  return this;
1232
1232
  }
1233
1233
  /**
1234
- * Text leading value for multi-line text.
1235
- *
1236
- * @param value - text-line-height value in ems (default `1.2`)
1237
- */
1234
+ * Text leading value for multi-line text.
1235
+ *
1236
+ * @param value - text-line-height value in ems (default `1.2`)
1237
+ */
1238
1238
  textLineHeight(value) {
1239
1239
  this.addStyle("text-line-height", value);
1240
1240
  return this;
1241
1241
  }
1242
1242
  /**
1243
- * Text tracking amount.
1244
- *
1245
- * @param value - text-letter-spacing value in ems
1246
- */
1243
+ * Text tracking amount.
1244
+ *
1245
+ * @param value - text-letter-spacing value in ems
1246
+ */
1247
1247
  textLetterSpacing(value) {
1248
1248
  this.addStyle("text-letter-spacing", value);
1249
1249
  return this;
1250
1250
  }
1251
1251
  /**
1252
- * Text justification options.
1253
- *
1254
- * Values:
1255
- * - auto: The text is aligned towards the anchor position.
1256
- * - left: The text is aligned to the left.
1257
- * - center: The text is centered.
1258
- * - right: The text is aligned to the right.
1259
- *
1260
- * @param value - text-justify value (default `center`)
1261
- */
1252
+ * Text justification options.
1253
+ *
1254
+ * Values:
1255
+ * - auto: The text is aligned towards the anchor position.
1256
+ * - left: The text is aligned to the left.
1257
+ * - center: The text is centered.
1258
+ * - right: The text is aligned to the right.
1259
+ *
1260
+ * @param value - text-justify value (default `center`)
1261
+ */
1262
1262
  textJustify(value) {
1263
1263
  this.addStyle("text-justify", value);
1264
1264
  return this;
1265
1265
  }
1266
1266
  /**
1267
- * Radial offset of text, in the direction of the symbol's anchor. Useful in combination with `text-variable-anchor`, which defaults to using the two-dimensional `text-offset` if present.
1268
- *
1269
- * @param value - text-radial-offset value in ems
1270
- */
1267
+ * Radial offset of text, in the direction of the symbol's anchor. Useful in combination with `text-variable-anchor`, which defaults to using the two-dimensional `text-offset` if present.
1268
+ *
1269
+ * @param value - text-radial-offset value in ems
1270
+ */
1271
1271
  textRadialOffset(value) {
1272
1272
  this.addStyle("text-radial-offset", value);
1273
1273
  return this;
1274
1274
  }
1275
1275
  /**
1276
- * To increase the chance of placing high-priority labels on the map, you can provide an array of `text-anchor` locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use `text-justify: auto` to choose justification based on anchor position. To apply an offset, use the `text-radial-offset` or the two-dimensional `text-offset`.
1277
- *
1278
- * Values:
1279
- * - center: The center of the text is placed closest to the anchor.
1280
- * - left: The left side of the text is placed closest to the anchor.
1281
- * - right: The right side of the text is placed closest to the anchor.
1282
- * - top: The top of the text is placed closest to the anchor.
1283
- * - bottom: The bottom of the text is placed closest to the anchor.
1284
- * - top-left: The top left corner of the text is placed closest to the anchor.
1285
- * - top-right: The top right corner of the text is placed closest to the anchor.
1286
- * - bottom-left: The bottom left corner of the text is placed closest to the anchor.
1287
- * - bottom-right: The bottom right corner of the text is placed closest to the anchor.
1288
- *
1289
- * @param value - text-variable-anchor value
1290
- */
1276
+ * To increase the chance of placing high-priority labels on the map, you can provide an array of `text-anchor` locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use `text-justify: auto` to choose justification based on anchor position. To apply an offset, use the `text-radial-offset` or the two-dimensional `text-offset`.
1277
+ *
1278
+ * Values:
1279
+ * - center: The center of the text is placed closest to the anchor.
1280
+ * - left: The left side of the text is placed closest to the anchor.
1281
+ * - right: The right side of the text is placed closest to the anchor.
1282
+ * - top: The top of the text is placed closest to the anchor.
1283
+ * - bottom: The bottom of the text is placed closest to the anchor.
1284
+ * - top-left: The top left corner of the text is placed closest to the anchor.
1285
+ * - top-right: The top right corner of the text is placed closest to the anchor.
1286
+ * - bottom-left: The bottom left corner of the text is placed closest to the anchor.
1287
+ * - bottom-right: The bottom right corner of the text is placed closest to the anchor.
1288
+ *
1289
+ * @param value - text-variable-anchor value
1290
+ */
1291
1291
  textVariableAnchor(value) {
1292
1292
  this.addStyle("text-variable-anchor", value);
1293
1293
  return this;
@@ -1314,268 +1314,268 @@ class SymbolLayerStyleBuilder extends MapLayerStyleBuilder {
1314
1314
  return this;
1315
1315
  }
1316
1316
  /**
1317
- * Part of the text placed closest to the anchor.
1318
- *
1319
- * Values:
1320
- * - center: The center of the text is placed closest to the anchor.
1321
- * - left: The left side of the text is placed closest to the anchor.
1322
- * - right: The right side of the text is placed closest to the anchor.
1323
- * - top: The top of the text is placed closest to the anchor.
1324
- * - bottom: The bottom of the text is placed closest to the anchor.
1325
- * - top-left: The top left corner of the text is placed closest to the anchor.
1326
- * - top-right: The top right corner of the text is placed closest to the anchor.
1327
- * - bottom-left: The bottom left corner of the text is placed closest to the anchor.
1328
- * - bottom-right: The bottom right corner of the text is placed closest to the anchor.
1329
- *
1330
- * @param value - text-anchor value (default `center`)
1331
- */
1317
+ * Part of the text placed closest to the anchor.
1318
+ *
1319
+ * Values:
1320
+ * - center: The center of the text is placed closest to the anchor.
1321
+ * - left: The left side of the text is placed closest to the anchor.
1322
+ * - right: The right side of the text is placed closest to the anchor.
1323
+ * - top: The top of the text is placed closest to the anchor.
1324
+ * - bottom: The bottom of the text is placed closest to the anchor.
1325
+ * - top-left: The top left corner of the text is placed closest to the anchor.
1326
+ * - top-right: The top right corner of the text is placed closest to the anchor.
1327
+ * - bottom-left: The bottom left corner of the text is placed closest to the anchor.
1328
+ * - bottom-right: The bottom right corner of the text is placed closest to the anchor.
1329
+ *
1330
+ * @param value - text-anchor value (default `center`)
1331
+ */
1332
1332
  textAnchor(value) {
1333
1333
  this.addStyle("text-anchor", value);
1334
1334
  return this;
1335
1335
  }
1336
1336
  /**
1337
- * Maximum angle change between adjacent characters.
1338
- *
1339
- * @param value - text-max-angle value in degrees (default `45`)
1340
- */
1337
+ * Maximum angle change between adjacent characters.
1338
+ *
1339
+ * @param value - text-max-angle value in degrees (default `45`)
1340
+ */
1341
1341
  textMaxAngle(value) {
1342
1342
  this.addStyle("text-max-angle", value);
1343
1343
  return this;
1344
1344
  }
1345
1345
  /**
1346
- * The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.
1347
- *
1348
- * Values:
1349
- * - horizontal: If a text's language supports horizontal writing mode, symbols with point placement would be laid out horizontally.
1350
- * - vertical: If a text's language supports vertical writing mode, symbols with point placement would be laid out vertically.
1351
- *
1352
- * @param value - text-writing-mode value
1353
- */
1346
+ * The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.
1347
+ *
1348
+ * Values:
1349
+ * - horizontal: If a text's language supports horizontal writing mode, symbols with point placement would be laid out horizontally.
1350
+ * - vertical: If a text's language supports vertical writing mode, symbols with point placement would be laid out vertically.
1351
+ *
1352
+ * @param value - text-writing-mode value
1353
+ */
1354
1354
  textWritingMode(value) {
1355
1355
  this.addStyle("text-writing-mode", value);
1356
1356
  return this;
1357
1357
  }
1358
1358
  /**
1359
- * Rotates the text clockwise.
1360
- *
1361
- * @param value - text-rotate value in degrees
1362
- */
1359
+ * Rotates the text clockwise.
1360
+ *
1361
+ * @param value - text-rotate value in degrees
1362
+ */
1363
1363
  textRotate(value) {
1364
1364
  this.addStyle("text-rotate", value);
1365
1365
  return this;
1366
1366
  }
1367
1367
  /**
1368
- * Size of the additional area around the text bounding box used for detecting symbol collisions.
1369
- *
1370
- * @param value - text-padding value in pixels (default `2`)
1371
- */
1368
+ * Size of the additional area around the text bounding box used for detecting symbol collisions.
1369
+ *
1370
+ * @param value - text-padding value in pixels (default `2`)
1371
+ */
1372
1372
  textPadding(value) {
1373
1373
  this.addStyle("text-padding", value);
1374
1374
  return this;
1375
1375
  }
1376
1376
  /**
1377
- * If true, the text may be flipped vertically to prevent it from being rendered upside-down.
1378
- *
1379
- * @param value - text-keep-upright value (default `true`)
1380
- */
1377
+ * If true, the text may be flipped vertically to prevent it from being rendered upside-down.
1378
+ *
1379
+ * @param value - text-keep-upright value (default `true`)
1380
+ */
1381
1381
  textKeepUpright(value) {
1382
1382
  this.addStyle("text-keep-upright", value);
1383
1383
  return this;
1384
1384
  }
1385
1385
  /**
1386
- * Specifies how to capitalize text, similar to the CSS `text-transform` property.
1387
- *
1388
- * Values:
1389
- * - none: The text is not altered.
1390
- * - uppercase: Forces all letters to be displayed in uppercase.
1391
- * - lowercase: Forces all letters to be displayed in lowercase.
1392
- *
1393
- * @param value - text-transform value (default `none`)
1394
- */
1386
+ * Specifies how to capitalize text, similar to the CSS `text-transform` property.
1387
+ *
1388
+ * Values:
1389
+ * - none: The text is not altered.
1390
+ * - uppercase: Forces all letters to be displayed in uppercase.
1391
+ * - lowercase: Forces all letters to be displayed in lowercase.
1392
+ *
1393
+ * @param value - text-transform value (default `none`)
1394
+ */
1395
1395
  textTransform(value) {
1396
1396
  this.addStyle("text-transform", value);
1397
1397
  return this;
1398
1398
  }
1399
1399
  /**
1400
- * Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
1401
- *
1402
- * @param value - text-offset value in ems (default `0,0`)
1403
- */
1400
+ * Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
1401
+ *
1402
+ * @param value - text-offset value in ems (default `0,0`)
1403
+ */
1404
1404
  textOffset(value) {
1405
1405
  this.addStyle("text-offset", value);
1406
1406
  return this;
1407
1407
  }
1408
1408
  /**
1409
- * If true, the text will be visible even if it collides with other previously drawn symbols.
1410
- *
1411
- * @param value - text-allow-overlap value
1412
- */
1409
+ * If true, the text will be visible even if it collides with other previously drawn symbols.
1410
+ *
1411
+ * @param value - text-allow-overlap value
1412
+ */
1413
1413
  textAllowOverlap(value) {
1414
1414
  this.addStyle("text-allow-overlap", value);
1415
1415
  return this;
1416
1416
  }
1417
1417
  /**
1418
- * Allows for control over whether to show symbol text when it overlaps other symbols on the map. If `text-overlap` is not set, `text-allow-overlap` is used instead
1419
- *
1420
- * Values:
1421
- * - never: The text will be hidden if it collides with any other previously drawn symbol.
1422
- * - always: The text will be visible even if it collides with any other previously drawn symbol.
1423
- * - cooperative: If the text collides with another previously drawn symbol, the overlap mode for that symbol is checked. If the previous symbol was placed using `never` overlap mode, the new text is hidden. If the previous symbol was placed using `always` or `cooperative` overlap mode, the new text is visible.
1424
- *
1425
- * @param value - text-overlap value
1426
- */
1418
+ * Allows for control over whether to show symbol text when it overlaps other symbols on the map. If `text-overlap` is not set, `text-allow-overlap` is used instead
1419
+ *
1420
+ * Values:
1421
+ * - never: The text will be hidden if it collides with any other previously drawn symbol.
1422
+ * - always: The text will be visible even if it collides with any other previously drawn symbol.
1423
+ * - cooperative: If the text collides with another previously drawn symbol, the overlap mode for that symbol is checked. If the previous symbol was placed using `never` overlap mode, the new text is hidden. If the previous symbol was placed using `always` or `cooperative` overlap mode, the new text is visible.
1424
+ *
1425
+ * @param value - text-overlap value
1426
+ */
1427
1427
  textOverlap(value) {
1428
1428
  this.addStyle("text-overlap", value);
1429
1429
  return this;
1430
1430
  }
1431
1431
  /**
1432
- * If true, other symbols can be visible even if they collide with the text.
1433
- *
1434
- * @param value - text-ignore-placement value
1435
- */
1432
+ * If true, other symbols can be visible even if they collide with the text.
1433
+ *
1434
+ * @param value - text-ignore-placement value
1435
+ */
1436
1436
  textIgnorePlacement(value) {
1437
1437
  this.addStyle("text-ignore-placement", value);
1438
1438
  return this;
1439
1439
  }
1440
1440
  /**
1441
- * If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
1442
- *
1443
- * @param value - text-optional value
1444
- */
1441
+ * If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
1442
+ *
1443
+ * @param value - text-optional value
1444
+ */
1445
1445
  textOptional(value) {
1446
1446
  this.addStyle("text-optional", value);
1447
1447
  return this;
1448
1448
  }
1449
1449
  /**
1450
- * The opacity at which the icon will be drawn.
1451
- *
1452
- * @param value - icon-opacity value (default `1`)
1453
- */
1450
+ * The opacity at which the icon will be drawn.
1451
+ *
1452
+ * @param value - icon-opacity value (default `1`)
1453
+ */
1454
1454
  iconOpacity(value) {
1455
1455
  this.addStyle("icon-opacity", value);
1456
1456
  return this;
1457
1457
  }
1458
1458
  /**
1459
- * The color of the icon. This can only be used with sdf icons.
1460
- *
1461
- * @param value - icon-color value (default `#000000`)
1462
- */
1459
+ * The color of the icon. This can only be used with sdf icons.
1460
+ *
1461
+ * @param value - icon-color value (default `#000000`)
1462
+ */
1463
1463
  iconColor(value) {
1464
1464
  this.addStyle("icon-color", value);
1465
1465
  return this;
1466
1466
  }
1467
1467
  /**
1468
- * The color of the icon's halo. Icon halos can only be used with SDF icons.
1469
- *
1470
- * @param value - icon-halo-color value (default `rgba(0, 0, 0, 0)`)
1471
- */
1468
+ * The color of the icon's halo. Icon halos can only be used with SDF icons.
1469
+ *
1470
+ * @param value - icon-halo-color value (default `rgba(0, 0, 0, 0)`)
1471
+ */
1472
1472
  iconHaloColor(value) {
1473
1473
  this.addStyle("icon-halo-color", value);
1474
1474
  return this;
1475
1475
  }
1476
1476
  /**
1477
- * Distance of halo to the icon outline.
1478
- *
1479
- * @param value - icon-halo-width value in pixels
1480
- */
1477
+ * Distance of halo to the icon outline.
1478
+ *
1479
+ * @param value - icon-halo-width value in pixels
1480
+ */
1481
1481
  iconHaloWidth(value) {
1482
1482
  this.addStyle("icon-halo-width", value);
1483
1483
  return this;
1484
1484
  }
1485
1485
  /**
1486
- * Fade out the halo towards the outside.
1487
- *
1488
- * @param value - icon-halo-blur value in pixels
1489
- */
1486
+ * Fade out the halo towards the outside.
1487
+ *
1488
+ * @param value - icon-halo-blur value in pixels
1489
+ */
1490
1490
  iconHaloBlur(value) {
1491
1491
  this.addStyle("icon-halo-blur", value);
1492
1492
  return this;
1493
1493
  }
1494
1494
  /**
1495
- * Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
1496
- *
1497
- * @param value - icon-translate value in pixels (default `0,0`)
1498
- */
1495
+ * Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
1496
+ *
1497
+ * @param value - icon-translate value in pixels (default `0,0`)
1498
+ */
1499
1499
  iconTranslate(value) {
1500
1500
  this.addStyle("icon-translate", value);
1501
1501
  return this;
1502
1502
  }
1503
1503
  /**
1504
- * Controls the frame of reference for `icon-translate`.
1505
- *
1506
- * Values:
1507
- * - map: Icons are translated relative to the map.
1508
- * - viewport: Icons are translated relative to the viewport.
1509
- *
1510
- * @param value - icon-translate-anchor value (default `map`)
1511
- */
1504
+ * Controls the frame of reference for `icon-translate`.
1505
+ *
1506
+ * Values:
1507
+ * - map: Icons are translated relative to the map.
1508
+ * - viewport: Icons are translated relative to the viewport.
1509
+ *
1510
+ * @param value - icon-translate-anchor value (default `map`)
1511
+ */
1512
1512
  iconTranslateAnchor(value) {
1513
1513
  this.addStyle("icon-translate-anchor", value);
1514
1514
  return this;
1515
1515
  }
1516
1516
  /**
1517
- * The opacity at which the text will be drawn.
1518
- *
1519
- * @param value - text-opacity value (default `1`)
1520
- */
1517
+ * The opacity at which the text will be drawn.
1518
+ *
1519
+ * @param value - text-opacity value (default `1`)
1520
+ */
1521
1521
  textOpacity(value) {
1522
1522
  this.addStyle("text-opacity", value);
1523
1523
  return this;
1524
1524
  }
1525
1525
  /**
1526
- * The color with which the text will be drawn.
1527
- *
1528
- * @param value - text-color value (default `#000000`)
1529
- */
1526
+ * The color with which the text will be drawn.
1527
+ *
1528
+ * @param value - text-color value (default `#000000`)
1529
+ */
1530
1530
  textColor(value) {
1531
1531
  this.addStyle("text-color", value);
1532
1532
  return this;
1533
1533
  }
1534
1534
  /**
1535
- * The color of the text's halo, which helps it stand out from backgrounds.
1536
- *
1537
- * @param value - text-halo-color value (default `rgba(0, 0, 0, 0)`)
1538
- */
1535
+ * The color of the text's halo, which helps it stand out from backgrounds.
1536
+ *
1537
+ * @param value - text-halo-color value (default `rgba(0, 0, 0, 0)`)
1538
+ */
1539
1539
  textHaloColor(value) {
1540
1540
  this.addStyle("text-halo-color", value);
1541
1541
  return this;
1542
1542
  }
1543
1543
  /**
1544
- * Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
1545
- *
1546
- * @param value - text-halo-width value in pixels
1547
- */
1544
+ * Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
1545
+ *
1546
+ * @param value - text-halo-width value in pixels
1547
+ */
1548
1548
  textHaloWidth(value) {
1549
1549
  this.addStyle("text-halo-width", value);
1550
1550
  return this;
1551
1551
  }
1552
1552
  /**
1553
- * The halo's fadeout distance towards the outside.
1554
- *
1555
- * @param value - text-halo-blur value in pixels
1556
- */
1553
+ * The halo's fadeout distance towards the outside.
1554
+ *
1555
+ * @param value - text-halo-blur value in pixels
1556
+ */
1557
1557
  textHaloBlur(value) {
1558
1558
  this.addStyle("text-halo-blur", value);
1559
1559
  return this;
1560
1560
  }
1561
1561
  /**
1562
- * Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
1563
- *
1564
- * @param value - text-translate value in pixels (default `0,0`)
1565
- */
1562
+ * Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
1563
+ *
1564
+ * @param value - text-translate value in pixels (default `0,0`)
1565
+ */
1566
1566
  textTranslate(value) {
1567
1567
  this.addStyle("text-translate", value);
1568
1568
  return this;
1569
1569
  }
1570
1570
  /**
1571
- * Controls the frame of reference for `text-translate`.
1572
- *
1573
- * Values:
1574
- * - map: The text is translated relative to the map.
1575
- * - viewport: The text is translated relative to the viewport.
1576
- *
1577
- * @param value - text-translate-anchor value (default `map`)
1578
- */
1571
+ * Controls the frame of reference for `text-translate`.
1572
+ *
1573
+ * Values:
1574
+ * - map: The text is translated relative to the map.
1575
+ * - viewport: The text is translated relative to the viewport.
1576
+ *
1577
+ * @param value - text-translate-anchor value (default `map`)
1578
+ */
1579
1579
  textTranslateAnchor(value) {
1580
1580
  this.addStyle("text-translate-anchor", value);
1581
1581
  return this;
@@ -1584,121 +1584,121 @@ class SymbolLayerStyleBuilder extends MapLayerStyleBuilder {
1584
1584
  MapLayerStyleBuilder.registerStyleBuilder("symbol", SymbolLayerStyleBuilder);
1585
1585
  class CircleLayerStyleBuilder extends MapLayerStyleBuilder {
1586
1586
  /**
1587
- * Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
1588
- *
1589
- * @param value - circle-sort-key value
1590
- */
1587
+ * Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
1588
+ *
1589
+ * @param value - circle-sort-key value
1590
+ */
1591
1591
  circleSortKey(value) {
1592
1592
  this.addStyle("circle-sort-key", value);
1593
1593
  return this;
1594
1594
  }
1595
1595
  /**
1596
- * Circle radius.
1597
- *
1598
- * @param value - circle-radius value in pixels (default `5`)
1599
- */
1596
+ * Circle radius.
1597
+ *
1598
+ * @param value - circle-radius value in pixels (default `5`)
1599
+ */
1600
1600
  circleRadius(value) {
1601
1601
  this.addStyle("circle-radius", value);
1602
1602
  return this;
1603
1603
  }
1604
1604
  /**
1605
- * The fill color of the circle.
1606
- *
1607
- * @param value - circle-color value (default `#000000`)
1608
- */
1605
+ * The fill color of the circle.
1606
+ *
1607
+ * @param value - circle-color value (default `#000000`)
1608
+ */
1609
1609
  circleColor(value) {
1610
1610
  this.addStyle("circle-color", value);
1611
1611
  return this;
1612
1612
  }
1613
1613
  /**
1614
- * Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
1615
- *
1616
- * @param value - circle-blur value
1617
- */
1614
+ * Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
1615
+ *
1616
+ * @param value - circle-blur value
1617
+ */
1618
1618
  circleBlur(value) {
1619
1619
  this.addStyle("circle-blur", value);
1620
1620
  return this;
1621
1621
  }
1622
1622
  /**
1623
- * The opacity at which the circle will be drawn.
1624
- *
1625
- * @param value - circle-opacity value (default `1`)
1626
- */
1623
+ * The opacity at which the circle will be drawn.
1624
+ *
1625
+ * @param value - circle-opacity value (default `1`)
1626
+ */
1627
1627
  circleOpacity(value) {
1628
1628
  this.addStyle("circle-opacity", value);
1629
1629
  return this;
1630
1630
  }
1631
1631
  /**
1632
- * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
1633
- *
1634
- * @param value - circle-translate value in pixels (default `0,0`)
1635
- */
1632
+ * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
1633
+ *
1634
+ * @param value - circle-translate value in pixels (default `0,0`)
1635
+ */
1636
1636
  circleTranslate(value) {
1637
1637
  this.addStyle("circle-translate", value);
1638
1638
  return this;
1639
1639
  }
1640
1640
  /**
1641
- * Controls the frame of reference for `circle-translate`.
1642
- *
1643
- * Values:
1644
- * - map: The circle is translated relative to the map.
1645
- * - viewport: The circle is translated relative to the viewport.
1646
- *
1647
- * @param value - circle-translate-anchor value (default `map`)
1648
- */
1641
+ * Controls the frame of reference for `circle-translate`.
1642
+ *
1643
+ * Values:
1644
+ * - map: The circle is translated relative to the map.
1645
+ * - viewport: The circle is translated relative to the viewport.
1646
+ *
1647
+ * @param value - circle-translate-anchor value (default `map`)
1648
+ */
1649
1649
  circleTranslateAnchor(value) {
1650
1650
  this.addStyle("circle-translate-anchor", value);
1651
1651
  return this;
1652
1652
  }
1653
1653
  /**
1654
- * Controls the scaling behavior of the circle when the map is pitched.
1655
- *
1656
- * Values:
1657
- * - map: Circles are scaled according to their apparent distance to the camera.
1658
- * - viewport: Circles are not scaled.
1659
- *
1660
- * @param value - circle-pitch-scale value (default `map`)
1661
- */
1654
+ * Controls the scaling behavior of the circle when the map is pitched.
1655
+ *
1656
+ * Values:
1657
+ * - map: Circles are scaled according to their apparent distance to the camera.
1658
+ * - viewport: Circles are not scaled.
1659
+ *
1660
+ * @param value - circle-pitch-scale value (default `map`)
1661
+ */
1662
1662
  circlePitchScale(value) {
1663
1663
  this.addStyle("circle-pitch-scale", value);
1664
1664
  return this;
1665
1665
  }
1666
1666
  /**
1667
- * Orientation of circle when map is pitched.
1668
- *
1669
- * Values:
1670
- * - map: The circle is aligned to the plane of the map.
1671
- * - viewport: The circle is aligned to the plane of the viewport.
1672
- *
1673
- * @param value - circle-pitch-alignment value (default `viewport`)
1674
- */
1667
+ * Orientation of circle when map is pitched.
1668
+ *
1669
+ * Values:
1670
+ * - map: The circle is aligned to the plane of the map.
1671
+ * - viewport: The circle is aligned to the plane of the viewport.
1672
+ *
1673
+ * @param value - circle-pitch-alignment value (default `viewport`)
1674
+ */
1675
1675
  circlePitchAlignment(value) {
1676
1676
  this.addStyle("circle-pitch-alignment", value);
1677
1677
  return this;
1678
1678
  }
1679
1679
  /**
1680
- * The width of the circle's stroke. Strokes are placed outside of the `circle-radius`.
1681
- *
1682
- * @param value - circle-stroke-width value in pixels
1683
- */
1680
+ * The width of the circle's stroke. Strokes are placed outside of the `circle-radius`.
1681
+ *
1682
+ * @param value - circle-stroke-width value in pixels
1683
+ */
1684
1684
  circleStrokeWidth(value) {
1685
1685
  this.addStyle("circle-stroke-width", value);
1686
1686
  return this;
1687
1687
  }
1688
1688
  /**
1689
- * The stroke color of the circle.
1690
- *
1691
- * @param value - circle-stroke-color value (default `#000000`)
1692
- */
1689
+ * The stroke color of the circle.
1690
+ *
1691
+ * @param value - circle-stroke-color value (default `#000000`)
1692
+ */
1693
1693
  circleStrokeColor(value) {
1694
1694
  this.addStyle("circle-stroke-color", value);
1695
1695
  return this;
1696
1696
  }
1697
1697
  /**
1698
- * The opacity of the circle's stroke.
1699
- *
1700
- * @param value - circle-stroke-opacity value (default `1`)
1701
- */
1698
+ * The opacity of the circle's stroke.
1699
+ *
1700
+ * @param value - circle-stroke-opacity value (default `1`)
1701
+ */
1702
1702
  circleStrokeOpacity(value) {
1703
1703
  this.addStyle("circle-stroke-opacity", value);
1704
1704
  return this;
@@ -1707,46 +1707,46 @@ class CircleLayerStyleBuilder extends MapLayerStyleBuilder {
1707
1707
  MapLayerStyleBuilder.registerStyleBuilder("circle", CircleLayerStyleBuilder);
1708
1708
  class HeatmapLayerStyleBuilder extends MapLayerStyleBuilder {
1709
1709
  /**
1710
- * Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
1711
- *
1712
- * @param value - heatmap-radius value in pixels (default `30`)
1713
- */
1710
+ * Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
1711
+ *
1712
+ * @param value - heatmap-radius value in pixels (default `30`)
1713
+ */
1714
1714
  heatmapRadius(value) {
1715
1715
  this.addStyle("heatmap-radius", value);
1716
1716
  return this;
1717
1717
  }
1718
1718
  /**
1719
- * A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
1720
- *
1721
- * @param value - heatmap-weight value (default `1`)
1722
- */
1719
+ * A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
1720
+ *
1721
+ * @param value - heatmap-weight value (default `1`)
1722
+ */
1723
1723
  heatmapWeight(value) {
1724
1724
  this.addStyle("heatmap-weight", value);
1725
1725
  return this;
1726
1726
  }
1727
1727
  /**
1728
- * Similar to `heatmap-weight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
1729
- *
1730
- * @param value - heatmap-intensity value (default `1`)
1731
- */
1728
+ * Similar to `heatmap-weight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
1729
+ *
1730
+ * @param value - heatmap-intensity value (default `1`)
1731
+ */
1732
1732
  heatmapIntensity(value) {
1733
1733
  this.addStyle("heatmap-intensity", value);
1734
1734
  return this;
1735
1735
  }
1736
1736
  /**
1737
- * Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.
1738
- *
1739
- * @param value - heatmap-color value (default `interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red`)
1740
- */
1737
+ * Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.
1738
+ *
1739
+ * @param value - heatmap-color value (default `interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red`)
1740
+ */
1741
1741
  heatmapColor(value) {
1742
1742
  this.addStyle("heatmap-color", value);
1743
1743
  return this;
1744
1744
  }
1745
1745
  /**
1746
- * The global opacity at which the heatmap layer will be drawn.
1747
- *
1748
- * @param value - heatmap-opacity value (default `1`)
1749
- */
1746
+ * The global opacity at which the heatmap layer will be drawn.
1747
+ *
1748
+ * @param value - heatmap-opacity value (default `1`)
1749
+ */
1750
1750
  heatmapOpacity(value) {
1751
1751
  this.addStyle("heatmap-opacity", value);
1752
1752
  return this;
@@ -1755,77 +1755,77 @@ class HeatmapLayerStyleBuilder extends MapLayerStyleBuilder {
1755
1755
  MapLayerStyleBuilder.registerStyleBuilder("heatmap", HeatmapLayerStyleBuilder);
1756
1756
  class FillExtrusionLayerStyleBuilder extends MapLayerStyleBuilder {
1757
1757
  /**
1758
- * The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
1759
- *
1760
- * @param value - fill-extrusion-opacity value (default `1`)
1761
- */
1758
+ * The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
1759
+ *
1760
+ * @param value - fill-extrusion-opacity value (default `1`)
1761
+ */
1762
1762
  fillExtrusionOpacity(value) {
1763
1763
  this.addStyle("fill-extrusion-opacity", value);
1764
1764
  return this;
1765
1765
  }
1766
1766
  /**
1767
- * The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fill-extrusion-opacity` to set layer opacity.
1768
- *
1769
- * @param value - fill-extrusion-color value (default `#000000`)
1770
- */
1767
+ * The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fill-extrusion-opacity` to set layer opacity.
1768
+ *
1769
+ * @param value - fill-extrusion-color value (default `#000000`)
1770
+ */
1771
1771
  fillExtrusionColor(value) {
1772
1772
  this.addStyle("fill-extrusion-color", value);
1773
1773
  return this;
1774
1774
  }
1775
1775
  /**
1776
- * The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
1777
- *
1778
- * @param value - fill-extrusion-translate value in pixels (default `0,0`)
1779
- */
1776
+ * The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
1777
+ *
1778
+ * @param value - fill-extrusion-translate value in pixels (default `0,0`)
1779
+ */
1780
1780
  fillExtrusionTranslate(value) {
1781
1781
  this.addStyle("fill-extrusion-translate", value);
1782
1782
  return this;
1783
1783
  }
1784
1784
  /**
1785
- * Controls the frame of reference for `fill-extrusion-translate`.
1786
- *
1787
- * Values:
1788
- * - map: The fill extrusion is translated relative to the map.
1789
- * - viewport: The fill extrusion is translated relative to the viewport.
1790
- *
1791
- * @param value - fill-extrusion-translate-anchor value (default `map`)
1792
- */
1785
+ * Controls the frame of reference for `fill-extrusion-translate`.
1786
+ *
1787
+ * Values:
1788
+ * - map: The fill extrusion is translated relative to the map.
1789
+ * - viewport: The fill extrusion is translated relative to the viewport.
1790
+ *
1791
+ * @param value - fill-extrusion-translate-anchor value (default `map`)
1792
+ */
1793
1793
  fillExtrusionTranslateAnchor(value) {
1794
1794
  this.addStyle("fill-extrusion-translate-anchor", value);
1795
1795
  return this;
1796
1796
  }
1797
1797
  /**
1798
- * Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
1799
- *
1800
- * @param value - fill-extrusion-pattern value
1801
- */
1798
+ * Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
1799
+ *
1800
+ * @param value - fill-extrusion-pattern value
1801
+ */
1802
1802
  fillExtrusionPattern(value) {
1803
1803
  this.addStyle("fill-extrusion-pattern", value);
1804
1804
  return this;
1805
1805
  }
1806
1806
  /**
1807
- * The height with which to extrude this layer.
1808
- *
1809
- * @param value - fill-extrusion-height value in meters
1810
- */
1807
+ * The height with which to extrude this layer.
1808
+ *
1809
+ * @param value - fill-extrusion-height value in meters
1810
+ */
1811
1811
  fillExtrusionHeight(value) {
1812
1812
  this.addStyle("fill-extrusion-height", value);
1813
1813
  return this;
1814
1814
  }
1815
1815
  /**
1816
- * The height with which to extrude the base of this layer. Must be less than or equal to `fill-extrusion-height`.
1817
- *
1818
- * @param value - fill-extrusion-base value in meters
1819
- */
1816
+ * The height with which to extrude the base of this layer. Must be less than or equal to `fill-extrusion-height`.
1817
+ *
1818
+ * @param value - fill-extrusion-base value in meters
1819
+ */
1820
1820
  fillExtrusionBase(value) {
1821
1821
  this.addStyle("fill-extrusion-base", value);
1822
1822
  return this;
1823
1823
  }
1824
1824
  /**
1825
- * Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
1826
- *
1827
- * @param value - fill-extrusion-vertical-gradient value (default `true`)
1828
- */
1825
+ * Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
1826
+ *
1827
+ * @param value - fill-extrusion-vertical-gradient value (default `true`)
1828
+ */
1829
1829
  fillExtrusionVerticalGradient(value) {
1830
1830
  this.addStyle("fill-extrusion-vertical-gradient", value);
1831
1831
  return this;
@@ -1834,77 +1834,77 @@ class FillExtrusionLayerStyleBuilder extends MapLayerStyleBuilder {
1834
1834
  MapLayerStyleBuilder.registerStyleBuilder("fill-extrusion", FillExtrusionLayerStyleBuilder);
1835
1835
  class RasterLayerStyleBuilder extends MapLayerStyleBuilder {
1836
1836
  /**
1837
- * The opacity at which the image will be drawn.
1838
- *
1839
- * @param value - raster-opacity value (default `1`)
1840
- */
1837
+ * The opacity at which the image will be drawn.
1838
+ *
1839
+ * @param value - raster-opacity value (default `1`)
1840
+ */
1841
1841
  rasterOpacity(value) {
1842
1842
  this.addStyle("raster-opacity", value);
1843
1843
  return this;
1844
1844
  }
1845
1845
  /**
1846
- * Rotates hues around the color wheel.
1847
- *
1848
- * @param value - raster-hue-rotate value in degrees
1849
- */
1846
+ * Rotates hues around the color wheel.
1847
+ *
1848
+ * @param value - raster-hue-rotate value in degrees
1849
+ */
1850
1850
  rasterHueRotate(value) {
1851
1851
  this.addStyle("raster-hue-rotate", value);
1852
1852
  return this;
1853
1853
  }
1854
1854
  /**
1855
- * Increase or reduce the brightness of the image. The value is the minimum brightness.
1856
- *
1857
- * @param value - raster-brightness-min value
1858
- */
1855
+ * Increase or reduce the brightness of the image. The value is the minimum brightness.
1856
+ *
1857
+ * @param value - raster-brightness-min value
1858
+ */
1859
1859
  rasterBrightnessMin(value) {
1860
1860
  this.addStyle("raster-brightness-min", value);
1861
1861
  return this;
1862
1862
  }
1863
1863
  /**
1864
- * Increase or reduce the brightness of the image. The value is the maximum brightness.
1865
- *
1866
- * @param value - raster-brightness-max value (default `1`)
1867
- */
1864
+ * Increase or reduce the brightness of the image. The value is the maximum brightness.
1865
+ *
1866
+ * @param value - raster-brightness-max value (default `1`)
1867
+ */
1868
1868
  rasterBrightnessMax(value) {
1869
1869
  this.addStyle("raster-brightness-max", value);
1870
1870
  return this;
1871
1871
  }
1872
1872
  /**
1873
- * Increase or reduce the saturation of the image.
1874
- *
1875
- * @param value - raster-saturation value
1876
- */
1873
+ * Increase or reduce the saturation of the image.
1874
+ *
1875
+ * @param value - raster-saturation value
1876
+ */
1877
1877
  rasterSaturation(value) {
1878
1878
  this.addStyle("raster-saturation", value);
1879
1879
  return this;
1880
1880
  }
1881
1881
  /**
1882
- * Increase or reduce the contrast of the image.
1883
- *
1884
- * @param value - raster-contrast value
1885
- */
1882
+ * Increase or reduce the contrast of the image.
1883
+ *
1884
+ * @param value - raster-contrast value
1885
+ */
1886
1886
  rasterContrast(value) {
1887
1887
  this.addStyle("raster-contrast", value);
1888
1888
  return this;
1889
1889
  }
1890
1890
  /**
1891
- * The resampling/interpolation method to use for overscaling, also known as texture magnification filter
1892
- *
1893
- * Values:
1894
- * - linear: (Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled
1895
- * - nearest: Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled
1896
- *
1897
- * @param value - raster-resampling value (default `linear`)
1898
- */
1891
+ * The resampling/interpolation method to use for overscaling, also known as texture magnification filter
1892
+ *
1893
+ * Values:
1894
+ * - linear: (Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled
1895
+ * - nearest: Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled
1896
+ *
1897
+ * @param value - raster-resampling value (default `linear`)
1898
+ */
1899
1899
  rasterResampling(value) {
1900
1900
  this.addStyle("raster-resampling", value);
1901
1901
  return this;
1902
1902
  }
1903
1903
  /**
1904
- * Fade duration when a new tile is added.
1905
- *
1906
- * @param value - raster-fade-duration value in milliseconds (default `300`)
1907
- */
1904
+ * Fade duration when a new tile is added.
1905
+ *
1906
+ * @param value - raster-fade-duration value in milliseconds (default `300`)
1907
+ */
1908
1908
  rasterFadeDuration(value) {
1909
1909
  this.addStyle("raster-fade-duration", value);
1910
1910
  return this;
@@ -1913,59 +1913,59 @@ class RasterLayerStyleBuilder extends MapLayerStyleBuilder {
1913
1913
  MapLayerStyleBuilder.registerStyleBuilder("raster", RasterLayerStyleBuilder);
1914
1914
  class HillshadeLayerStyleBuilder extends MapLayerStyleBuilder {
1915
1915
  /**
1916
- * The direction of the light source used to generate the hillshading with 0 as the top of the viewport if `hillshade-illumination-anchor` is set to `viewport` and due north if `hillshade-illumination-anchor` is set to `map`.
1917
- *
1918
- * @param value - hillshade-illumination-direction value (default `335`)
1919
- */
1916
+ * The direction of the light source used to generate the hillshading with 0 as the top of the viewport if `hillshade-illumination-anchor` is set to `viewport` and due north if `hillshade-illumination-anchor` is set to `map`.
1917
+ *
1918
+ * @param value - hillshade-illumination-direction value (default `335`)
1919
+ */
1920
1920
  hillshadeIlluminationDirection(value) {
1921
1921
  this.addStyle("hillshade-illumination-direction", value);
1922
1922
  return this;
1923
1923
  }
1924
1924
  /**
1925
- * Direction of light source when map is rotated.
1926
- *
1927
- * Values:
1928
- * - map: The hillshade illumination is relative to the north direction.
1929
- * - viewport: The hillshade illumination is relative to the top of the viewport.
1930
- *
1931
- * @param value - hillshade-illumination-anchor value (default `viewport`)
1932
- */
1925
+ * Direction of light source when map is rotated.
1926
+ *
1927
+ * Values:
1928
+ * - map: The hillshade illumination is relative to the north direction.
1929
+ * - viewport: The hillshade illumination is relative to the top of the viewport.
1930
+ *
1931
+ * @param value - hillshade-illumination-anchor value (default `viewport`)
1932
+ */
1933
1933
  hillshadeIlluminationAnchor(value) {
1934
1934
  this.addStyle("hillshade-illumination-anchor", value);
1935
1935
  return this;
1936
1936
  }
1937
1937
  /**
1938
- * Intensity of the hillshade
1939
- *
1940
- * @param value - hillshade-exaggeration value (default `0.5`)
1941
- */
1938
+ * Intensity of the hillshade
1939
+ *
1940
+ * @param value - hillshade-exaggeration value (default `0.5`)
1941
+ */
1942
1942
  hillshadeExaggeration(value) {
1943
1943
  this.addStyle("hillshade-exaggeration", value);
1944
1944
  return this;
1945
1945
  }
1946
1946
  /**
1947
- * The shading color of areas that face away from the light source.
1948
- *
1949
- * @param value - hillshade-shadow-color value (default `#000000`)
1950
- */
1947
+ * The shading color of areas that face away from the light source.
1948
+ *
1949
+ * @param value - hillshade-shadow-color value (default `#000000`)
1950
+ */
1951
1951
  hillshadeShadowColor(value) {
1952
1952
  this.addStyle("hillshade-shadow-color", value);
1953
1953
  return this;
1954
1954
  }
1955
1955
  /**
1956
- * The shading color of areas that faces towards the light source.
1957
- *
1958
- * @param value - hillshade-highlight-color value (default `#FFFFFF`)
1959
- */
1956
+ * The shading color of areas that faces towards the light source.
1957
+ *
1958
+ * @param value - hillshade-highlight-color value (default `#FFFFFF`)
1959
+ */
1960
1960
  hillshadeHighlightColor(value) {
1961
1961
  this.addStyle("hillshade-highlight-color", value);
1962
1962
  return this;
1963
1963
  }
1964
1964
  /**
1965
- * The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
1966
- *
1967
- * @param value - hillshade-accent-color value (default `#000000`)
1968
- */
1965
+ * The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
1966
+ *
1967
+ * @param value - hillshade-accent-color value (default `#000000`)
1968
+ */
1969
1969
  hillshadeAccentColor(value) {
1970
1970
  this.addStyle("hillshade-accent-color", value);
1971
1971
  return this;
@@ -1974,28 +1974,28 @@ class HillshadeLayerStyleBuilder extends MapLayerStyleBuilder {
1974
1974
  MapLayerStyleBuilder.registerStyleBuilder("hillshade", HillshadeLayerStyleBuilder);
1975
1975
  class BackgroundLayerStyleBuilder extends MapLayerStyleBuilder {
1976
1976
  /**
1977
- * The color with which the background will be drawn.
1978
- *
1979
- * @param value - background-color value (default `#000000`)
1980
- */
1977
+ * The color with which the background will be drawn.
1978
+ *
1979
+ * @param value - background-color value (default `#000000`)
1980
+ */
1981
1981
  backgroundColor(value) {
1982
1982
  this.addStyle("background-color", value);
1983
1983
  return this;
1984
1984
  }
1985
1985
  /**
1986
- * Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
1987
- *
1988
- * @param value - background-pattern value
1989
- */
1986
+ * Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
1987
+ *
1988
+ * @param value - background-pattern value
1989
+ */
1990
1990
  backgroundPattern(value) {
1991
1991
  this.addStyle("background-pattern", value);
1992
1992
  return this;
1993
1993
  }
1994
1994
  /**
1995
- * The opacity at which the background will be drawn.
1996
- *
1997
- * @param value - background-opacity value (default `1`)
1998
- */
1995
+ * The opacity at which the background will be drawn.
1996
+ *
1997
+ * @param value - background-opacity value (default `1`)
1998
+ */
1999
1999
  backgroundOpacity(value) {
2000
2000
  this.addStyle("background-opacity", value);
2001
2001
  return this;
@@ -3226,4 +3226,4 @@ const initializeContext = globalContextRegistry.initializeContext.bind(globalCon
3226
3226
  const uninitializeContext = globalContextRegistry.uninitializeContext.bind(globalContextRegistry);
3227
3227
  const getContext = globalContextRegistry.getContext.bind(globalContextRegistry);
3228
3228
 
3229
- export { ContextRegistry, DEFAULT_CONTEXT_ID, FlowContext, FlowMap, FlowRdfCoreGlobals, MapDataSource, MapLayer, MapLayerStyleBuilder, MapStyle, Query, ReactiveExpression, StateStore, StyleExpression, computed, expr, getContext, getGlobalState, initializeContext, isolateGlobalState, layerStyle, observable, query, queryMany, queryOne, serialize, traceReaction, uninitializeContext };
3229
+ export { BackgroundLayerStyleBuilder, CircleLayerStyleBuilder, ContextRegistry, DEFAULT_CONTEXT_ID, FillExtrusionLayerStyleBuilder, FillLayerStyleBuilder, FlowContext, FlowMap, FlowRdfCoreGlobals, HeatmapLayerStyleBuilder, HillshadeLayerStyleBuilder, LineLayerStyleBuilder, MapDataSource, MapLayer, MapLayerStyleBuilder, MapRegistry, MapStyle, Query, QueryRegistry, RasterLayerStyleBuilder, ReactiveExpression, StateStore, StyleExpression, SymbolLayerStyleBuilder, computed, expr, getContext, getGlobalState, initializeContext, isolateGlobalState, layerStyle, observable, query, queryMany, queryOne, serialize, traceReaction, uninitializeContext };