Class: Size

new Size(values)

Immutable Size class. Warning: the input array is NOT cloned, modifying it will modify the index values.

Parameters:

Name	Type	Description
`values`	Array	The size values.

Source: src/image/size.js, line 13

Methods

canScroll(viewOrientation) → {boolean}

Check if the associated data is scrollable: either in 3D or in other directions.

Parameters:

Name	Type	Description
`viewOrientation`	dwv.math.Matrix33	The orientation matrix.

Source: src/image/size.js, line 97

Returns:

True if scrollable.

Type:: boolean

canScroll3D(viewOrientation) → {boolean}

Check if the associated data is scrollable in 3D.

Parameters:

Name	Type	Description
`viewOrientation`	dwv.math.Matrix33	The orientation matrix.

Source: src/image/size.js, line 82

Returns:

True if scrollable.

Type:: boolean

equals(rhs) → {boolean}

Check for equality.

Parameters:

Name	Type	Description
`rhs`	dwv.image.Size	The object to compare to.

Source: src/image/size.js, line 147

Returns:

True if both objects are equal.

Type:: boolean

get(i) → {number}

Get the size value at the given array index.

Parameters:

Name	Type	Description
`i`	number	The index to get.

Source: src/image/size.js, line 33

Returns:

The value.

Type:: number

get2D() → {object}

Get the 2D base of this size.

Source: src/image/size.js, line 261

Returns:

The 2D base [0,1] as {x,y}.

Type:: object

getDimSize(dimension, start) → {number}

Get the size of a given dimension.

Parameters:

Name	Type	Description
`dimension`	number	The dimension.
`start`	number	Optional start dimension to start counting from.

Source: src/image/size.js, line 113

Returns:

The size.

Type:: number

getTotalSize(start) → {number}

Get the total size.

Parameters:

Name	Type	Description
`start`	number	Optional start dimension to base the offset on.

Source: src/image/size.js, line 137

Returns:

The total size.

Type:: number

getValues() → {Array}

Get the values of this index.

Source: src/image/size.js, line 60

Returns:

The array of values.

Type:: Array

indexToOffset(index, start) → {number}

Convert an index to an offset in memory.

Parameters:

Name	Type	Description
`index`	dwv.math.Index	The index to convert.
`start`	number	Optional start dimension to base the offset on.

Source: src/image/size.js, line 218

Returns:

The offset.

Type:: number

isInBounds(index, dirs) → {boolean}

Check that an index is within bounds.

Parameters:

Name	Type	Description
`index`	dwv.math.Index	The index to check.
`dirs`	Array	Optional list of directions to check.

Source: src/image/size.js, line 174

Returns:

True if the given coordinates are within bounds.

Type:: boolean

length() → {number}

Get the length of the index.

Source: src/image/size.js, line 42

Returns:

The length.

Type:: number

moreThanOne(dimension) → {boolean}

Check if a dimension exists and has more than one element.

Parameters:

Name	Type	Description
`dimension`	number	The dimension to check.

Source: src/image/size.js, line 72

Returns:

True if the size is more than one.

Type:: boolean

offsetToIndex(offset) → {dwv.math.Index}

Convert an offset in memory to an index.

Parameters:

Name	Type	Description
`offset`	number	The offset to convert.

Source: src/image/size.js, line 243

Returns:

The index.

Type:: dwv.math.Index

toString() → {string}

Get a string representation of the size.

Source: src/image/size.js, line 51

Returns:

The Size as a string.

Type:: string