diff --git a/dist/doc/changelog.html b/dist/doc/changelog.html index 9ddb11682..c00669421 100644 --- a/dist/doc/changelog.html +++ b/dist/doc/changelog.html @@ -123,10 +123,17 @@
-

2.1.1

+

2.1.2

+ +

2.1.1

+ +

2.1.0

@@ -135,7 +142,7 @@

2.1.0

  • 'elementDraggable' event now fired whenever an element is made draggable via the draggable function
  • add support for 'groups' - elements that can contain other elements, and which are collapsible.

  • upgrade to Mottle 0.7.2. a few fixes for event delegation.

    • -

  • upgrade to katavorio 0.15.0

    • +

  • upgrade to katavorio 0.17.0

  • upgrade to mottle 0.7.2

  • upgrade to jsBezier 0.8

  • upgrade to Biltong 0.3

    • diff --git a/dist/doc/groups.html b/dist/doc/groups.html index 466e29254..1708609bb 100644 --- a/dist/doc/groups.html +++ b/dist/doc/groups.html @@ -128,7 +128,7 @@

    Groups

    jsPlumb supports the concept of 'Groups', which are elements that act as the parent for a set of child elements. When a Group element is dragged, its child elements (which are, in the DOM, child nodes of the Group element) are dragged along with it. Groups may be collapsed, which causes all of their child elements to be hidden, and for any connections - from a child element to outside of the Group to be "proxied" onto the Group's collapsed container.

    + from a child element to outside of the Group to be "proxied" onto the Group's collapsed element.

    jsPlumb.addGroup({
-    container:someElement,
+    el:someElement,
     droppable:false
 });
    @@ -284,7 +284,7 @@

    Dragging and dropping child elements

  • Set constrain:true when you create a Group:
    • jsPlumb.addGroup({
-  container:someElement,
+  el:someElement,
   constrain:true
 });
    @@ -294,7 +294,7 @@

    Dragging and dropping child elements

  • Set dropOverride:true when you create a Group:
    • jsPlumb.addGroup({
-  container:someElement,
+  el:someElement,
   dropOverride:true
 });
    diff --git a/doc/wiki/changelog.md b/doc/wiki/changelog.md index 461a5fdec..07ebe850d 100644 --- a/doc/wiki/changelog.md +++ b/doc/wiki/changelog.md @@ -1,6 +1,11 @@ +## 2.1.2 + +- issue 523 - Endpoint click registration problems +- issue 522 - Groups documentation + ## 2.1.1 -- bugfix for groups: element exposed now via getEl method, not directly as el. +- bugfix for groups: element exposed now via getEl method, not directly as el. ## 2.1.0 @@ -8,7 +13,7 @@ - add support for 'groups' - elements that can contain other elements, and which are collapsible. - upgrade to Mottle 0.7.2. a few fixes for event delegation. -- upgrade to katavorio 0.15.0 +- upgrade to katavorio 0.17.0 - upgrade to mottle 0.7.2 - upgrade to jsBezier 0.8 - upgrade to Biltong 0.3 diff --git a/doc/wiki/groups.md b/doc/wiki/groups.md index 8bd9023f3..884df0422 100644 --- a/doc/wiki/groups.md +++ b/doc/wiki/groups.md @@ -3,7 +3,7 @@ jsPlumb supports the concept of 'Groups', which are elements that act as the parent for a set of child elements. When a Group element is dragged, its child elements (which are, in the DOM, child nodes of the Group element) are dragged along with it. Groups may be collapsed, which causes all of their child elements to be hidden, and for any connections - from a child element to outside of the Group to be "proxied" onto the Group's collapsed container. + from a child element to outside of the Group to be "proxied" onto the Group's collapsed element. - [Adding a Group](#adding) - [Removing a Group](#removing) @@ -28,54 +28,54 @@ A simple example, using the defaults: ```javascript jsPlumb.addGroup({ - container:foo, + el:"foo", id:"aGroup" }); ``` -Here we've created a Group with ID `aGroup`. Its container element - `foo` - will be made draggable, and it will also +Here we've created a Group with ID `aGroup`. Its element - `foo` - will be made draggable, and it will also be configured to accept elements being dropped onto it. By default, child elements will be draggable outside of the -Group container, but if they are not dropped onto another Group they will revert to their position inside the Group -container before they were dragged. +Group element, but if they are not dropped onto another Group they will revert to their position inside the Group +element before they were dragged. Several aspects of a Group's behaviour can be configured; broadly speaking these fall into two categories: the behaviour -of the Group container, and the behaviour of its child elements. +of the Group element, and the behaviour of its child elements. -#### Group container parameters +#### Group element parameters -- **draggable** Set to true by default. If false, the Group container will not be made into a draggable element. -- **dragOptions** Options for the Group container's drag behaviour. One parameter you will likely want to consider in +- **draggable** Set to true by default. If false, the Group element will not be made into a draggable element. +- **dragOptions** Options for the Group element's drag behaviour. One parameter you will likely want to consider in the `dragOptions` is `filter`, which provides a selector, or selectors, identifying elements that should not cause a - drag to begin. For a Group container you will probably want to identify the child elements of the Group, so that they - can be dragged without kicking off a drag of the Group container. -- **droppable** Set to true by default. If false, the Group container will not allow elements to be dropped onto it in + drag to begin. For a Group element you will probably want to identify the child elements of the Group, so that they + can be dragged without kicking off a drag of the Group element. +- **droppable** Set to true by default. If false, the Group element will not allow elements to be dropped onto it in order to add them to the Group. -- **dropOptions** Options for the Group container's drop behaviour. +- **dropOptions** Options for the Group element's drop behaviour. - **proxied** True by default. Indicates that connections to child elements inside the Group (which emanate from outside -of the Group) should be proxied, when the Group is collapsed, by connections attached to the Group's container. +of the Group) should be proxied, when the Group is collapsed, by connections attached to the Group's element. #### Child element behaviour parameters - **revert** By default this is true, meaning that child elements dropped outside of the Group (and not onto another Group that is accepting droppables) will revert to their last position inside the group on mouseup. If you set `revert:false` -you get a Group that allows child elements to exist outside of the bounds of the Group container, but which will still +you get a Group that allows child elements to exist outside of the bounds of the Group element, but which will still drag when the Group is dragged and will be made invisible when the Group is collapsed. -- **prune** Set to false by default. If true, a child element dropped in whitespace outside of the Group container will +- **prune** Set to false by default. If true, a child element dropped in whitespace outside of the Group element will be removed from the Group and from the instance of jsPlumb, and any connections attached to the element will also be cleaned up. -- **orphan** Set to false by default. If true, a child element dropped in whitespace outside of the Group container will +- **orphan** Set to false by default. If true, a child element dropped in whitespace outside of the Group element will be removed from the Group, but not from the instance of jsPlumb. - **constrain** Set to false by default. If true, child elements are constrained to be dragged inside of the Group -container only. +element only. -- **ghost** Set to false by default. If true, a child element that is dragged outside of the Group container will have +- **ghost** Set to false by default. If true, a child element that is dragged outside of the Group element will have its original element left in place, and a 'ghost' element - a clone of the original - substituted, which tracks with the mouse. -- **dropOverride** False by default. If true, child elements may be dragged outside of the Group container (assuming +- **dropOverride** False by default. If true, child elements may be dragged outside of the Group element (assuming no other flag prevents this), but may not be dropped onto other Groups. @@ -107,7 +107,7 @@ You can control the location, appearance and behaviour of the Endpoints that app ```javascript jsPlumb.addGroup({ - container:someElement, + el:someElement, id:"aGroup", anchor:"Continuous", endpoint:[ "Dot", { radius:3 } ] @@ -118,7 +118,7 @@ Perhaps you want to show a large rectangle in the top left corner: ```javascript jsPlumb.addGroup({ - container:someElement, + el:someElement, id:"aGroup", anchor:"TopLeft", endpoint:[ "Rectangle", { width:10, height:10 } ] @@ -170,7 +170,7 @@ both already discussed above: ```javascript jsPlumb.addGroup({ - container:someElement, + el:someElement, droppable:false }); ``` @@ -181,7 +181,7 @@ This prevents the Group from accepting dropped elements. ```javascript jsPlumb.addGroup({ - container:someElement, + el:someElement, constrain:true }); ``` @@ -192,7 +192,7 @@ This will prevent elements from being dragged outside of the Group. ```javascript jsPlumb.addGroup({ - container:someElement, + el:someElement, dropOverride:true }); ```