de.gsi.chart.plugins.YValueIndicator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of chartfx-chart Show documentation
Show all versions of chartfx-chart Show documentation
This charting library ${project.artifactId}- is an extension
in the spirit of Oracle's XYChart and performance/time-proven JDataViewer charting functionalities.
Emphasis was put on plotting performance for both large number of data points and real-time displays,
as well as scientific accuracies leading to error bar/surface plots, and other scientific plotting
features (parameter measurements, fitting, multiple axes, zoom, ...).
/**
* Copyright (c) 2017 European Organisation for Nuclear Research (CERN), All Rights Reserved.
*/
package de.gsi.chart.plugins;
import de.gsi.chart.axes.Axis;
import javafx.geometry.BoundingBox;
import javafx.geometry.Bounds;
import javafx.geometry.HPos;
import javafx.geometry.Point2D;
import javafx.scene.input.MouseEvent;
/**
* A horizontal line drawn on the plot area, indicating specified Y value, with
* an optional {@link #textProperty() text label} describing the value.
*
* Style Classes (from least to most specific):
*
* - Label:
* {@code value-indicator-label, y-value-indicator-label, y-value-indicator-label[index]}
* - Line:
* {@code value-indicator-line, y-value-indicator-line, y-value-indicator-line[index]}
*
* where {@code [index]} corresponds to the index (zero based) of this indicator
* instance added to the {@code XYChartPane}. For example class
* {@code y-value-indicator-label1} can be used to style label of the second
* instance of this indicator added to the chart pane.
*
* @author mhrabia
*/
public class YValueIndicator extends AbstractSingleValueIndicator {
/**
* Creates a new instance indicating given Y value belonging to the
* specified {@code yAxis}.
*
* @param axis
* the axis this indicator is associated with
* @param value
* a value to be marked
*/
public YValueIndicator(final Axis axis, final double value) {
this(axis, value, null);
}
/**
* Creates a new instance indicating given Y value belonging to the
* specified {@code yAxis}, with the specified {@link #textProperty()
* label}.
*
* @param axis
* the axis this indicator is associated with
* @param value
* a value to be marked
* @param text
* the text to be shown by the label. Value of
* {@link #textProperty()}.
*/
public YValueIndicator(final Axis axis, final double value, final String text) {
super(axis, value, text);
triangle.getPoints().setAll(0.0, 0.0, 8.0, 8.0, 8.0, -8.0);
setLabelHorizontalAnchor(HPos.RIGHT);
setLabelPosition(0.975);
pickLine.setOnMouseDragged(this::handleDragMouseEvent);
triangle.setOnMouseDragged(this::handleDragMouseEvent);
label.setOnMouseDragged(this::handleDragMouseEvent);
}
protected void handleDragMouseEvent(final MouseEvent mouseEvent) {
Point2D c = getChart().getPlotArea().sceneToLocal(mouseEvent.getSceneX(), mouseEvent.getSceneY());
final double yPosData = getNumericAxis().getValueForDisplay(c.getY() - dragDelta.y);
if (getNumericAxis().isValueOnAxis(yPosData)) {
valueProperty().set(yPosData);
}
mouseEvent.consume();
}
@Override
void updateStyleClass() {
setStyleClasses(label, "y-", AbstractSingleValueIndicator.STYLE_CLASS_LABEL);
setStyleClasses(line, "y-", AbstractSingleValueIndicator.STYLE_CLASS_LINE);
setStyleClasses(triangle, "x-", AbstractSingleValueIndicator.STYLE_CLASS_MARKER);
}
@Override
public void layoutChildren() {
if (getChart() == null) {
return;
}
final Bounds plotAreaBounds = getChart().getCanvas().getBoundsInLocal();
final double minX = plotAreaBounds.getMinX();
final double maxX = plotAreaBounds.getMaxX();
final double minY = plotAreaBounds.getMinY();
final double maxY = plotAreaBounds.getMaxY();
final double yPos = minY + getNumericAxis().getDisplayPosition(getValue());
if (yPos < minY || yPos > maxY) {
getChartChildren().clear();
} else {
layoutLine(minX, yPos, maxX, yPos);
layoutMarker(maxX - 1.5 * AbstractSingleValueIndicator.TRIANGLE_HALF_WIDTH, yPos, minX, yPos); // +
// 1.5*TRIANGLE_HALF_WIDTH
layoutLabel(new BoundingBox(minX, yPos, maxX - minX, 0), getLabelPosition(),
AbstractSingleValueIndicator.MIDDLE_POSITION);
}
}
}