Added matrix id to FamItemConfig

Author: BasicPrimitives

apireference/algorithms.md

@@ -179,6 +179,38 @@ Eliminates crossing parent child relations between nodes based of nodes order in
 | --- | --- | --- | --- | 
  | `treeLevels` | treeLevels | `` | Tree levels structure keeps orders of nodes level by level. | 
 
+ `groupBy(thisArg, size, onGroup, onItem)` 
+
+Creates graph structure out of the family structure.
+
+| Param | Type | Default | Description | 
+| --- | --- | --- | --- | 
+ | `thisArg` | Object | `` | The callback function invocation context | 
+ | `onGroup` | onFamilyGroupCallback | `` | A callback function to call for every new group of nodes found | 
+ | `onGroup` | onFamilyGroupItemCallback | `` | A callback function to call for every new group of nodes found | 
+**Callbacks**
+
+ `onFamilyGroupCallback(parent, child, nodes)` 
+
+Callback for grouping nodes having common single parent and child
+
+| Param | Type | Default | Description | 
+| --- | --- | --- | --- | 
+ | `parent` | string | `` | The common parent node id | 
+ | `child` | string | `` | The common child node id | 
+ | `nodes` | Array.<string> | `` | Collection of grouped nodes ids | 
+ | `nodes` | Array.<Object> | `` | Collection of grouped items | 
+
+ `onFamilyGroupItemCallback(itemid)` 
+
+Callback for getting group id for individual nodes
+
+ Returns: `string` - returns group id or null. null adds node to default group. return -1 to disable node grouping.
+
+| Param | Type | Default | Description | 
+| --- | --- | --- | --- | 
+ | `itemid` | string | `` | The item id | 
+
  `hasCommonChild(parents)` 
 
 Checks whether parents share a child node. Common child should belong only to the given collection of parents, if child's parents don't match given collection of parents, it is not considered as common child.

apireference/enums.md

@@ -144,12 +144,12 @@ Interactivity mode. Control implements standard behavior of classic desktop UI c
  | `Inactive` | number | `2` | No interactivity | 
 
 ## <a name="NeighboursSelectionMode" id="NeighboursSelectionMode">NeighboursSelectionMode</a>
-Neighbors selection mode. The control supports diagram auto fit into screen view. It is achieved via drawing nodes in form of markers. So small nodes make diagram fit into the screen space, but they have no details. Our solution is to show cursor and selected items of the diagram in full size and draw all other as markers. This enumeration controls visibility of neighbours of the cursor node in the auto fit mode. It allows to draw them in full size regardless of available space.
+Neighbors selection mode. The control supports diagram auto fit into screen view. It is achieved via drawing nodes in form of markers. So small nodes make diagram fit into the screen space, but they have no details. Our solution is to show cursor and selected items of the diagram in full size and draw all other as markers. This enumeration controls visibility of neighbors of the cursor node in the auto fit mode. It allows to draw them in full size regardless of available space.
 
 | Name | Type | Value | Description | 
 | --- | --- | --- | --- | 
  | `ParentsAndChildren` | number | `0` | Selects parents and children of the cursor item | 
- | `ParentsChildrenSiblingsAndSpouses` | number | `1` | Selects parents, children, spouses and siblings of the cursor item. | 
+ | `ParentsChildrenSiblingsAndSpouses` | number | `1` | Selects parents, children, and siblings of the cursor item. | 
 
 ## <a name="OrientationType" id="OrientationType">OrientationType</a>
 Controls diagram layout orientation. The control can be rotated in any direction, this is needed for arabic support and various layout.

apireference/famdiagram.md

@@ -17,8 +17,8 @@ Family Chart configuration object. Use this object as a reference for available
 ### Properties
 | Name | Type | Default | Description | 
 | --- | --- | --- | --- | 
- | `annotations` | Array.<(ShapeAnnotationConfi | `[]` | Annotations. Annotations are API elements that are attached to the diagram nodes. We draw our annotations either in front of the nodes or in the background. The annotations don't affect the nodes placement in any way. As a result the control redraws them instantaneously without rendering or recalculating the actual diagram layout. | 
- | `cursorItem` | string | `null` | Cursor item. Family Chart control has API options equivalent to regular UI controls. The cursor item is used to select single item in the hierarchy with mouse click, highlight item provides visual feed back on mouse over. Selected items collection is equivalent to checked items in ListView or TreeView controls. Chart navigation depends on current cursor item, chart shows cursor and its neighbours in full size regardless of enabled page fit mode. So cursor item plays a role of local zoom in the chart hierarchy. User navigates around chart via clicking and moving cursor item around and zooming into data around new cursor item. The control notifies about this property changes with `onHighlightChanging` and `onHighlightChanged` events. If `null` then no cursor item selected in the diagram. | 
+ | `annotations` | Array.<(ShapeAnnotationConfi | `[]` | Annotations. Annotations are API elements attached to the diagram nodes and designed to highlight some nodes or relations. We draw our annotations either in front of the nodes or in the background. The annotations don't affect the placement of the nodes in any way. We have some exceptions. As a result, the control redraws them instantaneously without rendering or recalculating the actual diagram layout. | 
+ | `cursorItem` | string | `null` | Cursor item. Family Chart control has API options equivalent to standard UI controls. The cursor item is used to select a single item in the hierarchy with a mouse click, and the highlighted item provides visual feedback on the mouse over. Selected items collection is equivalent to checked items in ListView or TreeView controls. The chart's navigation work around the current cursor item. The component shows the cursor and its neighbors regardless of page fit mode. So cursor item plays the role of local zoom in the chart hierarchy. The user navigates around the chart via clicking and selecting cursor items and zooming into data around the new cursor item. The control notifies about this property changes with `onCursorChanging` and `onCursorChanged` events. If the cursor item is set to null, then no cursor item is selected in the diagram. | 
  | `emptyDiagramMessage` | string | `"Diagram is empty."` | Empty diagram message. This option is supposed to say user that chart is empty when no data is available for rendering. | 
  | `enablePanning` | boolean | `true` | Enable panning. Enable chart panning with mouse drag & drop for desktop browsers. Disable it if you need to support items Drag & Drop. | 
  | `hasSelectorCheckbox` | Enabled | `Auto` | Sets visibility of selection check boxes for the diagram nodes. `Auto` - visible for cursor item only `True` - visible `False` - hidden See `selectedItems` property. All items listed in this property are going to have checked selection checkboxes. Checkbox can be added to item template, in that case it should be named="checkbox", so control can use it as built in checkbox element. | 
@@ -298,11 +298,12 @@ Item Configuration Object defines properties of individual node in the family ch
 ### Properties
 | Name | Type | Default | Description | 
 | --- | --- | --- | --- | 
+ | `addToMatrix` | boolean | `true` | Add to matrix property allows node to be grouped with other nodes into matrix. It is true by default. | 
  | `hasSelectorCheckbox` | Enabled | `Auto` | Shows selection check box for the node. If Auto then selection check box visibility depends on control's configuration. Auto - depends on `hasSelectorCheckbox` property of the control True - shown False - hidden | 
  | `id` | string | `null` | Item id. It should be unique per chart. | 
  | `isActive` | boolean | `true` | If true it makes item inactive in the diagram layout. Inactive items are regular items excluded from navigation, that means when diagram uses auto fit mode, selection of the neighboring nodes goes through inactive items, so all nodes next to inactive item become selected and shown in full size as well. Inactive items play a role of in layout annotations having no user interaction and templated with HTML. For example they can be used to add titles into family diagram layout or terminator items indicating that upon reaching them diagram would load extra nodes into layout. | 
+ | `matrixId` | string | `null` | Matrix id defines grouping of multiple nodes into individual matrixes. By default all applicable nodes grouped into a single matrix. Use this property to split nodes into multiple matrixes. | 
  | `parents` | string[] | `[]` | Parents items ids. If this collection is empty then item considered as a root item. | 
- | `spouses` | string[] | `[]` | Spouses items ids. The nodes of this collection create fake invisible child node, so all of them are being connected with common child connection line. | 
 
 ### Callout Properties
 | Name | Type | Default | Description | 

apireference/orgdiagram.md

@@ -17,8 +17,8 @@ Organizational Chart configuration object. Use this object as a reference for av
 ### Properties
 | Name | Type | Default | Description | 
 | --- | --- | --- | --- | 
- | `annotations` | Array.<(ShapeAnnotationConfi | `[]` | Annotations. Annotations are API elements that are attached to the diagram nodes. We draw our annotations either in front of the nodes or in the background. The annotations don't affect the nodes placement in any way. As a result the control redraws them instantaneously without rendering or recalculating the actual diagram layout. | 
- | `cursorItem` | string | `null` | Cursor item. Organization Chart control has API options equivalent to regular UI controls. The cursor item is used to select single item in the hierarchy with mouse click, highlight item provides visual feed back on mouse over. Selected items collection is equivalent to checked items in ListView or TreeView controls. Chart navigation depends on current cursor item, chart shows cursor and its neighbours in full size regardless of enabled page fit mode. So cursor item plays a role of local zoom in the chart hierarchy. User navigates around chart via clicking and moving cursor item around and zooming into data around new cursor item. The control notifies about this property changes with `onHighlightChanging` and `onHighlightChanged` events. If `null` then no cursor item selected in the diagram. | 
+ | `annotations` | Array.<(ShapeAnnotationConfi | `[]` | Annotations. Annotations are API elements attached to the diagram nodes and designed to highlight some nodes or relations. We draw our annotations either in front of the nodes or in the background. The annotations don't affect the placement of the nodes in any way. We have some exceptions. As a result, the control redraws them instantaneously without rendering or recalculating the actual diagram layout. | 
+ | `cursorItem` | string | `null` | Cursor item. Organization Chart control has API options equivalent to standard UI controls. The cursor item is used to select a single item in the hierarchy with a mouse click, and the highlighted item provides visual feedback on the mouse over. Selected items collection is equivalent to checked items in ListView or TreeView controls. The chart's navigation work around the current cursor item. The component shows the cursor and its neighbors regardless of page fit mode. So cursor item plays the role of local zoom in the chart hierarchy. The user navigates around the chart via clicking and selecting cursor items and zooming into data around the new cursor item. The control notifies about this property changes with `onCursorChanging` and `onCursorChanged` events. If the cursor item is set to null, then no cursor item is selected in the diagram. | 
  | `emptyDiagramMessage` | string | `"Diagram is empty."` | Empty diagram message. This option is supposed to say user that chart is empty when no data is available for rendering. | 
  | `enablePanning` | boolean | `true` | Enable panning. Enable chart panning with mouse drag & drop for desktop browsers. Disable it if you need to support items Drag & Drop. | 
  | `hasSelectorCheckbox` | Enabled | `Auto` | Sets visibility of selection check boxes for the diagram nodes. `Auto` - visible for cursor item only `True` - visible `False` - hidden See `selectedItems` property. All items listed in this property are going to have checked selection checkboxes. Checkbox can be added to item template, in that case it should be named="checkbox", so control can use it as built in checkbox element. | 

changelog.md

@@ -1,3 +1,6 @@
+#### Version 6.3.0
+* Added matrixId and addToMatrix properties to FamItemConfig
+* Removed spouses property from FamItemConfig
 #### Version 6.2.2
 * Fixed Family Relations Optimizer
 #### Version 6.2.1

index.html

@@ -350,12 +350,6 @@
               javascript: "samples/javascript.controls/CaseInactiveFamilyItems.html"
             }
           },
-          {
-            label: "Spouses having no children in Family Layout",
-            frameworks: {
-              javascript: "samples/javascript.controls/CaseSpousesInFamilyLayout.html"
-            }
-          },
           {
             label: "Family Relations Bundling",
             frameworks: {