marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-14 21:09:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

document pie useWidth and update other pie config attributes

Browse Source
This commit is contained in:
Yokozuna59
2023-06-18 17:53:28 +03:00
parent f6dc089ddf
commit 1d0aa763de
2 changed files with 24 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/config/setup/modules/defaultConfig.md
View File

@@ -14,7 +14,7 @@
#### Defined in #### Defined in
[defaultConfig.ts:2293](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L2293) [defaultConfig.ts:2308](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L2308)
--- ---

31
packages/mermaid/src/defaultConfig.ts
View File

@@ -1254,28 +1254,43 @@ const config: Partial<MermaidConfig> = {
/** The object containing configurations specific for pie diagrams */ /** The object containing configurations specific for pie diagrams */
pie: { pie: {
useWidth: undefined, /**
* | Parameter | Description | Type | Required | Values |
* | --------- | ----------- | ------ | -------- | ------------------- |
* | useWidth | See Notes | number | Optional | Any positive number |
*
* **Notes:**
*
* Width of the chart.
*
* Default value: 1200
*/
useWidth: 1200,
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | ----------- | ----------- | ------- | -------- | ----------- | * | ----------- | ----------- | ------- | -------- | ----------- |
* | useMaxWidth | See Notes | boolean | Required | true, false | * | useMaxWidth | See Notes | boolean | Optional | true, false |
* *
* **Notes:** * **Notes:**
* *
* When this flag is set to true, the diagram width is locked to 100% and scaled based on * When this flag is set to true, the chart width is locked to 100% and scaled based on
* available space. If set to false, the diagram reserves its absolute width. * available space. If set to false, the chart reserves its absolute width.
* *
* Default value: true * Default value: true
*/ */
useMaxWidth: true, useMaxWidth: true,
/** /**
* | Parameter | Description | Type | Required | Values | * | Parameter | Description | Type | Required | Values |
* | ------------ | -------------------------------------------------------------------------------- | ------- | -------- | ------------------- | * | ------------ | ----------- | ------- | -------- | ------------------- |
* | textPosition | Axial position of slice's label from zero at the center to 1 at the outside edge | Number | Optional | Decimal from 0 to 1 | * | textPosition | See Notes | number | Optional | Decimal from 0 to 1 |
* *
* **Notes:** Default value: 0.75 * **Notes:**
*
* Axial position of slice's label from zero at the center to 1 at the outside edge.
*
* Default value: 0.75
*/ */
textPosition: 0.75, textPosition: 0.75,
}, },