-
- All Implemented Interfaces:
-
com.patrykandpatrick.vico.core.chart.decoration.Decoration
public final class ThresholdLine implements Decoration
ThresholdLine is drawn on top of charts and marks a certain range of y-axis values.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumThresholdLine.LabelHorizontalPositionDefines the horizontal position of a ThresholdLine’s label.
public enumThresholdLine.LabelVerticalPositionDefines the vertical position of a ThresholdLine’s label.
-
Field Summary
Fields Modifier and Type Field Description private final ClosedFloatingPointRange<Float>thresholdRangeprivate final CharSequencethresholdLabelprivate final ShapeComponentlineComponentprivate final FloatminimumLineThicknessDpprivate final TextComponentlabelComponentprivate final ThresholdLine.LabelHorizontalPositionlabelHorizontalPositionprivate final ThresholdLine.LabelVerticalPositionlabelVerticalPositionprivate final FloatlabelRotationDegrees
-
Constructor Summary
Constructors Constructor Description ThresholdLine(Float thresholdValue, CharSequence thresholdLabel, ShapeComponent lineComponent, Float minimumLineThicknessDp, TextComponent labelComponent, ThresholdLine.LabelHorizontalPosition labelHorizontalPosition, ThresholdLine.LabelVerticalPosition labelVerticalPosition, Float labelRotationDegrees)An alternative constructor that accepts a single y-axis value as opposed to a range. ThresholdLine(ClosedFloatingPointRange<Float> thresholdRange, CharSequence thresholdLabel, ShapeComponent lineComponent, Float minimumLineThicknessDp, TextComponent labelComponent, ThresholdLine.LabelHorizontalPosition labelHorizontalPosition, ThresholdLine.LabelVerticalPosition labelVerticalPosition, Float labelRotationDegrees)
-
Method Summary
Modifier and Type Method Description final ClosedFloatingPointRange<Float>getThresholdRange()final CharSequencegetThresholdLabel()final ShapeComponentgetLineComponent()final FloatgetMinimumLineThicknessDp()final TextComponentgetLabelComponent()final ThresholdLine.LabelHorizontalPositiongetLabelHorizontalPosition()final ThresholdLine.LabelVerticalPositiongetLabelVerticalPosition()final FloatgetLabelRotationDegrees()UnitonDrawAboveChart(ChartDrawContext context, RectF bounds)Called immediately after the Chart finishes drawing itself. -
-
Constructor Detail
-
ThresholdLine
ThresholdLine(Float thresholdValue, CharSequence thresholdLabel, ShapeComponent lineComponent, Float minimumLineThicknessDp, TextComponent labelComponent, ThresholdLine.LabelHorizontalPosition labelHorizontalPosition, ThresholdLine.LabelVerticalPosition labelVerticalPosition, Float labelRotationDegrees)
An alternative constructor that accepts a single y-axis value as opposed to a range.
-
ThresholdLine
ThresholdLine(ClosedFloatingPointRange<Float> thresholdRange, CharSequence thresholdLabel, ShapeComponent lineComponent, Float minimumLineThicknessDp, TextComponent labelComponent, ThresholdLine.LabelHorizontalPosition labelHorizontalPosition, ThresholdLine.LabelVerticalPosition labelVerticalPosition, Float labelRotationDegrees)
-
-
Method Detail
-
getThresholdRange
final ClosedFloatingPointRange<Float> getThresholdRange()
-
getThresholdLabel
final CharSequence getThresholdLabel()
-
getLineComponent
final ShapeComponent getLineComponent()
-
getMinimumLineThicknessDp
final Float getMinimumLineThicknessDp()
-
getLabelComponent
final TextComponent getLabelComponent()
-
getLabelHorizontalPosition
final ThresholdLine.LabelHorizontalPosition getLabelHorizontalPosition()
-
getLabelVerticalPosition
final ThresholdLine.LabelVerticalPosition getLabelVerticalPosition()
-
getLabelRotationDegrees
final Float getLabelRotationDegrees()
-
onDrawAboveChart
Unit onDrawAboveChart(ChartDrawContext context, RectF bounds)
Called immediately after the Chart finishes drawing itself.
- Parameters:
context- holds the information needed to draw the Chart.bounds- the bounding box of the Chart.
-
-
-
-