marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-11-14 17:54:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

tsConversion: mermaidAPI

Browse Source
This commit is contained in:
Sidharth Vinod
2022-08-22 11:10:30 +05:30
parent 39aaf2f813
commit d365dacbf7
16 changed files with 776 additions and 760 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/Setup.md
View File

@@ -1402,15 +1402,6 @@ This sets the auto-wrap padding for the diagram (sides only)
**Notes:** Default value: 0.
## parse
### Parameters
- `text`
- `dia`
Returns **any**
## setSiteConfig
## setSiteConfig
@@ -1460,18 +1451,6 @@ corresponding siteConfig value.
Returns **any** The currentConfig merged with the sanitized conf
## getConfig
## getConfig
| Function | Description | Type | Return Values |
| --------- | ------------------------- | ----------- | ------------------------------ |
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
**Notes**: Returns **any** the currentConfig
Returns **any** The currentConfig
## render
Function that renders an svg with a graph from a chart definition. Usage example below.
@@ -1492,7 +1471,7 @@ $(function () {
### Parameters
- `id` **any** The id of the element to be rendered
- `_txt` **any** The graph definition
- `text` **any** The graph definition
- `cb` **any** Callback which is called after rendering is finished with the svg code as inparam.
- `container` **any** Selector to element in which a div with the graph temporarily will be
inserted. In one is provided a hidden div will be inserted in the body of the page instead. The
@@ -1500,6 +1479,18 @@ $(function () {
Returns **any**
## getConfig
## getConfig
| Function | Description | Type | Return Values |
| --------- | ------------------------- | ----------- | ------------------------------ |
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
**Notes**: Returns **any** the currentConfig
Returns **any** The currentConfig
## sanitize
## sanitize
@@ -1539,19 +1530,17 @@ Pushes in a directive to the configuration
**Notes**: (default: current siteConfig ) (optional, default `getSiteConfig()`)
Returns **void**
## updateRendererConfigs
### Parameters
- `conf` **any**
- `config` (optional, default `siteConfig`)
Returns **void**
## initialize
### Parameters
- `options` **any**
- `options` **MermaidConfig**
##