For bindings: The optional conversion function to convert property values back to data values.
Specifying this function modifies a binding to set its Binding.mode to be Binding.TwoWay.
If you want a two-way binding without a back-conversion function, specify null for a BackConversion.
diff --git a/api/symbols/ActionTool.html b/api/symbols/ActionTool.html
index 60015e233..4f0779d4a 100644
--- a/api/symbols/ActionTool.html
+++ b/api/symbols/ActionTool.html
@@ -1,4 +1,4 @@
-
The ActionTool is responsible for handling and dispatching mouse events on GraphObjects
that have GraphObject.isActionable set to true.
This is how one implements "controls", such as buttons or sliders or knobs, as GraphObjects
diff --git a/api/symbols/Adornment.html b/api/symbols/Adornment.html
index 3bfb2e249..245a4fa20 100644
--- a/api/symbols/Adornment.html
+++ b/api/symbols/Adornment.html
@@ -1,4 +1,4 @@
-
An Adornment is a special kind of Part that is associated with another Part,
the Adornment.adornedPart.
Adornments are normally associated with a particular GraphObject in the adorned Part --
diff --git a/api/symbols/Animation.html b/api/symbols/Animation.html
index a953f62d3..7e9363586 100644
--- a/api/symbols/Animation.html
+++ b/api/symbols/Animation.html
@@ -1,4 +1,4 @@
-
This class is useful for creating manual animations.
If you wish to animate particular properties on a GraphObject every time their value changes,
diff --git a/api/symbols/AnimationManager.html b/api/symbols/AnimationManager.html
index 0be13491e..84f0b4d85 100644
--- a/api/symbols/AnimationManager.html
+++ b/api/symbols/AnimationManager.html
@@ -1,4 +1,4 @@
-
AnimationManager handles animations in a Diagram. Each Diagram has one, Diagram.animationManager.
Setting the Model, performing a Layout, Group expansion and Tree expansion automatically start animations through
the defaultAnimation. Animations can be manually started by creating Animations, which are associated with an
diff --git a/api/symbols/AnimationTrigger.html b/api/symbols/AnimationTrigger.html
index d64c640a9..d1b3ed107 100644
--- a/api/symbols/AnimationTrigger.html
+++ b/api/symbols/AnimationTrigger.html
@@ -1,4 +1,4 @@
-
An AnimationTrigger describes how to automatically animate a property on a GraphObject
when it changes value.
The target property name is a string, and all name matching is case-sensitive.
diff --git a/api/symbols/ArrangingLayout.html b/api/symbols/ArrangingLayout.html
index 97dde0e93..5b3611c44 100644
--- a/api/symbols/ArrangingLayout.html
+++ b/api/symbols/ArrangingLayout.html
@@ -1,4 +1,4 @@
-ArrangingLayout | GoJS API
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
A custom Layout that provides one way to have a layout of layouts.
It partitions nodes and links into separate subnetworks, applies a primary
layout to each subnetwork, and then arranges those results by an
diff --git a/api/symbols/BalloonLink.html b/api/symbols/BalloonLink.html
index 76ccaf70c..efc5bbd9f 100644
--- a/api/symbols/BalloonLink.html
+++ b/api/symbols/BalloonLink.html
@@ -1,4 +1,4 @@
-
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This custom Link class customizes its Shape to surround the comment node (the from node).
If the Shape is filled, it will obscure the comment itself unless the Link is behind the comment node.
Thus the default layer for BalloonLinks is "Background".
diff --git a/api/symbols/Binding.html b/api/symbols/Binding.html
index 7ea2000de..d9b253166 100644
--- a/api/symbols/Binding.html
+++ b/api/symbols/Binding.html
@@ -1,4 +1,4 @@
-Binding | GoJS API
A Binding describes how to automatically set a property on a GraphObject
to a value of a property of data in the model.
The target property name and the data source property name are strings.
diff --git a/api/symbols/Brush.html b/api/symbols/Brush.html
index f6f181105..0c919a1b2 100644
--- a/api/symbols/Brush.html
+++ b/api/symbols/Brush.html
@@ -1,4 +1,4 @@
-
A Brush holds color information and describes how to draw the inside
of a Shape or the stroke of a shape or a TextBlock or the
background of any GraphObject.
diff --git a/api/symbols/ChangedEvent.html b/api/symbols/ChangedEvent.html
index 01146a173..e1655584a 100644
--- a/api/symbols/ChangedEvent.html
+++ b/api/symbols/ChangedEvent.html
@@ -1,4 +1,4 @@
-ChangedEvent | GoJS API
A ChangedEvent represents a change to an object, typically a GraphObject,
but also for model data, a Model, or a Diagram.
The most common case is for remembering the name of a property
diff --git a/api/symbols/CircularEdge.html b/api/symbols/CircularEdge.html
index 6dd5afd91..7e1f851f5 100644
--- a/api/symbols/CircularEdge.html
+++ b/api/symbols/CircularEdge.html
@@ -1,4 +1,4 @@
-
This layout positions nodes in a circular arrangement.
There are several samples that use CircularLayout.
The layout cannot guarantee that it provides optimal positioning of nodes when trying to minimize link crossings.
diff --git a/api/symbols/CircularNetwork.html b/api/symbols/CircularNetwork.html
index 07a765fa8..4ed9e43c1 100644
--- a/api/symbols/CircularNetwork.html
+++ b/api/symbols/CircularNetwork.html
@@ -1,4 +1,4 @@
-CircularNetwork | GoJS API
This class represents an abstract graph of CircularVertexes and CircularEdges
that can be constructed based on the Nodes and Links of a Diagram
so that the CircularLayout can operate independently of the diagram until it
diff --git a/api/symbols/CircularVertex.html b/api/symbols/CircularVertex.html
index d228752fe..09668cfec 100644
--- a/api/symbols/CircularVertex.html
+++ b/api/symbols/CircularVertex.html
@@ -1,4 +1,4 @@
-
The ClickCreatingTool lets the user create a node by clicking where they want the new node to be.
By default a double-click is required to start this tool;
set isDoubleClick to false if you want a single-click to create a node.
diff --git a/api/symbols/ClickSelectingTool.html b/api/symbols/ClickSelectingTool.html
index 721d7af5a..2a3e70d45 100644
--- a/api/symbols/ClickSelectingTool.html
+++ b/api/symbols/ClickSelectingTool.html
@@ -1,4 +1,4 @@
-ClickSelectingTool | GoJS API
The ClickSelectingTool selects and deselects Parts when there is a click.
It does this by calling Tool.standardMouseSelect.
It is also responsible for handling and dispatching click events on GraphObjects
diff --git a/api/symbols/ColumnResizingTool.html b/api/symbols/ColumnResizingTool.html
index 2aae93faa..9979ac241 100644
--- a/api/symbols/ColumnResizingTool.html
+++ b/api/symbols/ColumnResizingTool.html
@@ -1,4 +1,4 @@
-
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This command changes the Diagram.scale so that the Diagram.documentBounds fits within the viewport.
If this command had been called before without any other zooming since then,
the original Diagram scale and position are restored.
-This is normally invoked by the Shift-Z keyboard shortcut.
+This is normally invoked by the Shift-Z keyboard shortcut.
+If you do not want the behavior where this command might restore the original diagram scale and position on a subsequent call,
+set isZoomToFitRestoreEnabled to false.
As of 2.1, this animates zooming by default. Diagram.zoomToFit does not animate.
This method may be overridden, but you should consider calling this base method in order to get all of its functionality.
Please read the Introduction page on Extensions for how to override methods and how to call this base method.
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
This CurvedLinkReshapingTool class allows for a Link's path to be modified by the user
via the dragging of a single tool handle at the middle of the link.
Dragging the handle changes the value of Link.curviness.
diff --git a/api/symbols/Diagram.html b/api/symbols/Diagram.html
index 31ffe1d9f..79a419686 100644
--- a/api/symbols/Diagram.html
+++ b/api/symbols/Diagram.html
@@ -1,4 +1,4 @@
-Diagram | GoJS API
A Diagram is associated with an HTML DIV element. Constructing a Diagram creates
an HTML Canvas element which it places inside of the given DIV element, in addition to several helper DIVs.
GoJS will manage the contents of this DIV -- you should not modify the contents of the DIV,
@@ -332,8 +332,8 @@
A fallback (like default here) is necessary for a custom cursor to work.
If the specified cursor is not accepted by the platform, GoJS will append
--webkit- or -moz- prefixes.
+
If the specified cursor is not accepted by the platform, this property setter will try prepending
+-webkit- and -moz- prefixes when assigning the "cursor" CSS style property.
Setting this property does not notify about any changed event.
Setting this value to the empty string ('') returns the Diagram's cursor to the defaultCursor.
A DiagramEvent represents a more abstract event than an InputEvent.
They are raised on the Diagram class.
One can receive such events by registering a DiagramEvent listener on a Diagram
diff --git a/api/symbols/DiagramFile.html b/api/symbols/DiagramFile.html
index 5563133bc..6ac60df97 100644
--- a/api/symbols/DiagramFile.html
+++ b/api/symbols/DiagramFile.html
@@ -1,4 +1,4 @@
-
This is part of GoCloudStorage and not part of the main GoJS library. Storage can be found in the GoJS kit under the projects folder. See the Storage intro page for more information.
This is part of GoCloudStorage and not part of the main GoJS library. Storage can be found in the GoJS kit under the projects folder. See the Storage intro page for more information.
Hierarchy
DiagramFile
A simple interface containing basic information about a diagram saved to a storage service.
Guarantees the existence of file id, name, and path.
DiagramFiles are used as a minimal representation of files stored in data. GoCloudStorage.currentDiagramFile.
diff --git a/api/symbols/DimensioningLink.html b/api/symbols/DimensioningLink.html
index 1bf21e6f3..f2bcdb82d 100644
--- a/api/symbols/DimensioningLink.html
+++ b/api/symbols/DimensioningLink.html
@@ -1,4 +1,4 @@
-
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
GoJS API
GoJS Class Index
Diagram Classes
Geometry Classes
Model Classes
Layout Classes
Tool Classes
Collection Classes
Extension Classes
Layout Extension Classes
Part Extension Classes
Tool Extension Classes
Storage Classes
Type
Back Conversion: ((val: any, sourceData: any, model: Model) => any) | null
For bindings: The optional conversion function to convert property values back to data values. Specifying this function modifies a binding to set its Binding.mode to be Binding.TwoWay. If you want a two-way binding without a back-conversion function, specify
null
for aBackConversion
. diff --git a/api/symbols/ActionTool.html b/api/symbols/ActionTool.html index 60015e233..4f0779d4a 100644 --- a/api/symbols/ActionTool.html +++ b/api/symbols/ActionTool.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ActionTool
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ActionTool
Hierarchy
The ActionTool is responsible for handling and dispatching mouse events on GraphObjects that have GraphObject.isActionable set to true. This is how one implements "controls", such as buttons or sliders or knobs, as GraphObjects diff --git a/api/symbols/Adornment.html b/api/symbols/Adornment.html index 3bfb2e249..245a4fa20 100644 --- a/api/symbols/Adornment.html +++ b/api/symbols/Adornment.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class Adornment
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class Adornment
Hierarchy
An Adornment is a special kind of Part that is associated with another Part, the Adornment.adornedPart.
Adornments are normally associated with a particular GraphObject in the adorned Part -- diff --git a/api/symbols/Animation.html b/api/symbols/Animation.html index a953f62d3..7e9363586 100644 --- a/api/symbols/Animation.html +++ b/api/symbols/Animation.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class Animation
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class Animation
Hierarchy
Animations are used to animate GraphObject and Diagram properties.
This class is useful for creating manual animations. If you wish to animate particular properties on a GraphObject every time their value changes, diff --git a/api/symbols/AnimationManager.html b/api/symbols/AnimationManager.html index 0be13491e..84f0b4d85 100644 --- a/api/symbols/AnimationManager.html +++ b/api/symbols/AnimationManager.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class AnimationManager
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class AnimationManager
Hierarchy
AnimationManager handles animations in a Diagram. Each Diagram has one, Diagram.animationManager. Setting the Model, performing a Layout, Group expansion and Tree expansion automatically start animations through the defaultAnimation. Animations can be manually started by creating Animations, which are associated with an diff --git a/api/symbols/AnimationTrigger.html b/api/symbols/AnimationTrigger.html index d64c640a9..d1b3ed107 100644 --- a/api/symbols/AnimationTrigger.html +++ b/api/symbols/AnimationTrigger.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class AnimationTrigger
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class AnimationTrigger
Hierarchy
An AnimationTrigger describes how to automatically animate a property on a GraphObject when it changes value. The target property name is a string, and all name matching is case-sensitive.
diff --git a/api/symbols/ArrangingLayout.html b/api/symbols/ArrangingLayout.html index 97dde0e93..5b3611c44 100644 --- a/api/symbols/ArrangingLayout.html +++ b/api/symbols/ArrangingLayout.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ArrangingLayout Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ArrangingLayout Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
A custom Layout that provides one way to have a layout of layouts. It partitions nodes and links into separate subnetworks, applies a primary layout to each subnetwork, and then arranges those results by an diff --git a/api/symbols/BalloonLink.html b/api/symbols/BalloonLink.html index 76ccaf70c..efc5bbd9f 100644 --- a/api/symbols/BalloonLink.html +++ b/api/symbols/BalloonLink.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class BalloonLink Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class BalloonLink Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
This custom Link class customizes its Shape to surround the comment node (the from node). If the Shape is filled, it will obscure the comment itself unless the Link is behind the comment node. Thus the default layer for BalloonLinks is "Background".
diff --git a/api/symbols/Binding.html b/api/symbols/Binding.html index 7ea2000de..d9b253166 100644 --- a/api/symbols/Binding.html +++ b/api/symbols/Binding.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class Binding
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class Binding
Hierarchy
A Binding describes how to automatically set a property on a GraphObject to a value of a property of data in the model. The target property name and the data source property name are strings. diff --git a/api/symbols/Brush.html b/api/symbols/Brush.html index f6f181105..0c919a1b2 100644 --- a/api/symbols/Brush.html +++ b/api/symbols/Brush.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class Brush
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class Brush
Hierarchy
A Brush holds color information and describes how to draw the inside of a Shape or the stroke of a shape or a TextBlock or the background of any GraphObject.
diff --git a/api/symbols/ChangedEvent.html b/api/symbols/ChangedEvent.html index 01146a173..e1655584a 100644 --- a/api/symbols/ChangedEvent.html +++ b/api/symbols/ChangedEvent.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ChangedEvent
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ChangedEvent
Hierarchy
A ChangedEvent represents a change to an object, typically a GraphObject, but also for model data, a Model, or a Diagram. The most common case is for remembering the name of a property diff --git a/api/symbols/CircularEdge.html b/api/symbols/CircularEdge.html index 6dd5afd91..7e1f851f5 100644 --- a/api/symbols/CircularEdge.html +++ b/api/symbols/CircularEdge.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class CircularEdge
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class CircularEdge
Hierarchy
This holds CircularLayout-specific information about Links.
This class inherits from LayoutEdge.
Index
Constructors
Inherited Members
Properties
Methods
Constructors
constructor
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class CircularLayout
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class CircularLayout
Hierarchy
This layout positions nodes in a circular arrangement. There are several samples that use CircularLayout. The layout cannot guarantee that it provides optimal positioning of nodes when trying to minimize link crossings.
diff --git a/api/symbols/CircularNetwork.html b/api/symbols/CircularNetwork.html index 07a765fa8..4ed9e43c1 100644 --- a/api/symbols/CircularNetwork.html +++ b/api/symbols/CircularNetwork.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class CircularNetwork
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class CircularNetwork
Hierarchy
This class represents an abstract graph of CircularVertexes and CircularEdges that can be constructed based on the Nodes and Links of a Diagram so that the CircularLayout can operate independently of the diagram until it diff --git a/api/symbols/CircularVertex.html b/api/symbols/CircularVertex.html index d228752fe..09668cfec 100644 --- a/api/symbols/CircularVertex.html +++ b/api/symbols/CircularVertex.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class CircularVertex
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class CircularVertex
Hierarchy
This holds CircularLayout-specific information about Nodes.
This class inherits from LayoutVertex.
Index
Constructors
Properties
Inherited Members
Properties
Methods
Constructors
constructor
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ClickCreatingTool
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ClickCreatingTool
Hierarchy
The ClickCreatingTool lets the user create a node by clicking where they want the new node to be. By default a double-click is required to start this tool; set isDoubleClick to false if you want a single-click to create a node.
diff --git a/api/symbols/ClickSelectingTool.html b/api/symbols/ClickSelectingTool.html index 721d7af5a..2a3e70d45 100644 --- a/api/symbols/ClickSelectingTool.html +++ b/api/symbols/ClickSelectingTool.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ClickSelectingTool
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ClickSelectingTool
Hierarchy
The ClickSelectingTool selects and deselects Parts when there is a click. It does this by calling Tool.standardMouseSelect. It is also responsible for handling and dispatching click events on GraphObjects diff --git a/api/symbols/ColumnResizingTool.html b/api/symbols/ColumnResizingTool.html index 2aae93faa..9979ac241 100644 --- a/api/symbols/ColumnResizingTool.html +++ b/api/symbols/ColumnResizingTool.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ColumnResizingTool Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ColumnResizingTool Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
The ColumnResizingTool class lets the user resize each column of a named Table Panel in a selected Part.
If you want to experiment with this extension, try the Column Resizing sample.
Index
Constructors
Properties
Methods
Inherited Members
Properties
Methods
Constructors
constructor
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class CommandHandler
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class CommandHandler
Hierarchy
The Diagram.commandHandler implements various commands such as CommandHandler.deleteSelection or CommandHandler.redo. The CommandHandler includes keyboard event handling to interpret @@ -638,11 +638,13 @@
Keyboard Shortcuts
This command changes the Diagram.scale so that the Diagram.documentBounds fits within the viewport. If this command had been called before without any other zooming since then, the original Diagram scale and position are restored. -This is normally invoked by the
+This is normally invoked by theShift-Z
keyboard shortcut.Shift-Z
keyboard shortcut. +If you do not want the behavior where this command might restore the original diagram scale and position on a subsequent call, +set isZoomToFitRestoreEnabled to false.As of 2.1, this animates zooming by default. Diagram.zoomToFit does not animate.
This method may be overridden, but you should consider calling this base method in order to get all of its functionality. Please read the Introduction page on Extensions for how to override methods and how to call this base method.
-canZoomToFit
+canZoomToFit, isZoomToFitRestoreEnabled
1.1
Returns void
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class ContextMenuTool
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class ContextMenuTool
Hierarchy
The ContextMenuTool is used to create and show a context menu. It automatically disables any browser context menu.
Define context menus on individual GraphObjects by setting GraphObject.contextMenu. diff --git a/api/symbols/CurvedLinkReshapingTool.html b/api/symbols/CurvedLinkReshapingTool.html index fca6db100..f3c8f8866 100644 --- a/api/symbols/CurvedLinkReshapingTool.html +++ b/api/symbols/CurvedLinkReshapingTool.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class CurvedLinkReshapingTool Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class CurvedLinkReshapingTool Extension
This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the
extensions
(for loading via script tags),extensionsTS
(UMD modules), orextensionsJSM
(ES6 modules) folders. See the Extensions intro page for more information.Hierarchy
This CurvedLinkReshapingTool class allows for a Link's path to be modified by the user via the dragging of a single tool handle at the middle of the link. Dragging the handle changes the value of Link.curviness.
diff --git a/api/symbols/Diagram.html b/api/symbols/Diagram.html index 31ffe1d9f..79a419686 100644 --- a/api/symbols/Diagram.html +++ b/api/symbols/Diagram.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class Diagram
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class Diagram
Hierarchy
A Diagram is associated with an HTML DIV element. Constructing a Diagram creates an HTML Canvas element which it places inside of the given DIV element, in addition to several helper DIVs. GoJS will manage the contents of this DIV -- you should not modify the contents of the DIV, @@ -332,8 +332,8 @@ A fallback (like default here) is necessary for a custom cursor to work.
To read more about cursor syntax, go to: CSS cursors (mozilla.org).
-If the specified cursor is not accepted by the platform, GoJS will append -
+-webkit-
or-moz-
prefixes.If the specified cursor is not accepted by the platform, this property setter will try prepending +
-webkit-
and-moz-
prefixes when assigning the "cursor" CSS style property.Setting this property does not notify about any changed event. Setting this value to the empty string ('') returns the Diagram's cursor to the defaultCursor.
defaultCursor, GraphObject.cursor
diff --git a/api/symbols/DiagramEvent.html b/api/symbols/DiagramEvent.html index 6450daefb..7bb7dba0b 100644 --- a/api/symbols/DiagramEvent.html +++ b/api/symbols/DiagramEvent.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Class DiagramEvent
Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Class DiagramEvent
Hierarchy
A DiagramEvent represents a more abstract event than an InputEvent. They are raised on the Diagram class. One can receive such events by registering a DiagramEvent listener on a Diagram diff --git a/api/symbols/DiagramFile.html b/api/symbols/DiagramFile.html index 5563133bc..6ac60df97 100644 --- a/api/symbols/DiagramFile.html +++ b/api/symbols/DiagramFile.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.14
by Northwoods Software®
Interface DiagramFile Storage
This is part of GoCloudStorage and not part of the main GoJS library. Storage can be found in the GoJS kit under the
projects
folder. See the Storage intro page for more information.Hierarchy
- Preparing search index...
- The search index is not available
GoJS APIversion 2.2.15
by Northwoods Software®
Interface DiagramFile Storage
This is part of GoCloudStorage and not part of the main GoJS library. Storage can be found in the GoJS kit under the
projects
folder. See the Storage intro page for more information.Hierarchy
A simple interface containing basic information about a diagram saved to a storage service. Guarantees the existence of file id, name, and path.
DiagramFiles are used as a minimal representation of files stored in data. GoCloudStorage.currentDiagramFile. diff --git a/api/symbols/DimensioningLink.html b/api/symbols/DimensioningLink.html index 1bf21e6f3..f2bcdb82d 100644 --- a/api/symbols/DimensioningLink.html +++ b/api/symbols/DimensioningLink.html @@ -1,4 +1,4 @@ -