AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.gantt.elements.ConnectorElement Improve this Doc

Extends: anychart.core.Base

Connector element settings.

Methods Overview

Coloring
fill()Connector fill settings.
previewStroke()Connector preview stroke settings.
stroke()Connector stroke settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Removes all listeners.
unlisten()Removes the listener.
unlistenByKey()Removes the listener by the key.
Interactivity
normal()Normal state settings.
selected()Selected state settings.

Methods Description

fill

Getter for the connector fill.

Returns:

anychart.graphics.vector.Fill string - Connector fill.
Setter for fill settings using function.

Params:

Name Type Default Description
fillFunction function
function() {
}
Function that looks like:
function(){
   // this.sourceColor - Color with type anychart.graphics.vector.Fill (directly resolvable color).
   Type is anychart.graphics.vector.Fill, anychart.graphics.vector.PatternFill. The color is set from a theme
   or palette and is determined automatically for each colorized element.
   // this.fromItem - the item of the visual element from which the connector is drawn. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem
   // this.fromItemIndex - the item linear index of the visual element from which the connector is drawn. Type is number
   // this.toItem - the item of the visual element to which the connector is drawn. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem
   // this.toItemIndex - the item linear index of the visual element to which the connector is drawn. Type is number
   // this.connType - connector type. Type is anychart.enums.ConnectorType
   // this.fromPeriod - the period of the visual element from which the connector is drawn. Type is object. A period object with the index
   this.periodIndex at the data point this.item, corresponding to the visual display element. Works only with anychart#ganttResource
   // this.fromPeriodIndex - the period index of the visual element from which the connector is drawn.
   // this.toPeriod - the period of the visual element to which the connector is drawn. Type is object. A period object with the index
   this.periodIndex at the data point this.item, corresponding to the visual display element. Works only with anychart#ganttResource
   // this.toPeriodIndex - the period index of the visual element to which the connector is drawn.

   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.

Try it:

Setter for connector fill settings using an object or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | null
"#000090"
Fill settings.
cx number
X ratio of center radial gradient.
cy number
Y ratio of center radial gradient.
opacityOrMode anychart.graphics.math.Rect
If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number
Opacity.
fx number
X ratio of focal point.
fy number
Y ratio of focal point.

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
Callback method. Function that looks like:
function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
settings Object State settings to set.

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

Try it:

previewStroke

Getter for the connector preview stroke.

Returns:

anychart.graphics.vector.Stroke string - Connector preview stroke.
See listing
var connectors = timeLine.connectors();
var previewStroke = connectors.previewStroke();
Setter for the connector preview stroke. Learn more about stroke settings.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string | null Stroke settings.
thickness number Line thickness.
dashpattern string Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

Try it:

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
settings Object State settings to set.

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

Try it:

stroke

Getter for the connector stroke settings.

Returns:

anychart.graphics.vector.Stroke string - Connector stroke settings.
Setter for the connector stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line join style.

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

Try it:

Setter for connector stroke settings using function.

Params:

Name Type Default Description
strokeFunction function
function() {
}
Function that looks like:
function(){
   // this.sourceColor - Color with type anychart.graphics.vector.Stroke (directly resolvable color).
   Type is anychart.graphics.vector.Stroke. The color is set from a theme or palette and is determined automatically for each colorized element.
   // this.fromItem - the item of the visual element from which the connector is drawn. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem
   // this.fromItemIndex - the item linear index of the visual element from which the connector is drawn. Type is number
   // this.toItem - the item of the visual element to which the connector is drawn. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem
   // this.toItemIndex - the item linear index of the visual element to which the connector is drawn. Type is number
   // this.connType - connector type. Type is anychart.enums.ConnectorType
   // this.fromPeriod - the period of the visual element from which the connector is drawn. Type is object. A period object with the index
   this.periodIndex at the data point this.item, corresponding to the visual display element. Works only with anychart#ganttResource
   // this.fromPeriodIndex - the period index of the visual element from which the connector is drawn.
   // this.toPeriod - the period of the visual element to which the connector is drawn. Type is object. A period object with the index
   this.periodIndex at the data point this.item, corresponding to the visual display element. Works only with anychart#ganttResource
   // this.toPeriodIndex - the period index of the visual element to which the connector is drawn.

    return strokeValue; // type anychart.graphics.vector.Stroke
}

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

Try it:

Setter for connector stroke settings using object.

Params:

Name Type Description
settings Object Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

anychart.core.gantt.elements.ConnectorElement - Self instance for method chaining.

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it: