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.
The constructor produces a CommandHandler with the default key bindings.
Gets or sets the arrow key behavior. Possible values are "move", "select", and "scroll".
The default value is "move".
Gets or sets the offset at which each repeated pasteSelection puts the new copied parts from the clipboard.
To be called when arrow keys should change the selected node in a tree and expand or collapse subtrees.
Aligns selected parts at the bottom-most edge of the bottom-most part.
Aligns selected parts at the x-value of the center point of the first selected part.
Aligns selected parts at the y-value of the center point of the first selected part.
Aligns selected parts top-to-bottom in order of the order selected. Distance between parts can be specified. Default distance is 0.
Aligns selected parts along the left-most edge of the left-most part.
Aligns selected parts at the right-most edge of the right-most part.
Aligns selected parts left-to-right in order of the order selected. Distance between parts can be specified. Default distance is 0.
Aligns selected parts at the top-most edge of the top-most part.
This controls whether or not the user can invoke the alignLeft, alignRight, alignTop, alignBottom, alignCenterX, alignCenterY commands.
This returns true: if the diagram is not Diagram.isReadOnly, if the model is not Model.isReadOnly, and if there are at least two selected Parts.
This controls whether or not the user can invoke the rotate command.
This returns true: if the diagram is not Diagram.isReadOnly, if the model is not Model.isReadOnly, and if there is at least one selected Part.
This implements custom behaviors for arrow key keyboard events. Set arrowKeyBehavior to "select", "move" (the default), "scroll" (the standard behavior), or "none" to affect the behavior when the user types an arrow key.
Change the z-ordering of selected parts to pull them forward, in front of all other parts in their respective layers. All unselected parts in each layer with a selected Part with a non-numeric Part.zOrder will get a zOrder of zero.
Change the z-ordering of selected parts to push them backward, behind of all other parts in their respective layers. All unselected parts in each layer with a selected Part with a non-numeric Part.zOrder will get a zOrder of zero.
Change the angle of the parts connected with the given part. This is in the command handler so it can be easily accessed for the purpose of creating commands that change the rotation of a part.
the positive (clockwise) or negative (counter-clockwise) change in the rotation angle of each Part, in degrees.
This CommandHandler class allows the user to position selected Parts in a diagram relative to the first part selected, in addition to overriding the doKeyDown method of the CommandHandler for handling the arrow keys in additional manners.
Typical usage:
or:
If you want to experiment with this extension, try the Drawing Commands sample.