Skip to content

Commit 36cd90d

Browse files
Changed version tag to 5.9.0
1 parent 00d56c2 commit 36cd90d

File tree

7 files changed

+40690
-39632
lines changed

7 files changed

+40690
-39632
lines changed

apireference/enums.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,9 @@ Fits diagram into available screen space. When diagram size significantly larger
212212

213213
| Name | Type | Value | Description |
214214
| --- | --- | --- | --- |
215-
| `AutoSize` | number | `5` | This is opposite mode to auto fit. In this mode diagram controls its size, it sets its size to accomodate all nodes and render them normally. |
215+
| `AutoSize` | number | `5` | This is opposite mode to auto fit. In this mode diagram controls its size, it sets its size to fit all nodes and render them full size using templates. |
216216
| `FitToPage` | number | `3` | Fits diagram into the view so it has no scrollbars. |
217-
| `None` | number | `0` | Disabled. All nodes rendered with their templates. |
217+
| `None` | number | `0` | Disabled. All nodes are being rendered using their templates. |
218218
| `PageHeight` | number | `2` | Fits diagram into the view hight, so it has no vertical scrollbar. |
219219
| `PageWidth` | number | `1` | Fits diagram into the view width, so it has no horizontal scrollbar. |
220220
| `SelectionOnly` | number | `6` | Renders all nodes as markers regardless of available screen space. Control selects and renders full size cursor, its neighbours and selected nodes only. Don't forget to disable selection path as well, so nodes from cursor up to the root are not selected. |

apireference/famdiagram.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,13 @@ Family Chart configuration object. Use this object as a reference for available
6464
| `defaultCalloutTemplateName` | string | `null` | Callout annotation default template name. Templates are HTML fragments containing layout and styles used to render diagram nodes. They are defined with a named configuration objects. See `templates` property of control's configuration object. |
6565
| `showCallout` | boolean | `true` | Sets callout visibility. |
6666

67+
### Frame Properties
68+
| Name | Type | Default | Description |
69+
| --- | --- | --- | --- |
70+
| `frameInnerPadding` | Thickness | `{2, 2, 2, 2}` | Frame inner padding. Adds extra padding around markers on the inner side of the frame. |
71+
| `frameOuterPadding` | Thickness | `{2, 2, 2, 2}` | Frame outer padding. Adds extra padding around markers on the outer side of the frame. |
72+
| `showFrame` | boolean | `false` | Sets selected items frame visibility. If selected item is outside of the diagram's area visible to the end user, control displays that item in the form of the marker on frame around the diagram. |
73+
6774
### Group Titles Properties
6875
| Name | Type | Default | Description |
6976
| --- | --- | --- | --- |

apireference/orgdiagram.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ Organizational Chart configuration object. Use this object as a reference for av
6262
| `defaultCalloutTemplateName` | string | `null` | Callout annotation default template name. Templates are HTML fragments containing layout and styles used to render diagram nodes. They are defined with a named configuration objects. See `templates` property of control's configuration object. |
6363
| `showCallout` | boolean | `true` | Sets callout visibility. |
6464

65+
### Frame Properties
66+
| Name | Type | Default | Description |
67+
| --- | --- | --- | --- |
68+
| `frameInnerPadding` | Thickness | `{2, 2, 2, 2}` | Frame inner padding. Adds extra padding around markers on the inner side of the frame. |
69+
| `frameOuterPadding` | Thickness | `{2, 2, 2, 2}` | Frame outer padding. Adds extra padding around markers on the outer side of the frame. |
70+
| `showFrame` | boolean | `false` | Sets selected items frame visibility. If selected item is outside of the diagram's area visible to the end user, control displays that item in the form of the marker on frame around the diagram. |
71+
6572
### Group Titles Properties
6673
| Name | Type | Default | Description |
6774
| --- | --- | --- | --- |

apireference/structures.md

Lines changed: 74 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,16 @@ Returns rectangle location and size in form of CSS style object.
210210
| --- | --- | --- | --- |
211211
| `units` | string | `"px"` | The string name of units. |
212212

213+
`getProjectionPoint(point)`
214+
215+
Find intersection point between rectangle's permiter and line connecting the given point and center of the rectangle
216+
217+
Returns: `Point` - returns point or null if point is inside rectangle.
218+
219+
| Param | Type | Default | Description |
220+
| --- | --- | --- | --- |
221+
| `point` | Point | `` | Point to project |
222+
213223
`horizontalCenter()`
214224

215225
Horizontal center
@@ -394,15 +404,15 @@ Size object defines width and height.
394404

395405
### Functions
396406

397-
`addSize(size)`
407+
`addThickness(thickness)`
398408

399-
Extends the current size by the other size.
409+
Expands the current size by the thickness object.
400410

401411
Returns: `Size` - returns reference to the current size object
402412

403413
| Param | Type | Default | Description |
404414
| --- | --- | --- | --- |
405-
| `size` | Size | `` | The size to use as extension. |
415+
| `thickness` | Thickness | `` | The thickness to use for expansion. |
406416

407417
`cropBySize(size)`
408418

@@ -431,6 +441,26 @@ Inverts size dimensions
431441
Returns: `Size` - returns reference to the current size.
432442

433443

444+
`maxSize(size)`
445+
446+
Extends the current size by the other size.
447+
448+
Returns: `Size` - returns reference to the current size object
449+
450+
| Param | Type | Default | Description |
451+
| --- | --- | --- | --- |
452+
| `size` | Size | `` | The size to use as extension. |
453+
454+
`removeThickness(thickness)`
455+
456+
Shrinks the current size by the thickness object.
457+
458+
Returns: `Size` - returns reference to the current size object
459+
460+
| Param | Type | Default | Description |
461+
| --- | --- | --- | --- |
462+
| `thickness` | Thickness | `` | The thickness to use for contraction. |
463+
434464
`scale(scale)`
435465

436466
Scales the size by the specified value
@@ -441,6 +471,13 @@ Scales the size by the specified value
441471
| --- | --- | --- | --- |
442472
| `scale` | number | `` | scale |
443473

474+
`space()`
475+
476+
Returns square size
477+
478+
Returns: `number` - returns square size.
479+
480+
444481
`validate()`
445482

446483
Validates size properties
@@ -469,20 +506,50 @@ Class describes the thickness of a frame around rectangle.
469506
### Properties
470507
| Name | Type | Default | Description |
471508
| --- | --- | --- | --- |
472-
| `bottom` | | `bottom` | The thickness for the bottom side of the rectangle. |
473-
| `left` | | `left` | The thickness for the left side of the rectangle. |
474-
| `right` | | `right` | The thickness for the right side of the rectangle. |
475-
| `top` | | `top` | The thickness for the upper side of the rectangle. |
509+
| `bottom` | | `0` | The thickness for the bottom side of the rectangle. |
510+
| `left` | | `0` | The thickness for the left side of the rectangle. |
511+
| `right` | | `0` | The thickness for the right side of the rectangle. |
512+
| `top` | | `0` | The thickness for the upper side of the rectangle. |
476513

477514
### Functions
478515

516+
`addThickness(arg0, arg1, arg2, arg3)`
517+
518+
Add thickness.
519+
520+
Returns: `Thickness` - returns reference to the current thickness object
521+
522+
| Param | Type | Default | Description |
523+
| --- | --- | --- | --- |
524+
| `thickness` | Thickness | `` | The thickness to add. |
525+
479526
`isEmpty()`
480527

481528
Checks object is empty
482529

483530
Returns: `boolean` - returns true if object has no thickness defined for any of its sides
484531

485532

533+
`maxThickness(thickness)`
534+
535+
Maximum thickness.
536+
537+
Returns: `Thickness` - returns reference to the current thickness object
538+
539+
| Param | Type | Default | Description |
540+
| --- | --- | --- | --- |
541+
| `thickness` | Thickness | `` | The thickness to compaire with. |
542+
543+
`scale(scale)`
544+
545+
Scales the thickness by the specified value
546+
547+
Returns: `Thickness` - returns reference to the current size.
548+
549+
| Param | Type | Default | Description |
550+
| --- | --- | --- | --- |
551+
| `scale` | number | `` | scale |
552+
486553
`toString(units)`
487554

488555
Returns thickness object in form of CSS style string. It is conversion to padding style string.

0 commit comments

Comments
 (0)