com.vaadin.flow.component.charts.model.DataSeriesItemTimeline Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-charts-flow Show documentation

There is a newer version: 24.5.4

/**
 * 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 java.time.Instant;

/**
 * DataSeriesItem that can hold also Label and Description values. Used in e.g.
 * timeline series.
 */
public class DataSeriesItemTimeline extends DataSeriesItem {

    private String label;

    public DataSeriesItemTimeline() {
        super();
    }

    /**
     * Constructs an item with Name, Label and Description values
     *
     * @param name
     * @param label
     * @param description
     */
    public DataSeriesItemTimeline(String name, String label,
            String description) {
        super();
        setName(name);
        setLabel(label);
        setDescription(description);
    }

    /**
     * Constructs an item with X, Name, Label and Description values
     *
     * @param x
     * @param name
     * @param label
     * @param description
     */
    public DataSeriesItemTimeline(Number x, String name, String label,
            String description) {
        this(name, label, description);
        setX(x);
    }

    /**
     * Constructs an item with X, Name, Label and Description values
     *
     * @param x
     * @param name
     * @param label
     * @param description
     */
    public DataSeriesItemTimeline(Instant x, String name, String label,
            String description) {
        super();
        setX(x);
        setName(name);
        setLabel(label);
        setDescription(description);
    }

    /**
     * @see #setLabel(String)
     */
    public String getLabel() {
        return label;
    }

    /**
     * The label of event.
     */
    public void setLabel(String label) {
        this.label = label;
        makeCustomized();
    }

    /**
     * The description of event. This description will be shown in tooltip.
     * 
     * Defaults to: undefined
     */
    @Override
    public void setDescription(String description) {
        super.setDescription(description);
    }
}