Skip to content

Commit 844edca

Browse files
jmannaufloryst
authored andcommitted
docs(dataarray): update getRanges description to include details on multi-component magnitude
1 parent d7715a9 commit 844edca

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Sources/Common/Core/DataArray/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ export interface vtkDataArray extends vtkObject {
8787
* Returns an array of the ranges for each component of the DataArray.
8888
* Defaults to computing all the ranges if they aren't already computed.
8989
*
90+
* If the number of components is greater than 1, the last element in the
91+
* ranges array is the min,max magnitude of the dataset. This is the same as
92+
* calling `getRange(-1)`.
93+
*
9094
* Passing `getRanges(false)` will return a clone of the ranges that have
9195
* already been computed. This is useful when you want to avoid recomputing
9296
* the ranges, which can be expensive.

0 commit comments

Comments
 (0)