Skip to content

Commit f612eb3

Browse files
committed
doc(FeatureCollection): clarify FeatureCollection.extent projection.
1 parent 73198c7 commit f612eb3

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/Core/Feature.js

+7-1
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,13 @@ export default Feature;
283283
* @property {Feature[]} features - The array of features composing the
284284
* collection.
285285
* @property {Extent?} extent - The 2D extent containing all the features
286-
* composing the collection.
286+
* composing the collection. The extent projection is the same local projection `FeatureCollection`.
287+
* To transform `FeatureCollection.extent` to `FeatureCollection.crs` projection, the transformation matrix must be applied.
288+
*
289+
* **WARNING** if crs is `EPSG:4978` because the 3d geocentric system doesn't work with 2D `Extent`,
290+
* The FeatureCollection.extent projection is the original projection.
291+
* In this case, there isn't need to transform the extent.
292+
*
287293
* @property {string} crs - Geographic or Geocentric coordinates system.
288294
* @property {boolean} isFeatureCollection - Used to check whether this is FeatureCollection.
289295
* @property {number} size - The size structure, it's 3 for 3d and 2 for 2d.

0 commit comments

Comments
 (0)