class anychart.core.gantt.edit.StructureEdit Improve this Doc

Extends: anychart.core.Base

Structure edit class. The StructureEdit class defines editing setting on the Gantt chart, DataGrid, Timeline. Drag a row on the chart, datagrid, or timeline to edit the structure of the tree data.

Methods Overview

Specific settings
enabled()	Disable or enable enabled state.
Coloring
fill()	Row fill settings.
placementStroke()	Placement line stroke settings.
stroke()	Row stroke settings.

Methods Description

enabled

enabled()Since version 8.3.0

Getter for the enabled state of the edit chart, datagrid, timeline.

Returns:

boolean - Enabled state.

enabled(enabled)Since version 8.3.0

Setter for the enabled state of the edit chart, datagrid, timeline.
Enabled state of the datagrid and timeline has priority over enabled state of the chart. Note: anychart.core.gantt.edit.ElementEdit#enabled method of the timeline has more priority over anychart.core.gantt.edit.StructureEdit#enabled of the timeline.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

fill

fill()Since version 8.3.0

Getter for the row fill while editing structure of the data tree.

Returns:

anychart.graphics.vector.Fill - Element fill settings.

See listing

var edit = chart.edit();
edit.enabled(true);
var fill = edit.fill();

fill(color)Since version 8.3.0

Setter for the row fill while editing structure of a chart using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an object, an array or a string.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

fill(color, opacity)Since version 8.3.0

Row fill while editing structure of a chart color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Default	Description
color	string	'none'	Color as a string.
opacity	number		Color opacity.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 8.3.0

Linear gradient row fill while editing structure of a chart. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 8.3.0

Radial gradient row fill while editing structure of a chart. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 8.3.0

Image row fill while editing structure of a chart. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

placementStroke

placementStroke()Since version 8.3.0

Getter for the placement stroke while editing structure of a chart.

Returns:

anychart.graphics.vector.Stroke - Placement line stroke settings.

See listing

var edit = chart.edit();
edit.enabled(true);
var placementStroke = edit.placementStroke();

placementStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.3.0

Setter for the placement stroke while editing structure of a chart.
The placement stroke is a line to place a row to root item while editing. Learn more about stroke settings.

Params:

Name	Type	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| 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.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()Since version 8.3.0

Getter for the row stroke while editing structure of a chart.

Returns:

anychart.graphics.vector.Stroke - Element stroke settings.

See listing

var edit = chart.edit();
edit.enabled(true);
var stroke = edit.stroke();

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.3.0

Setter for the row stroke while editing structure of a chart. Learn more about stroke settings.

Params:

Name	Type	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| 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.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)Since version 8.3.0

Setter for the row stroke while editing structure of a chart using an object.

Params:

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

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.

Try it:

Usage sample