Class: PositionHelper

Constructor

new PositionHelper(view)

Parameters:

Name	Type	Description
`view`	View	The associated view.

Source: src/image/positionHelper.js, line 49

Classes

PositionHelper

Methods

decrementPosition(dim) → {boolean}

Decrement the current position along the provided dim.

Parameters:

Name	Type	Description
`dim`	number	The direction in which to decrement.

Source: src/image/positionHelper.js, line 273

Returns:

True if possible and in bounds.

Type:: boolean

decrementPositionAlongScroll() → {boolean}

Decrement the current position along the scroll dimension.

Source: src/image/positionHelper.js, line 291

Returns:

True if possible and in bounds.

Type:: boolean

getCurrentIndex() → {Index}

Get the current index.

Source: src/image/positionHelper.js, line 169

Returns:

The current index.

Type:: Index

getCurrentPosition() → {Point}

Get the current position.

Source: src/image/positionHelper.js, line 117

Returns:

The current position.

Type:: Point

getCurrentPositionAtDimValue(dim, value) → {Point}

Get the current position updated at the provided dimension index with the input value.

Parameters:

Name	Type	Description
`dim`	number	The dimension.
`value`	number	The value to used at dimension index.

Source: src/image/positionHelper.js, line 148

Returns:

The position.

Type:: Point

getCurrentPositionAtScrollValue(value) → {Point}

Get the current position updated at scroll index with the input value.

Parameters:

Name	Type	Description
`value`	number	The value to use at scroll index.

Source: src/image/positionHelper.js, line 160

Returns:

The position.

Type:: Point

getCurrentPositionDimValue(dim) → {number}

Get the value at dimension index for the current position.

Parameters:

Name	Type	Description
`dim`	number	The dimension.

Source: src/image/positionHelper.js, line 127

Returns:

The value.

Type:: number

getCurrentPositionScrollValue() → {number}

Get the value at scroll index for the current position.

Source: src/image/positionHelper.js, line 136

Returns:

The value.

Type:: number

getDecrementPosition(dim) → {Point}

Get the current position decremented in the input direction.

Parameters:

Name	Type	Description
`dim`	number	The direction in which to decrement.

Source: src/image/positionHelper.js, line 252

Returns:

The resulting point.

Type:: Point

getGeometry() → {Geometry}

Get the geometry.

Source: src/image/positionHelper.js, line 80

Returns:

The geometry.

Type:: Geometry

getIncrementPosition(dim) → {Point}

Get the current position incremented in the input direction.

Parameters:

Name	Type	Description
`dim`	number	The direction in which to increment.

Source: src/image/positionHelper.js, line 241

Returns:

The resulting point.

Type:: Point

getMaximumDimValue(dim) → {number}

Get the maximum dimension value.

Parameters:

Name	Type	Description
`dim`	number	The dimension.

Source: src/image/positionHelper.js, line 99

Returns:

The maximum value.

Type:: number

getMaximumScrollValue() → {number}

Get the maximum scroll value.

Source: src/image/positionHelper.js, line 108

Returns:

The maximum value.

Type:: number

getScrollDimIndex() → {number}

Get the scroll index.

Source: src/image/positionHelper.js, line 89

Returns:

The scroll index.

Type:: number

incrementPosition(dim) → {boolean}

Increment the current position along the provided dim.

Parameters:

Name	Type	Description
`dim`	number	The direction in which to increment.

Source: src/image/positionHelper.js, line 263

Returns:

True if possible and in bounds.

Type:: boolean

incrementPositionAlongScroll() → {boolean}

Increment the current position along the scroll dimension.

Source: src/image/positionHelper.js, line 282

Returns:

True if possible and in bounds.

Type:: boolean

isPositionInBounds(position) → {boolean}

Check if the current position (default) or the provided position is in bounds.

Parameters:

Name	Type	Description
`position`	Point	Optional position.

Source: src/image/positionHelper.js, line 226

Returns:

True is the position is in bounds.

Type:: boolean

merge(rhs)

Merge with another helper.

Parameters:

Name	Type	Description
`rhs`	PositionHelper	The helper to merge with this one.

Source: src/image/positionHelper.js, line 208

setCurrentPosition(position, silentopt) → {boolean}

Set the current position.

Parameters:

Name	Type	Attributes	Description
`position`	Point		The position.
`silent`	boolean	<optional>	Flag to fire event or not.

Source: src/image/positionHelper.js, line 180

Returns:

True if possible and in bounds.

Type:: boolean

setCurrentPositionSafe(position, silentopt) → {boolean}

Set the current position only if it is in the geometry bounds.

Parameters:

Name	Type	Attributes	Description
`position`	Point		The position.
`silent`	boolean	<optional>	Flag to fire event or not.

Source: src/image/positionHelper.js, line 195

Returns:

True if possible and in bounds.

Type:: boolean