Class PlotOptionsGantt
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds color to the colors arrayvoid
Adds key to the keys arraygetClip()
getColor()
Color[]
String[]
getKeys()
void
removeColor
(Color color) Removes first occurrence of color in colors arrayvoid
Removes first occurrence of key in keys arrayvoid
setAllowPointSelect
(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers, bars or pie slices.void
setAnimation
(Boolean animation) Enable or disable the initial animation when a series is displayed.void
setAnimationLimit
(Number animationLimit) For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.void
setBorderColor
(Color borderColor) The color of the border surrounding each column or bar.void
setBorderRadius
(Number borderRadius) The corner radius of the border surrounding each column or bar.void
setBorderWidth
(Number borderWidth) The width of the border surrounding each column or bar.void
setCenterInCategory
(Boolean centerInCategory) When true, the columns will center in the category, ignoring null or missing points.void
setClassName
(String className) A class name to apply to the series' graphical elements.void
Disable this option to allow series rendering in the whole plotting area.void
The main color or the series.void
setColorByPoint
(Boolean colorByPoint) When using automatic point colors pulled from theoptions.colors
collection, this option determines whether the chart should receive one color per series or one color per point.void
setColorIndex
(Number colorIndex) Styled mode only.void
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.void
setConnectors
(SeriesConnectors connectors) Override Pathfinder connector options for a series.void
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.void
setCustom
(AbstractConfigurationObject custom) A reserved subspace to store options and values for customized functionality.void
setDashStyle
(DashStyle dashStyle) A name for the dash style to use for the graph.void
setDataLabels
(ArrayList<DataLabels> dataLabels) Options for the series data labels, appearing next to each data point.void
setDescription
(String description) Requires Accessibility modulevoid
setDragDrop
(DragDrop dragDrop) The DragDrop options allows points to be moved around or modified in the chart.void
setEnableMouseTracking
(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.void
setGrouping
(Boolean grouping) Whether to group non-stacked columns or to let them render independent of each other.void
setGroupPadding
(Number groupPadding) Padding between each value groups, in x axis units.void
setIncludeInDataExport
(Boolean includeInDataExport) When set to false will prevent the series data from being included in any form of data export.void
An array specifying which option maps to which key in the data point array.void
setLinkedTo
(String linkedTo) The id of another series to link to.void
setMaxPointWidth
(Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.void
setMinPointLength
(Number minPointLength) The minimal height for a column or width for a bar.void
setOpacity
(Number opacity) Opacity of a series parts: line, fill (e.g.void
setPartialFill
(PartialFill partialFill) Partial fill configuration for series points, typically used to visualize how much of a task is performed.void
setPointDescriptionFormatter
(String _fn_pointDescriptionFormatter) void
setPointPadding
(Number pointPadding) Padding between each column or bar, in x axis units.void
setPointWidth
(Number pointWidth) A pixel value specifying a fixed width for each column or bar.void
setSelected
(Boolean selected) Whether to select the series initially.void
Whether to apply a drop shadow to the graph line.void
setShowCheckbox
(Boolean showCheckbox) If true, a checkbox is displayed next to the legend item to allow selecting the series.void
setShowInLegend
(Boolean showInLegend) Whether to display this particular series or series type in the legend.void
setSkipKeyboardNavigation
(Boolean skipKeyboardNavigation) If set toTrue
, the accessibility module will skip past the points in this series for keyboard navigation.void
A wrapper object for all the series options in specific states.void
setStickyTracking
(Boolean stickyTracking) Sticky tracking of mouse events.void
setTooltip
(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.void
setTurboThreshold
(Number turboThreshold) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.void
setVisible
(Boolean visible) Set the initial visibility of the series.
-
Constructor Details
-
PlotOptionsGantt
public PlotOptionsGantt()
-
-
Method Details
-
getChartType
- Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowPointSelect
- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.Defaults to: false
-
getAnimation
- See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, seeChartModel.setAnimation(Boolean)
-
getAnimationLimit
- See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, setanimationLimit
toInfinity
. -
getBorderColor
- See Also:
-
setBorderColor
The color of the border surrounding each column or bar.
In styled mode, the border stroke can be set with the
.highcharts-point
rule.Defaults to: #ffffff
-
getBorderRadius
- See Also:
-
setBorderRadius
The corner radius of the border surrounding each column or bar.Defaults to: 0
-
getBorderWidth
- See Also:
-
setBorderWidth
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the
.highcharts-point
rule.Defaults to: 1
-
getClassName
- See Also:
-
setClassName
A class name to apply to the series' graphical elements. -
getColor
- See Also:
-
setColor
The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the
options.colors
array.In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the
.highcharts-series
,.highcharts-color-{n}
,.highcharts-{type}-series
or.highcharts-series-{n}
class, or individual classes given by theclassName
option. -
getColorByPoint
- See Also:
-
setColorByPoint
When using automatic point colors pulled from theoptions.colors
collection, this option determines whether the chart should receive one color per series or one color per point.Defaults to: false
-
getColorIndex
- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}
. -
getColors
- See Also:
-
setColors
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true. -
addColor
Adds color to the colors array- Parameters:
color
- to add- See Also:
-
removeColor
Removes first occurrence of color in colors array- Parameters:
color
- to remove- See Also:
-
getCursor
- See Also:
-
setCursor
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. -
getDataLabels
- See Also:
-
setDataLabels
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the
.highcharts-data-label-box
and.highcharts-data-label
class names (see example). -
getDescription
- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
-
getEnableMouseTracking
- See Also:
-
setEnableMouseTracking
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.Defaults to: true
-
getGroupPadding
- See Also:
-
setGroupPadding
Padding between each value groups, in x axis units.Defaults to: 0.2
-
getGrouping
- See Also:
-
setGrouping
Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.Defaults to: true
-
getKeys
- See Also:
-
setKeys
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources. -
addKey
Adds key to the keys array- Parameters:
key
- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Parameters:
key
- to remove- See Also:
-
getLinkedTo
- See Also:
-
setLinkedTo
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series. -
getMaxPointWidth
- See Also:
-
setMaxPointWidth
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.Defaults to: null
-
getMinPointLength
- See Also:
-
setMinPointLength
The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.Defaults to: 0
-
getPointDescriptionFormatter
-
setPointDescriptionFormatter
-
getPointPadding
- See Also:
-
setPointPadding
Padding between each column or bar, in x axis units.Defaults to: 0.1
-
getPointWidth
- See Also:
-
setPointWidth
A pixel value specifying a fixed width for each column or bar. Whennull
, the width is calculated from thepointPadding
andgroupPadding
. -
getSelected
- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckbox
is true, the checkbox next to the series name will be checked for a selected series.Defaults to: false
-
getShadow
- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor
,offsetX
,offsetY
,opacity
andwidth
.Defaults to: false
-
getShowCheckbox
- See Also:
-
setShowCheckbox
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselected
option.Defaults to: false
-
getShowInLegend
- See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. The default value istrue
for standalone series,false
for linked series.Defaults to: true
-
getStates
- See Also:
-
setStates
A wrapper object for all the series options in specific states. -
getStickyTracking
- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOut
event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOut
event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTracking
is false andtooltip.shared
is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.Defaults to: true
-
getTooltip
- See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level. -
getTurboThreshold
- See Also:
-
setTurboThreshold
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to0
disable.Defaults to: 1000
-
getVisible
- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
-
getCenterInCategory
- See Also:
-
setCenterInCategory
When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.Defaults to false.
-
getClip
- See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area.Note: Clipping should be always enabled when zoomType is set
-
getDashStyle
- See Also:
-
setDashStyle
A name for the dash style to use for the graph. Applies only to series type having a graph, likeline
,spline
,area
andscatter
in case it has alineWidth
. The value for thedashStyle
include:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
Defaults to: Solid
-
getOpacity
- See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.Defaults to 1.
-
getPartialFill
- See Also:
-
setPartialFill
Partial fill configuration for series points, typically used to visualize how much of a task is performed. -
getConnectors
- See Also:
-
setConnectors
Override Pathfinder connector options for a series. Requires Highcharts Gantt to be loaded. -
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. -
getIncludeInDataExport
- See Also:
-
setIncludeInDataExport
When set to false will prevent the series data from being included in any form of data export.- Parameters:
includeInDataExport
-
-
getDragDrop
- See Also:
-
setDragDrop
The DragDrop options allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the chart fires three events: dragStart, drag and drop.
-