AnyChart
API Reference
Still have questions?
Contact support
Top

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

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

Returns:

boolean - Enabled state.
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:

fill

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();
Setter for the row fill while editing structure of a chart using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

anychart.core.gantt.edit.StructureEdit - Self instance for method chaining.
Row fill while editing structure of a chart color with opacity. Fill as a string or an object.

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:

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:

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:

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:

placementStroke

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();
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
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.edit.StructureEdit - Self instance for method chaining.

Try it:

stroke

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();
Setter for the row stroke while editing structure of a chart. 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.edit.StructureEdit - Self instance for method chaining.

Try it: