Package com.vaadin.flow.component.charts.model

Class GanttSeriesItem

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.GanttSeriesItem
All Implemented Interfaces:
Serializable
public class GanttSeriesItem extends AbstractConfigurationObject
Data for the GanttSeries. Represents one task in the Gantt chart.
See Also:

  • Constructor Details

    • GanttSeriesItem

      public GanttSeriesItem()

    • GanttSeriesItem

      public GanttSeriesItem(String name, Instant start, Instant end)

    • GanttSeriesItem

      public GanttSeriesItem(Number y, Instant start, Instant end)

  • Method Details

    • getColorIndex

      public Number getColorIndex()
      See Also:

    • setColorIndex

      public void setColorIndex(Number colorIndex)
      A specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}. In styled mode this will change the color of the graphic. In non-styled mode, the color by is set by the fill attribute, so the change in class name won't have a visual effect by default.

    • getCollapsed

      public Boolean getCollapsed()
      See Also:

    • setCollapsed

      public void setCollapsed(Boolean collapsed)
      Whether the grid node belonging to this point should start as collapsed. Used in axes of type treegrid. Defaults to false.
      Parameters:
      collapsed -

    • getColor

      public Color getColor()
      See Also:

    • setColor

      public void setColor(Color color)
      Sets the individual color for the point. Defaults to null. This might not work for all chart types. In styled mode, the color option doesn't take effect. Instead, use colorIndex.
      Parameters:
      color - Color of the point.

    • getCompleted

      public Completed getCompleted()
      See Also:

    • setCompleted

      public void setCompleted(Completed completed)
      Progress indicator of how much of the task is completed.
      Parameters:
      completed -

    • setCompleted

      public void setCompleted(Number completed)
      Progress indicator of how much of the task is completed.
      Parameters:
      completed -

    • getDependencies

      public List<GanttSeriesItemDependency> getDependencies()
      See Also:

    • setDependencies

      public void setDependencies(List<GanttSeriesItemDependency> dependencies)
      Dependencies on another tasks (points) in the Gantt chart.
      See Also:

    • addDependency

      public void addDependency(GanttSeriesItemDependency dependency)
      Adds a dependency on another task.
      Parameters:
      dependency - The dependency configuration object, allowing to specify further connecting options between the points.

    • addDependency

      public void addDependency(String to)
      Adds a dependency on another task.
      Parameters:
      to - The ID of the point (task) that this point depends on in Gantt charts

    • getEnd

      public Number getEnd()
      See Also:

    • setEnd

      public void setEnd(Instant end)
      The end time of a task.
      Parameters:
      end -

    • getMilestone

      public Boolean getMilestone()
      See Also:

    • setMilestone

      public void setMilestone(Boolean milestone)
      Whether this point is a milestone. If so, only the start option is handled, while end is ignored. Defaults to false.
      Parameters:
      milestone -

    • getParent

      public String getParent()
      See Also:

    • setParent

      public void setParent(String parent)
      The ID of the parent point (task) of this point in Gantt charts. Defaults to null
      Parameters:
      parent -

    • getStart

      public Number getStart()
      See Also:

    • setStart

      public void setStart(Instant start)
      The start time of a task.
      Parameters:
      start -

    • getY

      public Number getY()
      See Also:

    • setY

      public void setY(Number y)
      The Y value of a task.
      Parameters:
      y -

    • getDescription

      public String getDescription()
      See Also:

    • setDescription

      public void setDescription(String description)

      A description of the point to add to the screen reader information about the point.

    • getId

      public String getId()
      See Also:

    • setId

      public void setId(String id)
      An id for the point.

    • getLabelrank

      public Number getLabelrank()
      See Also:

    • setLabelrank

      public void setLabelrank(Number labelrank)

      The rank for this point's data label in case of collision. If two data labels are about to overlap, only the one with the highest labelrank will be drawn.

    • getName

      public String getName()
      See Also:

    • setName

      public void setName(String name)
      The name of a task. If a treegrid y-axis is used (default in Gantt charts), this will be picked up automatically, and used to calculate the y-value.

    • getCustom

      public AbstractConfigurationObject getCustom()
      See also setCustom(AbstractConfigurationObject)

    • setCustom

      public void setCustom(AbstractConfigurationObject custom)
      A reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
      Parameters:
      custom -