mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-03 20:34:20 +01:00 
			
		
		
		
	chore: Review comments
This commit is contained in:
		@@ -18,9 +18,69 @@ Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
 | 
			
		||||
 | 
			
		||||
• `Const` **mermaidAPI**: `Readonly`<{ `defaultConfig`: `MermaidConfig` = configApi.defaultConfig; `getConfig`: () => `MermaidConfig` = configApi.getConfig; `getSiteConfig`: () => `MermaidConfig` = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`options`: `MermaidConfig`) => `Promise`<`void`> ; `parse`: (`text`: `string`, `parseError?`: `ParseErrorFunction`) => `boolean` ; `parseDirective`: (`p`: `any`, `statement`: `string`, `context`: `string`, `type`: `string`) => `void` ; `render`: (`id`: `string`, `text`: `string`, `cb`: (`svgCode`: `string`, `bindFunctions?`: (`element`: `Element`) => `void`) => `void`, `container?`: `Element`) => `Promise`<`void`> ; `reset`: () => `void` ; `setConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.setConfig; `updateSiteConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.updateSiteConfig }>
 | 
			
		||||
 | 
			
		||||
## mermaidAPI configuration defaults
 | 
			
		||||
 | 
			
		||||
```ts
 | 
			
		||||
const config = {
 | 
			
		||||
  theme: 'default',
 | 
			
		||||
  logLevel: 'fatal',
 | 
			
		||||
  securityLevel: 'strict',
 | 
			
		||||
  startOnLoad: true,
 | 
			
		||||
  arrowMarkerAbsolute: false,
 | 
			
		||||
 | 
			
		||||
  er: {
 | 
			
		||||
    diagramPadding: 20,
 | 
			
		||||
    layoutDirection: 'TB',
 | 
			
		||||
    minEntityWidth: 100,
 | 
			
		||||
    minEntityHeight: 75,
 | 
			
		||||
    entityPadding: 15,
 | 
			
		||||
    stroke: 'gray',
 | 
			
		||||
    fill: 'honeydew',
 | 
			
		||||
    fontSize: 12,
 | 
			
		||||
    useMaxWidth: true,
 | 
			
		||||
  },
 | 
			
		||||
  flowchart: {
 | 
			
		||||
    diagramPadding: 8,
 | 
			
		||||
    htmlLabels: true,
 | 
			
		||||
    curve: 'basis',
 | 
			
		||||
  },
 | 
			
		||||
  sequence: {
 | 
			
		||||
    diagramMarginX: 50,
 | 
			
		||||
    diagramMarginY: 10,
 | 
			
		||||
    actorMargin: 50,
 | 
			
		||||
    width: 150,
 | 
			
		||||
    height: 65,
 | 
			
		||||
    boxMargin: 10,
 | 
			
		||||
    boxTextMargin: 5,
 | 
			
		||||
    noteMargin: 10,
 | 
			
		||||
    messageMargin: 35,
 | 
			
		||||
    messageAlign: 'center',
 | 
			
		||||
    mirrorActors: true,
 | 
			
		||||
    bottomMarginAdj: 1,
 | 
			
		||||
    useMaxWidth: true,
 | 
			
		||||
    rightAngles: false,
 | 
			
		||||
    showSequenceNumbers: false,
 | 
			
		||||
  },
 | 
			
		||||
  gantt: {
 | 
			
		||||
    titleTopMargin: 25,
 | 
			
		||||
    barHeight: 20,
 | 
			
		||||
    barGap: 4,
 | 
			
		||||
    topPadding: 50,
 | 
			
		||||
    leftPadding: 75,
 | 
			
		||||
    gridLineStartPadding: 35,
 | 
			
		||||
    fontSize: 11,
 | 
			
		||||
    fontFamily: '"Open Sans", sans-serif',
 | 
			
		||||
    numberSectionStyles: 4,
 | 
			
		||||
    axisFormat: '%Y-%m-%d',
 | 
			
		||||
    topAxis: false,
 | 
			
		||||
  },
 | 
			
		||||
};
 | 
			
		||||
mermaid.initialize(config);
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
#### Defined in
 | 
			
		||||
 | 
			
		||||
mermaidAPI.ts:485
 | 
			
		||||
mermaidAPI.ts:546
 | 
			
		||||
 | 
			
		||||
## Functions
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user