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

Fix formatting in doc file

Browse Source
This commit is contained in:
Subhash Halder
2023-09-19 21:18:06 +05:30
parent e56effa029
commit f01f2dfcef
2 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/syntax/xyChart.md
View File

@@ -42,7 +42,7 @@ The chart can be drawn horizontal or vertical, default value is vertical.
xychart-beta horizontal xychart-beta horizontal
... ...
### Title. ### Title
The title is a short description of the chart and it will always render on top of the chart. The title is a short description of the chart and it will always render on top of the chart.

12
packages/mermaid/src/docs/syntax/xyChart.md
View File

@@ -23,7 +23,7 @@ All text values that contain only one word can be written without `"`. If a text
### Orientations ### Orientations
The chart can be drawn horizontal or vertical, default value is vertical The chart can be drawn horizontal or vertical, default value is vertical.
``` ```
xychart-beta horizontal xychart-beta horizontal
@@ -57,7 +57,7 @@ The x-axis primarily serves as a categorical value, although it can also functio
### y-axis ### y-axis
The y-axis is employed to represent numerical range values, it can't have categorical values. The y-axis is employed to represent numerical range values, it cannot have categorical values.
#### Example #### Example
@@ -86,7 +86,7 @@ A bar chart offers the capability to graphically depict bars.
#### Simplest example #### Simplest example
Every grammer are optional other than the chart name and one data set, so you will be able to draw a chart will a simple config like The only two things required are the chart name (`xychart-beta`) and one data set. So you will be able to draw a chart with a simple config like
``` ```
xychart-beta xychart-beta
@@ -104,7 +104,7 @@ xychart-beta
| showTitle | Title to be shown or not | true | | showTitle | Title to be shown or not | true |
| xAxis | xAxis configuration | AxisConfig | | xAxis | xAxis configuration | AxisConfig |
| yAxis | yAxis configuration | AxisConfig | | yAxis | yAxis configuration | AxisConfig |
| chartOrientation | ('vertical' or 'horizontal') | 'vertical' | | chartOrientation | 'vertical' or 'horizontal' | 'vertical' |
| plotReservedSpacePercent | Minimum space plots will take inside the chart | 50 | | plotReservedSpacePercent | Minimum space plots will take inside the chart | 50 |
### AxisConfig ### AxisConfig
@@ -131,7 +131,7 @@ Themes for xychart resides inside xychart attribute so to set the variables use
``` ```
| Parameter | Description | | Parameter | Description |
| ---------------- | ------------------------------------------------------- | | ---------------- | --------------------------------------------------------- |
| backgroundColor | Background color of the whole chart | | backgroundColor | Background color of the whole chart |
| titleColor | Color of the Title text | | titleColor | Color of the Title text |
| xAxisLableColor | Color of the x-axis labels | | xAxisLableColor | Color of the x-axis labels |
@@ -142,7 +142,7 @@ Themes for xychart resides inside xychart attribute so to set the variables use
| yAxisTitleColor | Color of the y-axis title | | yAxisTitleColor | Color of the y-axis title |
| yAxisTickColor | Color of the y-axis tick | | yAxisTickColor | Color of the y-axis tick |
| yAxisLineColor | Color of the y-axis line | | yAxisLineColor | Color of the y-axis line |
| plotColorPalette | String of colors seperated by comma eg "#f3456, #43445" | | plotColorPalette | String of colors separated by comma e.g. "#f3456, #43445" |
## Example on config and theme ## Example on config and theme