com.vaadin.flow.component.charts.model.Hover Maven / Gradle / Ivy
package com.vaadin.flow.component.charts.model;
/*-
* #%L
* Vaadin Charts for Flow
* %%
* Copyright (C) 2014 - 2018 Vaadin Ltd
* %%
* This program is available under Commercial Vaadin Add-On License 3.0
* (CVALv3).
*
* See the file licensing.txt distributed with this software for more
* information about licensing.
*
* You should have received a copy of the CVALv3 along with this program.
* If not, see .
* #L%
*/
import javax.annotation.Generated;
/**
* Options for the hovered series
*/
@Generated(value = "This class is generated and shouldn't be modified", comments = "Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class Hover extends AbstractConfigurationObject {
private Boolean animation;
private Boolean enabled;
private Halo halo;
private Number radius;
private Number radiusPlus;
private Marker marker;
public Hover() {
}
/**
* @see #setAnimation(Boolean)
*/
public Boolean getAnimation() {
return animation;
}
/**
* Animation setting for hovering the graph in line-type series.
*
* Defaults to: { "duration": 50 }
*/
public void setAnimation(Boolean animation) {
this.animation = animation;
}
public Hover(Boolean enabled) {
this.enabled = enabled;
}
/**
* @see #setEnabled(Boolean)
*/
public Boolean getEnabled() {
return enabled;
}
/**
* Enable separate styles for the hovered series to visualize that the user
* hovers either the series itself or the legend. .
*
* Defaults to: true
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
* @see #setHalo(Halo)
*/
public Halo getHalo() {
if (halo == null) {
halo = new Halo();
}
return halo;
}
/**
*
* Options for the halo appearing around the hovered point in line-type
* series as well as outside the hovered slice in pie charts. By default the
* halo is filled by the current point or series color with an opacity of
* 0.25. The halo can be disabled by setting the halo option to
* false.
*
*
*
* In styled mode, the halo is styled with the
* .highcharts-halo class, with colors inherited from
* .highcharts-color-{n}.
*
*/
public void setHalo(Halo halo) {
this.halo = halo;
}
/**
* @see #setRadius(Number)
*/
public Number getRadius() {
return radius;
}
/**
* The radius of the point marker. In hover state, it defaults to the normal
* state's radius + 2 as per the radiusPlus
* option.
*/
public void setRadius(Number radius) {
this.radius = radius;
}
/**
* @see #setRadiusPlus(Number)
*/
public Number getRadiusPlus() {
return radiusPlus;
}
/**
* The number of pixels to increase the radius of the hovered point.
*
* Defaults to: 2
*/
public void setRadiusPlus(Number radiusPlus) {
this.radiusPlus = radiusPlus;
}
/**
* @see #setMarker(Marker)
*/
public Marker getMarker() {
if (marker == null) {
marker = new Marker();
}
return marker;
}
public void setMarker(Marker marker) {
this.marker = marker;
}
}