Package qupath.lib.gui.charts

Class HistogramChart

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.chart.Chart

javafx.scene.chart.XYChart<Number,Number>

javafx.scene.chart.AreaChart<Number,Number>

qupath.lib.gui.charts.HistogramChart

All Implemented Interfaces:

Styleable, EventTarget

public class HistogramChart
extends AreaChart<Number,Number>

JavaFX chart for displaying histograms. If multiple histograms are shown, these will overlap with one another.

Important!> This implementation does not behave quite like the built-in JavaFX charts, by presenting the core data within XYChart.Series objects. Instead, the data is stored in HistogramChart.HistogramData objects, which are then used to populate the chart.

One advantage of this is that it is easier to control the color of each histogram being displayed.

This behavior may change in the future, but for now the user must be careful to only interact with the data through the list returned by getHistogramData() (and not XYChart.getData() directly).

Property Summary

Properties

Type	Property	Description
ObjectProperty<HistogramChart.CountsTransformMode>	countsTransform	Property to control how counts should be transformed before being shown in the histogram
ObjectProperty<HistogramChart.DisplayMode>	displayMode	Property to control how the histogram is displayed, either using areas or bars.
BooleanProperty	hideIfEmpty	Property controlling whether the chart should be hidden if there is no data.

Properties inherited from class javafx.scene.chart.AreaChart

createSymbols

Properties inherited from class javafx.scene.chart.XYChart

alternativeColumnFillVisible, alternativeRowFillVisible, data, horizontalGridLinesVisible, horizontalZeroLineVisible, verticalGridLinesVisible, verticalZeroLineVisible

Properties inherited from class javafx.scene.chart.Chart

animated, legend, legendSide, legendVisible, title, titleSide

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HistogramChart.CountsTransformMode	Enum to specify how the counts are displayed.
static enum	HistogramChart.DisplayMode	Display mode for the histogram.
static class	HistogramChart.HistogramData	Helper class for representing data that may be visualized with a HistogramChart.

Nested classes/interfaces inherited from class javafx.scene.chart.XYChart

XYChart.Data<X,Y>, XYChart.Series<X,Y>

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
HistogramChart()

Method Summary

Modifier and Type	Method	Description
ObjectProperty<HistogramChart.CountsTransformMode>	countsTransformProperty()	Property to control how counts should be transformed before being shown in the histogram
static HistogramChart.HistogramData	createHistogramData(Histogram histogram, Integer color)	Create a HistogramData object to wrap a histogram & some info about its display.
static HistogramChart.HistogramData	createHistogramData(Histogram histogram, Color color)	Create a HistogramData object to wrap a histogram & some info about its display.
ObjectProperty<HistogramChart.DisplayMode>	displayModeProperty()	Property to control how the histogram is displayed, either using areas or bars.
HistogramChart.CountsTransformMode	getCountsTransform()	Get the current counts transform.
HistogramChart.DisplayMode	getDisplayMode()	Get the histogram display mode.
boolean	getHideIfEmpty()	Query whether the chart is automatically hidden (visibility set to false) when there is no data.
ObservableList<HistogramChart.HistogramData>	getHistogramData()	Get all histogram data objects.
BooleanProperty	hideIfEmptyProperty()	Property controlling whether the chart should be hidden if there is no data.
void	setCountsTransform(HistogramChart.CountsTransformMode mode)	Set the current counts transform.
void	setDisplayMode(HistogramChart.DisplayMode mode)	Set the histogram display mode.
void	setHideIfEmpty(boolean doHide)	Request that the chart is automatically hidden (visibility set to false) when there is no data.
void	setShowTickLabels(boolean showTickLabels)	Request that tick labels are visible or not for both x and y axis.

Methods inherited from class javafx.scene.chart.AreaChart

createSymbolsProperty, dataItemAdded, dataItemChanged, dataItemRemoved, getClassCssMetaData, getCreateSymbols, getCssMetaData, layoutPlotChildren, seriesAdded, seriesChanged, seriesRemoved, setCreateSymbols, updateAxisRange

Methods inherited from class javafx.scene.chart.XYChart

alternativeColumnFillVisibleProperty, alternativeRowFillVisibleProperty, currentDisplayedExtraValueProperty, currentDisplayedXValueProperty, currentDisplayedYValueProperty, dataProperty, getCurrentDisplayedExtraValue, getCurrentDisplayedXValue, getCurrentDisplayedYValue, getData, getDisplayedDataIterator, getDisplayedSeriesIterator, getPlotChildren, getVerticalGridLinesVisible, getXAxis, getYAxis, horizontalGridLinesVisibleProperty, horizontalZeroLineVisibleProperty, isAlternativeColumnFillVisible, isAlternativeRowFillVisible, isHorizontalGridLinesVisible, isHorizontalZeroLineVisible, isVerticalZeroLineVisible, layoutChartChildren, removeDataItemFromDisplay, removeSeriesFromDisplay, setAlternativeColumnFillVisible, setAlternativeRowFillVisible, setCurrentDisplayedExtraValue, setCurrentDisplayedXValue, setCurrentDisplayedYValue, setData, setHorizontalGridLinesVisible, setHorizontalZeroLineVisible, setVerticalGridLinesVisible, setVerticalZeroLineVisible, updateLegend, verticalGridLinesVisibleProperty, verticalZeroLineVisibleProperty

Methods inherited from class javafx.scene.chart.Chart

animate, animatedProperty, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAnimated, getChartChildren, getLegend, getLegendSide, getTitle, getTitleSide, isLegendVisible, layoutChildren, legendProperty, legendSideProperty, legendVisibleProperty, requestChartLayout, setAnimated, setLegend, setLegendSide, setLegendVisible, setTitle, setTitleSide, shouldAnimate, titleProperty, titleSideProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

hideIfEmpty

public BooleanProperty hideIfEmptyProperty

Property controlling whether the chart should be hidden if there is no data.

See Also:

• getHideIfEmpty()
• setHideIfEmpty(boolean)
• hideIfEmptyProperty()

countsTransform

public ObjectProperty<HistogramChart.CountsTransformMode> countsTransformProperty

Property to control how counts should be transformed before being shown in the histogram

See Also:

• getCountsTransform()
• setCountsTransform(HistogramChart.CountsTransformMode)
• countsTransformProperty()

displayMode

public ObjectProperty<HistogramChart.DisplayMode> displayModeProperty

Property to control how the histogram is displayed, either using areas or bars.

See Also:

• getDisplayMode()
• setDisplayMode(HistogramChart.DisplayMode)
• displayModeProperty()

Constructor Details

HistogramChart

public HistogramChart()

Method Details

hideIfEmptyProperty

public BooleanProperty hideIfEmptyProperty()

Property controlling whether the chart should be hidden if there is no data.

Returns:

See Also:

• getHideIfEmpty()
• setHideIfEmpty(boolean)

setHideIfEmpty

public void setHideIfEmpty(boolean doHide)

Request that the chart is automatically hidden (visibility set to false) when there is no data.

Parameters:

doHide -

getHideIfEmpty

public boolean getHideIfEmpty()

Query whether the chart is automatically hidden (visibility set to false) when there is no data.

Returns:

countsTransformProperty

public ObjectProperty<HistogramChart.CountsTransformMode> countsTransformProperty()

Property to control how counts should be transformed before being shown in the histogram

Returns:

See Also:

• getCountsTransform()
• setCountsTransform(HistogramChart.CountsTransformMode)

getCountsTransform

public HistogramChart.CountsTransformMode getCountsTransform()

Get the current counts transform.

Returns:

See Also:

• countsTransformProperty()

setCountsTransform

public void setCountsTransform(HistogramChart.CountsTransformMode mode)

Set the current counts transform.

Parameters:

mode -

See Also:

• countsTransformProperty()

displayModeProperty

public ObjectProperty<HistogramChart.DisplayMode> displayModeProperty()

Property to control how the histogram is displayed, either using areas or bars.

Returns:

See Also:

• getDisplayMode()
• setDisplayMode(HistogramChart.DisplayMode)

getDisplayMode

public HistogramChart.DisplayMode getDisplayMode()

Get the histogram display mode.

Returns:

See Also:

• displayModeProperty()

setDisplayMode

public void setDisplayMode(HistogramChart.DisplayMode mode)

Set the histogram display mode.

Parameters:

mode -

See Also:

• displayModeProperty()

getHistogramData

public ObservableList<HistogramChart.HistogramData> getHistogramData()

Get all histogram data objects.

Returns:

createHistogramData

public static HistogramChart.HistogramData createHistogramData(Histogram histogram,
 Color color)

Create a HistogramData object to wrap a histogram & some info about its display.

Parameters:

histogram -

color -

Returns:

createHistogramData

public static HistogramChart.HistogramData createHistogramData(Histogram histogram,
 Integer color)

Create a HistogramData object to wrap a histogram & some info about its display.

Parameters:

histogram -

color - Packed RGB representation of the color.

Returns:

setShowTickLabels

public void setShowTickLabels(boolean showTickLabels)

Request that tick labels are visible or not for both x and y axis.

Parameters:

showTickLabels -