Class: ViewController

Constructor

new ViewController(view, dataId)

Parameters:

Name	Type	Description
`view`	View	The associated view.
`dataId`	string	The associated data id.

Source: src/app/viewController.js, line 31

Classes

ViewController

Methods

addEventListener(type, callback)

Add an event listener to this class.

Parameters:

Name	Type	Description
`type`	string	The event type.
`callback`	function	The function associated with the provided event type, will be called with the fired event.

Source: src/app/viewController.js, line 930

addWindowLevelPresets(presets) → {object}

Add window/level presets to the view.

Parameters:

Name	Type	Description
`presets`	object	A preset object.

Source: src/app/viewController.js, line 163

Returns:

The list of presets.

Type:: object

bindImageAndLayer(viewLayer)

Bind the view image to the provided layer.

Parameters:

Name	Type	Description
`viewLayer`	ViewLayer	The layer to bind.

Source: src/app/viewController.js, line 898

canQuantifyImage() → {boolean}

Can the image values be quantified?

Source: src/app/viewController.js, line 433

Returns:

True if possible.

Type:: boolean

canScroll() → {boolean}

Can the data be scrolled?

Source: src/app/viewController.js, line 462

Returns:

True if the data has either the third dimension or above greater than one.

Type:: boolean

canWindowLevel() → {boolean}

Can window and level be applied to the data?

Deprecated: Please use isMonochrome instead.
Source: src/app/viewController.js, line 443

Returns:

True if possible.

Type:: boolean

decrementIndex(dim, silentopt) → {boolean}

Decrement the provided dimension.

Parameters:

Name	Type	Attributes	Description
`dim`	number		The dimension to increment.
`silent`	boolean	<optional>	Do not send event.

Source: src/app/viewController.js, line 754

Returns:

False if not in bounds.

Type:: boolean

decrementScrollIndex(silentopt) → {boolean}

Decrement the scroll dimension index.

Parameters:

Name	Type	Attributes	Description
`silent`	boolean	<optional>	Do not send event.

Source: src/app/viewController.js, line 764

Returns:

False if not in bounds.

Type:: boolean

equalImageMeta(meta) → {boolean}

Compare the input meta data to the associated image one.

Parameters:

Name	Type	Description
`meta`	object	The meta data.

Source: src/app/viewController.js, line 518

Returns:

True if the associated image has equal meta data.

Type:: boolean

generateImageData(array, indexopt)

Generate display image data to be given to a canvas.

Parameters:

Name	Type	Attributes	Description
`array`	ImageData		The array to fill in.
`index`	Index	<optional>	Optional index at which to generate, otherwise generates at current index.

Source: src/app/viewController.js, line 276

get2DSpacing() → {Scalar2D}

Get the current view (2D) spacing.

Source: src/app/viewController.js, line 296

Returns:

The spacing as a 2D array.

Type:: Scalar2D

getColourMap() → {string}

Get the colour map.

Source: src/app/viewController.js, line 864

Returns:

The colour map name.

Type:: string

getCurrentIndex() → {Index}

Get the current index.

Source: src/app/viewController.js, line 208

Returns:

The current index.

Type:: Index

getCurrentOrientedIndex() → {Index}

Get the current oriented index.

Source: src/app/viewController.js, line 217

Returns:

The index.

Type:: Index

getCurrentPosition() → {Point}

Get the current position.

Source: src/app/viewController.js, line 199

Returns:

The position.

Type:: Point

getCurrentScrollIndexValue() → {object}

Get the current scroll index value.

Source: src/app/viewController.js, line 245

Returns:

The value.

Type:: object

getCurrentScrollPosition() → {object}

Get the current scroll position value.

Source: src/app/viewController.js, line 264

Returns:

The value.

Type:: object

getCurrentWindowPresetName() → {string}

Get the current window level preset name.

Source: src/app/viewController.js, line 846

Returns:

The preset name.

Type:: string

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/app/viewController.js, line 711

Returns:

The resulting point.

Type:: Point

getDecrementScrollPosition() → {Point}

Get the current position decremented in the scroll direction.

Source: src/app/viewController.js, line 731

Returns:

The resulting point.

Type:: Point

getImageRegionValues(min, max) → {Array}

Get some values from the associated image in a region.

Parameters:

Name	Type	Description
`min`	Point2D	Minimum point.
`max`	Point2D	Maximum point.

Source: src/app/viewController.js, line 374

Returns:

A list of values.

Type:: Array

getImageRescaledDataRange() → {object}

Get the image rescaled data range.

Source: src/app/viewController.js, line 508

Returns:

The range as {min, max}.

Type:: object

getImageSize() → {Size}

Get the oriented image size.

Source: src/app/viewController.js, line 471

Returns:

The size.

Type:: Size

getImageVariableRegionValues(regions) → {Array}

Get some values from the associated image in variable regions.

Parameters:

Name	Type	Description
`regions`	Array.<Array.<Array.<number>>>	A list of [x, y] pairs (min, max).

Source: src/app/viewController.js, line 404

Returns:

A list of values.

Type:: Array

getImageWorldSize() → {Scalar2D}

Get the image world (mm) 2D size.

Source: src/app/viewController.js, line 493

Returns:

The 2D size as {x,y}.

Type:: Scalar2D

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/app/viewController.js, line 700

Returns:

The resulting point.

Type:: Point

getIncrementScrollPosition() → {Point}

Get the current position decremented in the scroll direction.

Source: src/app/viewController.js, line 721

Returns:

The resulting point.

Type:: Point

getModality() → {string}

Get the image modality.

Source: src/app/viewController.js, line 144

Returns:

The modality.

Type:: string

getOffset3DFromPlaneOffset(offset2D) → {Vector3D}

Get a 3D offset from a plane one.

Parameters:

Name	Type	Description
`offset2D`	Scalar2D	The plane offset as {x,y}.

Source: src/app/viewController.js, line 634

Returns:

The 3D world offset.

Type:: Vector3D

getOrigin(positionopt) → {Point3D}

Get the first origin or at a given position.

Parameters:

Name	Type	Attributes	Description
`position`	Point	<optional>	Opitonal position.

Source: src/app/viewController.js, line 255

Returns:

The origin.

Type:: Point3D

getPixelUnit() → {string}

Get the image pixel unit.

Source: src/app/viewController.js, line 328

Returns:

The unit.

Type:: string

getPlaneHelper() → {PlaneHelper}

Get the plane helper.

Source: src/app/viewController.js, line 114

Returns:

The helper.

Type:: PlaneHelper

getPlanePositionFromPlanePoint(point2D) → {Point3D}

Get a plane 3D position from a plane 2D position: does not compensate for the image origin. Needed for setting the scale center...

Parameters:

Name	Type	Description
`point2D`	Point2D	The 2D position.

Source: src/app/viewController.js, line 613

Returns:

The 3D point.

Type:: Point3D

getPlanePositionFromPosition(point) → {Point2D}

Get a 2D plane position from a world position.

Parameters:

Name	Type	Description
`point`	Point	The 3D position.

Source: src/app/viewController.js, line 582

Returns:

The 2D position.

Type:: Point2D

getPositionFromPlanePoint(point2D) → {Point}

Get a world position from a 2D plane position.

Parameters:

Name	Type	Description
`point2D`	Point2D	The input point.

Source: src/app/viewController.js, line 563

Returns:

The associated position.

Type:: Point

getRescaledImageValue(position) → {number|undefined}

Get the image rescaled value at the input position.

Parameters:

Name	Type	Description
`position`	Point	The input position.

Source: src/app/viewController.js, line 309

Returns:

The image value or undefined if out of bounds or no quantifiable (for ex RGB).

Type:: number | undefined

getScrollIndex() → {number}

Get the scroll index.

Source: src/app/viewController.js, line 236

Returns:

The index.

Type:: number

getWindowLevel() → {WindowLevel}

Get the window/level.

Source: src/app/viewController.js, line 837

Returns:

The window and level.

Type:: WindowLevel

getWindowLevelPresetsNames() → {Array.<string>}

Get the window/level presets names.

Source: src/app/viewController.js, line 153

Returns:

The presets names.

Type:: Array.<string>

incrementIndex(dim, silentopt) → {boolean}

Increment the provided dimension.

Parameters:

Name	Type	Attributes	Description
`dim`	number		The dimension to increment.
`silent`	boolean	<optional>	Do not send event.

Source: src/app/viewController.js, line 743

Returns:

False if not in bounds.

Type:: boolean

incrementScrollIndex(silentopt) → {boolean}

Increment the scroll dimension index.

Parameters:

Name	Type	Attributes	Description
`silent`	boolean	<optional>	Do not send event.

Source: src/app/viewController.js, line 774

Returns:

False if not in bounds.

Type:: boolean

initialise()

Initialise the controller.

Source: src/app/viewController.js, line 130

isMask() → {boolean}

Check is the associated image is a mask.

Source: src/app/viewController.js, line 123

Returns:

True if the associated image is a mask.

Type:: boolean

isMonochrome() → {boolean}

Is the data monochrome.

Source: src/app/viewController.js, line 452

Returns:

True if the data is monochrome.

Type:: boolean

isPlaying() → {boolean}

Check if the controller is playing.

Source: src/app/viewController.js, line 190

Returns:

True if the controler is playing.

Type:: boolean

isPositionInBounds(positionopt) → {boolean}

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

Parameters:

Name	Type	Attributes	Description
`position`	Point	<optional>	Optional position.

Source: src/app/viewController.js, line 541

Returns:

True is the position is in bounds.

Type:: boolean

moreThanOne(dim) → {boolean}

Is the data size larger than one in the given dimension?

Parameters:

Name	Type	Description
`dim`	number	The dimension.

Source: src/app/viewController.js, line 484

Returns:

True if the image size is larger than one in the given dimension.

Type:: boolean

play()

Scroll play: loop through all slices.

Source: src/app/viewController.js, line 781

removeEventListener(type, callback)

Remove an event listener from this class.

Parameters:

Name	Type	Description
`type`	string	The event type.
`callback`	function	The function associated with the provided event type.

Source: src/app/viewController.js, line 941

setColourMap(name)

Set the colour map.

Parameters:

Name	Type	Description
`name`	string	The colour map name.

Source: src/app/viewController.js, line 873

setCurrentIndex(index, silentopt) → {boolean}

Set the current index.

Parameters:

Name	Type	Attributes	Description
`index`	Index		The index.
`silent`	boolean	<optional>	If true, does not fire a positionchange event.

Source: src/app/viewController.js, line 602

Returns:

False if not in bounds.

Type:: boolean

setCurrentPosition(pos, silentopt) → {boolean}

Set the current position.

Parameters:

Name	Type	Attributes	Description
`pos`	Point		The position.
`silent`	boolean	<optional>	If true, does not fire a positionchange event.

Source: src/app/viewController.js, line 553

Returns:

False if not in bounds.

Type:: boolean

setImage(img, dataId)

Set the associated image.

Parameters:

Name	Type	Description
`img`	Image	The associated image.
`dataId`	string	The data id of the image.

Source: src/app/viewController.js, line 286

setViewAlphaFunction(func)

Set the view per value alpha function.

Parameters:

Name	Type	Description
`func`	alphaFn	The function.

Source: src/app/viewController.js, line 889

setWindowLevel(wl)

Set the window and level.

Parameters:

Name	Type	Description
`wl`	WindowLevel	The window and level.

Source: src/app/viewController.js, line 855

setWindowLevelPreset(name)

Set the window level to the preset with the input name.

Parameters:

Name	Type	Description
`name`	string	The name of the preset to activate.

Source: src/app/viewController.js, line 172

setWindowLevelPresetById(id)

Set the window level to the preset with the input id.

Parameters:

Name	Type	Description
`id`	number	The id of the preset to activate.

Source: src/app/viewController.js, line 181

stop()

Stop scroll playing.

Source: src/app/viewController.js, line 825

unbindImageAndLayer(viewLayer)

Unbind the view image to the provided layer.

Parameters:

Name	Type	Description
`viewLayer`	ViewLayer	The layer to bind.

Source: src/app/viewController.js, line 913