com.vaadin.flow.component.charts.model.Zones Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.charts.model;
import com.vaadin.flow.component.charts.model.style.Color;
/**
*
* An array defining zones within a series. Zones can be applied to the X axis,
* Y axis or Z axis for bubbles, according to the zoneAxis
option.
*
*
*
* In
* styled mode, the color zones are styled with the
* .highcharts-zone-{n}
class, or custom classed from the
* className
option (view live demo).
*
*/
public class Zones extends AbstractConfigurationObject {
private String className;
private Color color;
private DashStyle dashStyle;
private Color fillColor;
private Number value;
public Zones() {
}
/**
* @see #setClassName(String)
*/
public String getClassName() {
return className;
}
/**
* Styled mode only. A custom class name for the zone.
*/
public void setClassName(String className) {
this.className = className;
}
/**
* @see #setColor(Color)
*/
public Color getColor() {
return color;
}
/**
* Defines the color of the series.
*/
public void setColor(Color color) {
this.color = color;
}
/**
* @see #setDashStyle(DashStyle)
*/
public DashStyle getDashStyle() {
return dashStyle;
}
/**
* A name for the dash style to use for the graph.
*/
public void setDashStyle(DashStyle dashStyle) {
this.dashStyle = dashStyle;
}
/**
* @see #setFillColor(Color)
*/
public Color getFillColor() {
return fillColor;
}
/**
* Defines the fill color for the series (in area type series)
*/
public void setFillColor(Color fillColor) {
this.fillColor = fillColor;
}
/**
* @see #setValue(Number)
*/
public Number getValue() {
return value;
}
/**
* The value up to where the zone extends, if undefined the zones stretches
* to the last value in the series.
*
* Defaults to: undefined
*/
public void setValue(Number value) {
this.value = value;
}
}