mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-16 22:09:57 +02:00
Update mermaidAPI.js
-Added tables into the comments from mermaidAPI.md, to reflect documentation that I had added through a previous PR, #1509 -as per @knsv 's directions, added comments here. -also found a list of parameters, who's documentation do not come out in the markdown file. I left them alone, but will be raising a separate issue, for others to review.
This commit is contained in:
@@ -89,14 +89,11 @@ for (const themeName of ['default', 'forest', 'dark', 'neutral']) {
|
|||||||
const config = {
|
const config = {
|
||||||
/** theme , the CSS style sheet
|
/** theme , the CSS style sheet
|
||||||
*
|
*
|
||||||
* **theme** - Choose one of the built-in themes:
|
* theme , the CSS style sheet
|
||||||
* * default
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* * forest
|
*| --- | --- | --- | --- | --- |
|
||||||
* * dark
|
*| Theme |Built in Themes| String | Optional | Values include, default, forest, dark, neutral, null|
|
||||||
* * neutral.
|
***Notes:**To disable any pre-defined mermaid theme, use "null".
|
||||||
* To disable any pre-defined mermaid theme, use "null".
|
|
||||||
*
|
|
||||||
* **themeCSS** - Use your own CSS. This overrides **theme**.
|
|
||||||
* <pre>
|
* <pre>
|
||||||
* "theme": "forest",
|
* "theme": "forest",
|
||||||
* "themeCSS": ".node rect { fill: red; }"
|
* "themeCSS": ".node rect { fill: red; }"
|
||||||
@@ -108,37 +105,58 @@ const config = {
|
|||||||
maxTextSize: 50000,
|
maxTextSize: 50000,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* **fontFamily** The font to be used for the rendered diagrams. Default value is \"trebuchet ms\", verdana, arial;
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*|fontFamily | specifies the font to be used in the rendered diagrams| String | Required | Verdana, Arial, Trebuchet MS,|
|
||||||
|
*
|
||||||
|
***notes: Default value is \\"trebuchet ms\\".
|
||||||
*/
|
*/
|
||||||
fontFamily: '"trebuchet ms", verdana, arial;',
|
fontFamily: '"trebuchet ms", verdana, arial;',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This option decides the amount of logging to be used.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* * debug: 1
|
*| --- | --- | --- | --- | --- |
|
||||||
* * info: 2
|
*| logLevel |This option decides the amount of logging to be used.| String | Required | 1, 2, 3, 4, 5 |
|
||||||
* * warn: 3
|
*
|
||||||
* * error: 4
|
*
|
||||||
* * fatal: (**default**) 5
|
***Notes:**
|
||||||
*/
|
*- debug: 1.
|
||||||
|
*- info: 2.
|
||||||
|
*- warn: 3.
|
||||||
|
*- error: 4.
|
||||||
|
*- fatal: 5(default).
|
||||||
|
*/
|
||||||
logLevel: 5,
|
logLevel: 5,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the level of trust to be used on the parsed diagrams.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* * **strict**: (**default**) tags in text are encoded, click functionality is disabeled
|
*| --- | --- | --- | --- | --- |
|
||||||
* * **loose**: tags in text are allowed, click functionality is enabled
|
*| securitylevel | Level of trust for parsed diagram|String | Required | Strict, Loose |
|
||||||
|
*
|
||||||
|
***Notes:
|
||||||
|
*- **strict**: (**default**) tags in text are encoded, click functionality is disabeled
|
||||||
|
*- **loose**: tags in text are allowed, click functionality is enabled
|
||||||
*/
|
*/
|
||||||
securityLevel: 'strict',
|
securityLevel: 'strict',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This options controls whether or mermaid starts when the page loads
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value true**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| startOnLoad| Dictates whether mermaind starts on Page load | Boolean | Required | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value: true**
|
||||||
*/
|
*/
|
||||||
startOnLoad: true,
|
startOnLoad: true,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This options controls whether or arrow markers in html code will be absolute paths or
|
*| Parameter | Description |Type | Required |Values|
|
||||||
* an anchor, #. This matters if you are using base tag settings.
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value false**.
|
*| arrowMarkerAbsolute | Controls whether or arrow markers in html code are absolute paths or anchors | Boolean | Required | True, False |
|
||||||
|
*
|
||||||
|
*
|
||||||
|
*## Notes**: This matters if you are using base tag settings.
|
||||||
|
***Default value: false**.
|
||||||
*/
|
*/
|
||||||
arrowMarkerAbsolute: false,
|
arrowMarkerAbsolute: false,
|
||||||
|
|
||||||
@@ -147,31 +165,42 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
flowchart: {
|
flowchart: {
|
||||||
/**
|
/**
|
||||||
* Flag for setting whether or not a html tag should be used for rendering labels
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* on the edges.
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value true**.
|
*| htmlLabels | Flag for setting whether or not a html tag should be used for rendering labels on the edges. | Boolean| Required | True, False|
|
||||||
|
*
|
||||||
|
***Notes: Default value: true**.
|
||||||
*/
|
*/
|
||||||
htmlLabels: true,
|
htmlLabels: true,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines the spacing between nodes on the same level (meaning horizontal spacing for
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* TB or BT graphs, and the vertical spacing for LR as well as RL graphs).
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value 50**.
|
*| nodeSpacing | Defines the spacing between nodes on the same level | Integer| Required | Any positive Numbers |
|
||||||
|
*
|
||||||
|
***Notes:
|
||||||
|
*Pertains to horizontal spacing for TB (top to bottom) or BT (bottom to top) graphs, and the vertical spacing for LR as well as RL graphs.**
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
nodeSpacing: 50,
|
nodeSpacing: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines the spacing between nodes on different levels (meaning vertical spacing for
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* TB or BT graphs, and the horizontal spacing for LR as well as RL graphs).
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value 50**.
|
*| rankSpacing | Defines the spacing between nodes on different levels | Integer | Required| Any Positive Numbers |
|
||||||
|
*
|
||||||
|
***Notes: pertains to vertical spacing for TB (top to bottom) or BT (bottom to top), and the horizontal spacing for LR as well as RL graphs.
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
rankSpacing: 50,
|
rankSpacing: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* How mermaid renders curves for flowcharts. Possible values are
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* * basis
|
*| --- | --- | --- | --- | --- |
|
||||||
* * linear **default**
|
*| curve | Defines how mermaid renders curves for flowcharts. | String | Required | Basis, Linear, Cardinal|
|
||||||
* * cardinal
|
*
|
||||||
|
***Notes:
|
||||||
|
*Default Vaue: Linear**
|
||||||
*/
|
*/
|
||||||
curve: 'linear',
|
curve: 'linear',
|
||||||
// Only used in new experimental rendering
|
// Only used in new experimental rendering
|
||||||
@@ -184,105 +213,178 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
sequence: {
|
sequence: {
|
||||||
/**
|
/**
|
||||||
* margin to the right and left of the sequence diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 50**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| diagramMarginX | margin to the right and left of the sequence diagram | Integer | Required | Any Positive Values |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
diagramMarginX: 50,
|
diagramMarginX: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* margin to the over and under the sequence diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 10**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| diagramMarginY | Margin to the over and under the sequence diagram | Integer | Required | Any Positive Values|
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 10**.
|
||||||
*/
|
*/
|
||||||
diagramMarginY: 10,
|
diagramMarginY: 10,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Margin between actors.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 50**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| actorMargin | Margin between actors. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
actorMargin: 50,
|
actorMargin: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Width of actor boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 150**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| width | Width of actor boxes | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 150**.
|
||||||
*/
|
*/
|
||||||
width: 150,
|
width: 150,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Height of actor boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 65**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| height | Height of actor boxes | Integer | Required | Any Positive Value|
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 65**..
|
||||||
*/
|
*/
|
||||||
height: 65,
|
height: 65,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Margin around loop boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 10**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| boxMargin | Margin around loop boxes | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
***Default value 10**.
|
||||||
*/
|
*/
|
||||||
boxMargin: 10,
|
boxMargin: 10,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* margin around the text in loop/alt/opt boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 5**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| boxTextMargin| margin around the text in loop/alt/opt boxes | Integer | Required| Any Positive Value|
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
***Default value 5**.
|
||||||
*/
|
*/
|
||||||
boxTextMargin: 5,
|
boxTextMargin: 5,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* margin around notes.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 10**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| noteMargin | margin around notes. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
***Default value 10**.
|
||||||
*/
|
*/
|
||||||
noteMargin: 10,
|
noteMargin: 10,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Space between messages.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 35**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| messageMargin | Space between messages. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
*Space between messages.
|
||||||
|
***Default value 35**.
|
||||||
*/
|
*/
|
||||||
messageMargin: 35,
|
messageMargin: 35,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Multiline message alignment. Possible values are:
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* * left
|
*| --- | --- | --- | --- | --- |
|
||||||
* * center **default**
|
*| messageAlign | Multiline message alignment | Integer | Required | left, center, right |
|
||||||
* * right
|
*
|
||||||
|
***Notes:**center **default**
|
||||||
*/
|
*/
|
||||||
messageAlign: 'center',
|
messageAlign: 'center',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* mirror actors under diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value true**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| mirrorActors | mirror actors under diagram. | Boolean| Required | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
***Default value true**.
|
||||||
*/
|
*/
|
||||||
mirrorActors: true,
|
mirrorActors: true,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Depending on css styling this might need adjustment.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* Prolongs the edge of the diagram downwards.
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value 1**.
|
*| bottomMarginAdj | Prolongs the edge of the diagram downwards. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**Depending on css styling this might need adjustment.
|
||||||
|
***Default value 1**.
|
||||||
*/
|
*/
|
||||||
bottomMarginAdj: 1,
|
bottomMarginAdj: 1,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* when this flag is set the height and width is set to 100% and is then scaling with the
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* available space if not the absolute space required is used.
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value true**.
|
*| useMaxWidth | See Notes | Boolean | Required | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*when this flag is set to true, the height and width is set to 100% and is then scaling with the
|
||||||
|
*available space. If set to false, the absolute space required is used.
|
||||||
|
***Default value: True**.
|
||||||
*/
|
*/
|
||||||
useMaxWidth: true,
|
useMaxWidth: true,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This will display arrows that start and begin at the same node as right angles, rather than a curve
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value false**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| rightAngles | display curve arrows as right angles| Boolean | Required | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
*This will display arrows that start and begin at the same node as right angles, rather than a curve
|
||||||
|
***Default value false**.
|
||||||
*/
|
*/
|
||||||
rightAngles: false,
|
rightAngles: false,
|
||||||
/**
|
/**
|
||||||
* This will show the node numbers
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value false**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| showSequenceNumbers | This will show the node numbers | Boolean | Required | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value false**.
|
||||||
*/
|
*/
|
||||||
showSequenceNumbers: false,
|
showSequenceNumbers: false,
|
||||||
/**
|
/**
|
||||||
* This sets the font size of the actor's description
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 14**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| actorFontSize| This sets the font size of the actor's description | Integer | Require | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 14**..
|
||||||
*/
|
*/
|
||||||
actorFontSize: 14,
|
actorFontSize: 14,
|
||||||
/**
|
/**
|
||||||
* This sets the font family of the actor's description
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value "Open-Sans", "sans-serif"**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| actorFontFamily |This sets the font family of the actor's description | 3 | 4 | Open-Sans, Sans-Serif |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value "Open-Sans", "sans-serif"**.
|
||||||
*/
|
*/
|
||||||
actorFontFamily: '"Open-Sans", "sans-serif"',
|
actorFontFamily: '"Open-Sans", "sans-serif"',
|
||||||
/**
|
/**
|
||||||
@@ -291,13 +393,21 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
actorFontWeight: 400,
|
actorFontWeight: 400,
|
||||||
/**
|
/**
|
||||||
* This sets the font size of actor-attached notes.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 14**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| noteFontSize |This sets the font size of actor-attached notes. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 14**..
|
||||||
*/
|
*/
|
||||||
noteFontSize: 14,
|
noteFontSize: 14,
|
||||||
/**
|
/**
|
||||||
* This sets the font family of actor-attached notes.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value "trebuchet ms", verdana, arial**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| noteFontFamily| This sets the font family of actor-attached notes. | String | Required | trebuchet ms, verdana, arial |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value: trebuchet ms **.
|
||||||
*/
|
*/
|
||||||
noteFontFamily: '"trebuchet ms", verdana, arial',
|
noteFontFamily: '"trebuchet ms", verdana, arial',
|
||||||
/**
|
/**
|
||||||
@@ -306,18 +416,30 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
noteFontWeight: 400,
|
noteFontWeight: 400,
|
||||||
/**
|
/**
|
||||||
* This sets the text alignment of actor-attached notes.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value center**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| noteAlign | This sets the text alignment of actor-attached notes. | string | required | left, center, right|
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value center**.
|
||||||
*/
|
*/
|
||||||
noteAlign: 'center',
|
noteAlign: 'center',
|
||||||
/**
|
/**
|
||||||
* This sets the font size of actor messages.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 16**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| messageFontSize | This sets the font size of actor messages. | Integer | Required | Any Positive Number |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 16**.
|
||||||
*/
|
*/
|
||||||
messageFontSize: 16,
|
messageFontSize: 16,
|
||||||
/**
|
/**
|
||||||
* This sets the font family of actor messages.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value "trebuchet ms", verdana, arial**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| messageFontFamily | This sets the font family of actor messages. | String| Required | trebuchet ms", verdana, aria |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value:"trebuchet ms**.
|
||||||
*/
|
*/
|
||||||
messageFontFamily: '"trebuchet ms", verdana, arial',
|
messageFontFamily: '"trebuchet ms", verdana, arial',
|
||||||
/**
|
/**
|
||||||
@@ -342,62 +464,107 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
gantt: {
|
gantt: {
|
||||||
/**
|
/**
|
||||||
* Margin top for the text over the gantt diagram
|
*### titleTopMargin
|
||||||
* **Default value 25**.
|
*
|
||||||
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| titleTopMargin | Margin top for the text over the gantt diagram | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 25**.
|
||||||
*/
|
*/
|
||||||
titleTopMargin: 25,
|
titleTopMargin: 25,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The height of the bars in the graph
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 20**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| barHeight | The height of the bars in the graph | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 20**.
|
||||||
*/
|
*/
|
||||||
barHeight: 20,
|
barHeight: 20,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The margin between the different activities in the gantt diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 4**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| barGap | The margin between the different activities in the gantt diagram. | Integer | Optional |Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 4**.
|
||||||
*/
|
*/
|
||||||
barGap: 4,
|
barGap: 4,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Margin between title and gantt diagram and between axis and gantt diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 50**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| topPadding | Margin between title and gantt diagram and between axis and gantt diagram. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
topPadding: 50,
|
topPadding: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The space allocated for the section name to the left of the activities.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 75**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| leftPadding | The space allocated for the section name to the left of the activities. | Integer| Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 75**.
|
||||||
*/
|
*/
|
||||||
leftPadding: 75,
|
leftPadding: 75,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Vertical starting position of the grid lines.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 35**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| gridLineStartPadding | Vertical starting position of the grid lines. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 35**.
|
||||||
*/
|
*/
|
||||||
gridLineStartPadding: 35,
|
gridLineStartPadding: 35,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Font size ...
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 11**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| fontSize | Font size| Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 11**.
|
||||||
*/
|
*/
|
||||||
fontSize: 11,
|
fontSize: 11,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* font family ...
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value '"Open-Sans", "sans-serif"'**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| fontFamily | font Family | string | required |"Open-Sans", "sans-serif" |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
***Default value '"Open-Sans", "sans-serif"'**.
|
||||||
*/
|
*/
|
||||||
fontFamily: '"Open-Sans", "sans-serif"',
|
fontFamily: '"Open-Sans", "sans-serif"',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The number of alternating section styles.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 4**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| numberSectionStyles | The number of alternating section styles | Integer | 4 | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 4**.
|
||||||
*/
|
*/
|
||||||
numberSectionStyles: 4,
|
numberSectionStyles: 4,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Datetime format of the axis. This might need adjustment to match your locale and preferences
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value '%Y-%m-%d'**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| axisFormat | Datetime format of the axis. | 3 | Required | Date in yy-mm-dd |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
* This might need adjustment to match your locale and preferences
|
||||||
|
***Default value '%Y-%m-%d'**.
|
||||||
*/
|
*/
|
||||||
axisFormat: '%Y-%m-%d'
|
axisFormat: '%Y-%m-%d'
|
||||||
},
|
},
|
||||||
@@ -406,84 +573,134 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
journey: {
|
journey: {
|
||||||
/**
|
/**
|
||||||
* margin to the right and left of the sequence diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 50**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| diagramMarginX | margin to the right and left of the sequence diagram | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
diagramMarginX: 50,
|
diagramMarginX: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* margin to the over and under the sequence diagram.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 10**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| diagramMarginY | margin to the over and under the sequence diagram. | Integer | Required | Any Positive Value|
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 10**..
|
||||||
*/
|
*/
|
||||||
diagramMarginY: 10,
|
diagramMarginY: 10,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Margin between actors.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 50**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| actorMargin | Margin between actors. | Integer | Required | Any Positive Value|
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 50**.
|
||||||
*/
|
*/
|
||||||
actorMargin: 50,
|
actorMargin: 50,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Width of actor boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 150**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| width | Width of actor boxes | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 150**.
|
||||||
*/
|
*/
|
||||||
width: 150,
|
width: 150,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Height of actor boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 65**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| height | Height of actor boxes | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 65**.
|
||||||
*/
|
*/
|
||||||
height: 65,
|
height: 65,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Margin around loop boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 10**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| boxMargin | Margin around loop boxes | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 10**.
|
||||||
*/
|
*/
|
||||||
boxMargin: 10,
|
boxMargin: 10,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* margin around the text in loop/alt/opt boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 5**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| boxTextMargin | margin around the text in loop/alt/opt boxes | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
*/
|
*/
|
||||||
boxTextMargin: 5,
|
boxTextMargin: 5,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* margin around notes.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 10**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| noteMargin | margin around notes. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value 10**.
|
||||||
*/
|
*/
|
||||||
noteMargin: 10,
|
noteMargin: 10,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Space between messages.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value 35**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| messageMargin |Space between messages. | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*
|
||||||
|
*Space between messages.
|
||||||
|
***Default value 35**.
|
||||||
*/
|
*/
|
||||||
messageMargin: 35,
|
messageMargin: 35,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Multiline message alignment. Possible values are:
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* * left
|
*| --- | --- | --- | --- | --- |
|
||||||
* * center **default**
|
*| messageAlign |Multiline message alignment | 3 | 4 | left, center, right |
|
||||||
* * right
|
*
|
||||||
|
***Notes:**default:center**
|
||||||
*/
|
*/
|
||||||
messageAlign: 'center',
|
messageAlign: 'center',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Depending on css styling this might need adjustment.
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* Prolongs the edge of the diagram downwards.
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value 1**.
|
*| bottomMarginAdj | Prolongs the edge of the diagram downwards. | Integer | 4 | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**Depending on css styling this might need adjustment.
|
||||||
|
***Default value 1**.
|
||||||
*/
|
*/
|
||||||
bottomMarginAdj: 1,
|
bottomMarginAdj: 1,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* when this flag is set the height and width is set to 100% and is then scaling with the
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* available space if not the absolute space required is used.
|
*| --- | --- | --- | --- | --- |
|
||||||
* **Default value true**.
|
*| useMaxWidth | See notes | Boolean | 4 | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**when this flag is set the height and width is set to 100% and is then scaling with the
|
||||||
|
*available space if not the absolute space required is used.
|
||||||
|
*
|
||||||
|
***Default value true**.
|
||||||
*/
|
*/
|
||||||
useMaxWidth: true,
|
useMaxWidth: true,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This will display arrows that start and begin at the same node as right angles, rather than a curve
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* **Default value false**.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| rightAngles | Curved Arrows become Right Angles, | 3 | 4 | True, False |
|
||||||
|
*
|
||||||
|
***Notes:**This will display arrows that start and begin at the same node as right angles, rather than a curves
|
||||||
|
***Default value false**.
|
||||||
*/
|
*/
|
||||||
rightAngles: false
|
rightAngles: false
|
||||||
},
|
},
|
||||||
@@ -515,43 +732,82 @@ const config = {
|
|||||||
*/
|
*/
|
||||||
er: {
|
er: {
|
||||||
/**
|
/**
|
||||||
* The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| diagramPadding | amount of padding around the diagram as a whole | Integer | Required | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels
|
||||||
|
***Default value: 20**.
|
||||||
*/
|
*/
|
||||||
diagramPadding: 20,
|
diagramPadding: 20,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directional bias for layout of entities. Can be either 'TB', 'BT', 'LR', or 'RL',
|
*| Parameter | Description |Type | Required | Values|
|
||||||
* where T = top, B = bottom, L = left, and R = right.
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| layoutDirection | Directional bias for layout of entities. | String | Required | "TB", "BT","LR","RL" |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
*'TB' for Top-Bottom, 'BT'for Bottom-Top, 'LR' for Left-Right, or 'RL' for Right to Left.
|
||||||
|
* T = top, B = bottom, L = left, and R = right.
|
||||||
|
***Default value: TB **.
|
||||||
*/
|
*/
|
||||||
layoutDirection: 'TB',
|
layoutDirection: 'TB',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The mimimum width of an entity box, expressed in pixels
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| minEntityWidth | The mimimum width of an entity box, | Integer | Required| Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**expressed in pixels
|
||||||
|
***Default value: 100**.
|
||||||
*/
|
*/
|
||||||
minEntityWidth: 100,
|
minEntityWidth: 100,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The minimum height of an entity box, expressed in pixels
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| minEntityHeight| The minimum height of an entity box, | Integer | 4 | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**expressed in pixels
|
||||||
|
***Default value: 75 **
|
||||||
*/
|
*/
|
||||||
minEntityHeight: 75,
|
minEntityHeight: 75,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The minimum internal padding between the text in an entity box and the enclosing box borders, expressed in pixels
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| entityPadding|minimum internal padding betweentext in box and box borders| Integer | 4 | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**The minimum internal padding betweentext in an entity box and the enclosing box borders, expressed in pixels.
|
||||||
|
***Default value: 15 **
|
||||||
*/
|
*/
|
||||||
entityPadding: 15,
|
entityPadding: 15,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stroke color of box edges and lines
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| stroke | Stroke color of box edges and lines | String | 4 | Any recognized color |
|
||||||
|
***Default value: gray **
|
||||||
*/
|
*/
|
||||||
stroke: 'gray',
|
stroke: 'gray',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fill color of entity boxes
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| fill | Fill color of entity boxes | String | 4 | Any recognized color |
|
||||||
|
*
|
||||||
|
***Notes:**
|
||||||
|
***Default value:'honeydew'**
|
||||||
*/
|
*/
|
||||||
fill: 'honeydew',
|
fill: 'honeydew',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Font size (expressed as an integer representing a number of pixels)
|
*| Parameter | Description |Type | Required | Values|
|
||||||
|
*| --- | --- | --- | --- | --- |
|
||||||
|
*| fontSize| Font Size in pixels| Integer | | Any Positive Value |
|
||||||
|
*
|
||||||
|
***Notes:**Font size (expressed as an integer representing a number of pixels)
|
||||||
|
***Default value: 12 **
|
||||||
*/
|
*/
|
||||||
fontSize: 12
|
fontSize: 12
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user