HighchartsConnectorsOptions class
The Pathfinder module allows you to define connections between any two points, represented as lines - optionally with markers for the start and/or end points. Multiple algorithms are available for calculating how the connecting lines are drawn.
Connector functionality requires Highcharts Gantt to be loaded. In Gantt charts, the connectors are used to draw dependencies between tasks.
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsConnectorsOptions
Constructors
- HighchartsConnectorsOptions.new({double? algorithmMargin, String? dashStyle, bool? enabled, HighchartsConnectorsEndMarkerOptions? endMarker, String? lineColor, double? lineWidth, HighchartsConnectorsMarkerOptions? marker, double? radius, HighchartsConnectorsStartMarkerOptions? startMarker, String? type})
- The Pathfinder module allows you to define connections between any two points, represented as lines - optionally with markers for the start and/or end points. Multiple algorithms are available for calculating how the connecting lines are drawn.
Properties
- algorithmMargin ↔ double?
-
Set the default pathfinder margin to use, in pixels. Some Pathfinder
algorithms attempt to avoid obstacles, such as other points in the
chart. These algorithms use this margin to determine how close lines
can be to an obstacle. The default is to compute this automatically
from the size of the obstacles in the chart.
getter/setter pair
- dashStyle ↔ String?
-
Set the default dash style for this chart's connecting lines.
getter/setter pair
- enabled ↔ bool?
-
Enable connectors for this chart. Requires Highcharts Gantt.
getter/setter pair
- endMarker ↔ HighchartsConnectorsEndMarkerOptions?
-
Marker options specific to the end markers for this chart's
Pathfinder connectors. Overrides the generic marker options.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- lineColor ↔ String?
-
Set the default color for this chart's Pathfinder connecting lines.
Defaults to the color of the point being connected.
getter/setter pair
- lineWidth ↔ double?
-
Set the default pixel width for this chart's Pathfinder connecting
lines.
getter/setter pair
- marker ↔ HighchartsConnectorsMarkerOptions?
-
Marker options for this chart's Pathfinder connectors. Note that
this option is overridden by the
startMarker
andendMarker
options.getter/setter pair - radius ↔ double?
-
The corner radius for the connector line.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startMarker ↔ HighchartsConnectorsStartMarkerOptions?
-
Marker options specific to the start markers for this chart's
Pathfinder connectors. Overrides the generic marker options.
getter/setter pair
- type ↔ String?
-
Set the default pathfinder algorithm to use for this chart. It is
possible to define your own algorithms by adding them to the
Highcharts.Pathfinder.prototype.algorithms object before the chart
has been created.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJSON(
) → String -
Serializes the settings to a JSON string.
inherited
-
toOptionsJSON(
StringBuffer buffer) → void -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited