Package qupath.lib.gui.viewer

Class ViewerPlusDisplayOptions

java.lang.Object

qupath.lib.gui.viewer.ViewerPlusDisplayOptions

public class ViewerPlusDisplayOptions
extends Object

A group of properties determining what should be displayed for each viewer.

Property Summary

Properties

Type	Property	Description
BooleanProperty	showLocation	Show the cursor location.
BooleanProperty	showOverview	Show the overview image.
BooleanProperty	showScalebar	Show the scalebar.
BooleanProperty	showZProjectControls	Show controls to view z-projection overlays, where available.

Constructor Summary

Constructors

Constructor	Description
ViewerPlusDisplayOptions()

Method Summary

Modifier and Type	Method	Description
static ViewerPlusDisplayOptions	getSharedInstance()	Get a shared instance with persistence properties.
boolean	getShowLocation()	Get the value of showLocationProperty().
boolean	getShowOverview()	Get the value of showOverviewProperty().
boolean	getShowScalebar()	Get the value of showScalebarProperty().
boolean	getShowZProjectControls()	Get the value of showZProjectControlsProperty().
void	setShowLocation(boolean show)	Set the value of showLocationProperty().
void	setShowOverview(boolean show)	Set the value of showOverviewProperty().
void	setShowScalebar(boolean show)	Set the value of showScalebarProperty().
void	setShowZProjectControls(boolean show)	Set the value of showZProjectControlsProperty().
BooleanProperty	showLocationProperty()	Show the cursor location.
BooleanProperty	showOverviewProperty()	Show the overview image.
BooleanProperty	showScalebarProperty()	Show the scalebar.
BooleanProperty	showZProjectControlsProperty()	Show controls to view z-projection overlays, where available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

showOverview

public BooleanProperty showOverviewProperty

Show the overview image.

See Also:

• getShowOverview()
• setShowOverview(boolean)
• showOverviewProperty()

showLocation

public BooleanProperty showLocationProperty

Show the cursor location.

See Also:

• getShowLocation()
• setShowLocation(boolean)
• showLocationProperty()

showScalebar

public BooleanProperty showScalebarProperty

Show the scalebar.

See Also:

• getShowScalebar()
• setShowScalebar(boolean)
• showScalebarProperty()

showZProjectControls

public BooleanProperty showZProjectControlsProperty

Show controls to view z-projection overlays, where available.

See Also:

• getShowZProjectControls()
• setShowZProjectControls(boolean)
• showZProjectControlsProperty()

Constructor Details

ViewerPlusDisplayOptions

public ViewerPlusDisplayOptions()

Method Details

getSharedInstance

public static ViewerPlusDisplayOptions getSharedInstance()

Get a shared instance with persistence properties.

Returns:

showOverviewProperty

public BooleanProperty showOverviewProperty()

Show the overview image.

Returns:

See Also:

• getShowOverview()
• setShowOverview(boolean)

showLocationProperty

public BooleanProperty showLocationProperty()

Show the cursor location.

Returns:

See Also:

• getShowLocation()
• setShowLocation(boolean)

showScalebarProperty

public BooleanProperty showScalebarProperty()

Show the scalebar.

Returns:

See Also:

• getShowScalebar()
• setShowScalebar(boolean)

showZProjectControlsProperty

public BooleanProperty showZProjectControlsProperty()

Show controls to view z-projection overlays, where available.

Returns:

See Also:

• getShowZProjectControls()
• setShowZProjectControls(boolean)

getShowOverview

public boolean getShowOverview()

Get the value of showOverviewProperty().

Returns:

getShowLocation

public boolean getShowLocation()

Get the value of showLocationProperty().

Returns:

getShowScalebar

public boolean getShowScalebar()

Get the value of showScalebarProperty().

Returns:

getShowZProjectControls

public boolean getShowZProjectControls()

Get the value of showZProjectControlsProperty().

setShowOverview

public void setShowOverview(boolean show)

Set the value of showOverviewProperty().

Parameters:

show -

setShowLocation

public void setShowLocation(boolean show)

Set the value of showLocationProperty().

Parameters:

show -

setShowScalebar

public void setShowScalebar(boolean show)

Set the value of showScalebarProperty().

Parameters:

show -

setShowZProjectControls

public void setShowZProjectControls(boolean show)

Set the value of showZProjectControlsProperty().

Parameters:

show -