Skip to content

Commit 1d5ffec

Browse files
Updated api reference and samples
1 parent e964f95 commit 1d5ffec

File tree

10 files changed

+65
-51
lines changed

10 files changed

+65
-51
lines changed

apireference/famdiagram.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Family Chart configuration object. Use this object as a reference for available
4040
| `enableMatrixLayout` | boolean | `false` | This option enables automatic layout of nodes sharing the same set of parents and children in form of matrix. |
4141
| `groupByType` | GroupByType | `2` | This property sets loose nodes alignment between rows. Nodes can be placed close towards parents or children. |
4242
| `hideGrandParentsConnectors` | boolean | `false` | Set this property to enable hiding of direct connectors to grand parents. It helps to reduce diagrams connectors layout complexity. |
43-
| `loopsLayoutMode` | LoopsLayoutMode | `primitives.common.LoopsLayoutMode.Optimized` | Loops layout mode. Configuration may contain loop references between items, so control tries to find layout minimizing number of loops between levels, so majority of references ideally should go in one direction. This option disables optimization and forces items levels order to match their order in `items` collection. For example if you have two nodes `A` and `B` referencing each other as a parent, then it is not defined which one is going to be on the top of the diagram. Set this option to `KeepItemsOrder`, if you need the first item in your collection to be on the top, otherwise control will optimize loops layout in order to minimize number of loops in diagram. |
43+
| `loopsLayoutMode` | LoopsLayoutMode | `0` | Loops layout mode. Configuration may contain loop references between items, so control tries to find layout minimizing number of loops between levels, so majority of references ideally should go in one direction. This option disables optimization and forces items levels order to match their order in `items` collection. For example if you have two nodes `A` and `B` referencing each other as a parent, then it is not defined which one is going to be on the top of the diagram. Set this option to `KeepItemsOrder`, if you need the first item in your collection to be on the top, otherwise control will optimize loops layout in order to minimize number of loops in diagram. |
4444
| `maximumColumnsInMatrix` | number | `6` | Sets maximum number of columns in the matrix formation. The matrix formation stays squared as long as total number of columns does not exceed this property value. In order to shape nodes into matrix formation they should share the same set of parents and children. See `enableMatrixLayout` property. |
4545
| `minimalVisibility` | Visibility | `2` | Minimal nodes visibility in the diagram. If auto fit of the diagram into current page size is enabled, then this option controls minimum allowed size of the diagram nodes. |
4646
| `minimumMatrixSize` | number | `4` | Sets Minimum number of nodes needed to be shaped into matrix formtion. In order to shape nodes in form of matrix they should share the same set of parents and children. See `enableMatrixLayout` property. |

apireference/orgdiagram.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Item Configuration Object defines properties of individual node in the organizat
256256
| --- | --- | --- | --- |
257257
| `arg0` | ItemConfig | `` | Item config properties |
258258
| `arg0` | string | `` | Item id |
259-
| `arg1` | string[] | `` | Parent id |
259+
| `arg1` | string | `` | Parent id |
260260
| `arg2` | string | `` | Title |
261261
| `arg3` | string | `` | Description |
262262
| `arg4` | string | `` | Image |

min/primitives.latest.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7630,7 +7630,7 @@ primitives.famdiagram.Config = function (name) {
76307630
* @group Auto Layout
76317631
* @type {LoopsLayoutMode}
76327632
*/
7633-
this.loopsLayoutMode = primitives.common.LoopsLayoutMode.Optimized;
7633+
this.loopsLayoutMode = 0/*primitives.common.LoopsLayoutMode.Optimized*/;
76347634

76357635
/**
76367636
* Sets arrows direction for connector lines. If this property set to `Parents` then arrows are drawn
@@ -12972,7 +12972,7 @@ primitives.famdiagram.RemoveLoopsTask = function (itemsOptionTask, removeLoopsOp
1297212972
edgesToReverse = getInOrderLoops(items, logicalFamily),
1297312973
fakePairs = [];
1297412974

12975-
if (edgesToReverse.length > 1 && loopsLayoutMode == primitives.common.LoopsLayoutMode.Optimized) {
12975+
if (edgesToReverse.length > 1 && loopsLayoutMode == 0/*primitives.common.LoopsLayoutMode.Optimized*/) {
1297612976
edgesToReverse = primitives.common.getFamilyLoops(logicalFamily, debug);
1297712977
}
1297812978

@@ -15001,7 +15001,7 @@ primitives.orgdiagram.HighlightPathAnnotationConfig = function (arg0) {
1500115001
* @param {ItemConfig} arg0 Item config properties
1500215002
*
1500315003
* @param {string} arg0 Item id
15004-
* @param {string[]} arg1 Parent id
15004+
* @param {string} arg1 Parent id
1500515005
* @param {string} arg2 Title
1500615006
* @param {string} arg3 Description
1500715007
* @param {string} arg4 Image

0 commit comments

Comments
 (0)