com.vaadin.flow.component.charts.model.
Class GanttSeriesItem
All Implemented Interfaces:
Data for the GanttSeries
. Represents one task in the Gantt chart.
See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionGanttSeriesItem
(Number y, Instant start, Instant end) GanttSeriesItem
(String name, Instant start, Instant end) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDependency
(GanttSeriesItemDependency dependency) Adds a dependency on another task.
void
addDependency
(String to) Adds a dependency on another task.
getColor()
getEnd()
getId()
getName()
getStart()
getY()
void
setCollapsed
(Boolean collapsed) Whether the grid node belonging to this point should start as collapsed.
void
Sets the individual color for the point.
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}
.void
setCompleted
(Completed completed) Progress indicator of how much of the task is completed.
void
setCompleted
(Number completed) Progress indicator of how much of the task is completed.
void
setCustom
(AbstractConfigurationObject custom) A reserved subspace to store options and values for customized functionality.
void
setDependencies
(List<GanttSeriesItemDependency> dependencies) Dependencies on another tasks (points) in the Gantt chart.
void
setDescription
(String description) A description of the point to add to the screen reader information about the point.
void
The end time of a task.
void
An id for the point.
void
setLabelrank
(Number labelrank) The rank for this point's data label in case of collision.
void
setMilestone
(Boolean milestone) Whether this point is a milestone.
void
The name of a task.
void
The ID of the parent point (task) of this point in Gantt charts.
void
The start time of a task.
void
The Y value of a task.
-
Constructor Details
-
GanttSeriesItem
public GanttSeriesItem() -
GanttSeriesItem
-
GanttSeriesItem
-
-
Method Details
-
getColorIndex
See Also:
-
setColorIndex
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 thefill
attribute, so the change in class name won't have a visual effect by default. -
getCollapsed
See Also:
-
setCollapsed
Whether the grid node belonging to this point should start as collapsed. Used in axes of type treegrid. Defaults to false.
Parameters:
collapsed
- -
getColor
See Also:
-
setColor
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
See Also:
-
setCompleted
Progress indicator of how much of the task is completed.
Parameters:
completed
- -
setCompleted
Progress indicator of how much of the task is completed.
Parameters:
completed
- -
getDependencies
See Also:
-
setDependencies
Dependencies on another tasks (points) in the Gantt chart.
-
addDependency
Adds a dependency on another task.
Parameters:
dependency
- The dependency configuration object, allowing to specify further connecting options between the points. -
addDependency
Adds a dependency on another task.
Parameters:
to
- The ID of the point (task) that this point depends on in Gantt charts -
getEnd
See Also:
-
setEnd
The end time of a task.
Parameters:
end
- -
getMilestone
See Also:
-
setMilestone
Whether this point is a milestone. If so, only the start option is handled, while end is ignored. Defaults to false.
Parameters:
milestone
- -
getParent
See Also:
-
setParent
The ID of the parent point (task) of this point in Gantt charts. Defaults to null
Parameters:
parent
- -
getStart
See Also:
-
setStart
The start time of a task.
Parameters:
start
- -
getY
See Also:
-
setY
The Y value of a task.
Parameters:
y
- -
getDescription
See Also:
-
setDescription
A description of the point to add to the screen reader information about the point.
-
getId
See Also:
-
setId
An id for the point.
-
getLabelrank
See Also:
-
setLabelrank
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
See Also:
-
setName
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
-
setCustom
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
-
-