| 6dd74de | | | 1 | > **Warning** |
| 6dd74de | | | 2 | > |
| 6dd74de | | | 3 | > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. |
| 6dd74de | | | 4 | > |
| 6dd74de | | | 5 | > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/quadrantChart.md](../../packages/mermaid/src/docs/syntax/quadrantChart.md). |
| 6dd74de | | | 6 | |
| 6dd74de | | | 7 | # Quadrant Chart |
| 6dd74de | | | 8 | |
| 6dd74de | | | 9 | > A quadrant chart is a visual representation of data that is divided into four quadrants. It is used to plot data points on a two-dimensional grid, with one variable represented on the x-axis and another variable represented on the y-axis. The quadrants are determined by dividing the chart into four equal parts based on a set of criteria that is specific to the data being analyzed. Quadrant charts are often used to identify patterns and trends in data, and to prioritize actions based on the position of data points within the chart. They are commonly used in business, marketing, and risk management, among other fields. |
| 6dd74de | | | 10 | |
| 6dd74de | | | 11 | ## Example |
| 6dd74de | | | 12 | |
| 6dd74de | | | 13 | ```mermaid-example |
| 6dd74de | | | 14 | quadrantChart |
| 6dd74de | | | 15 | title Reach and engagement of campaigns |
| 6dd74de | | | 16 | x-axis Low Reach --> High Reach |
| 6dd74de | | | 17 | y-axis Low Engagement --> High Engagement |
| 6dd74de | | | 18 | quadrant-1 We should expand |
| 6dd74de | | | 19 | quadrant-2 Need to promote |
| 6dd74de | | | 20 | quadrant-3 Re-evaluate |
| 6dd74de | | | 21 | quadrant-4 May be improved |
| 6dd74de | | | 22 | Campaign A: [0.3, 0.6] |
| 6dd74de | | | 23 | Campaign B: [0.45, 0.23] |
| 6dd74de | | | 24 | Campaign C: [0.57, 0.69] |
| 6dd74de | | | 25 | Campaign D: [0.78, 0.34] |
| 6dd74de | | | 26 | Campaign E: [0.40, 0.34] |
| 6dd74de | | | 27 | Campaign F: [0.35, 0.78] |
| 6dd74de | | | 28 | ``` |
| 6dd74de | | | 29 | |
| 6dd74de | | | 30 | ```mermaid |
| 6dd74de | | | 31 | quadrantChart |
| 6dd74de | | | 32 | title Reach and engagement of campaigns |
| 6dd74de | | | 33 | x-axis Low Reach --> High Reach |
| 6dd74de | | | 34 | y-axis Low Engagement --> High Engagement |
| 6dd74de | | | 35 | quadrant-1 We should expand |
| 6dd74de | | | 36 | quadrant-2 Need to promote |
| 6dd74de | | | 37 | quadrant-3 Re-evaluate |
| 6dd74de | | | 38 | quadrant-4 May be improved |
| 6dd74de | | | 39 | Campaign A: [0.3, 0.6] |
| 6dd74de | | | 40 | Campaign B: [0.45, 0.23] |
| 6dd74de | | | 41 | Campaign C: [0.57, 0.69] |
| 6dd74de | | | 42 | Campaign D: [0.78, 0.34] |
| 6dd74de | | | 43 | Campaign E: [0.40, 0.34] |
| 6dd74de | | | 44 | Campaign F: [0.35, 0.78] |
| 6dd74de | | | 45 | ``` |
| 6dd74de | | | 46 | |
| 6dd74de | | | 47 | ## Syntax |
| 6dd74de | | | 48 | |
| 6dd74de | | | 49 | > **Note** |
| 6dd74de | | | 50 | > If there are no points available in the chart both **axis** text and **quadrant** will be rendered in the center of the respective quadrant. |
| 6dd74de | | | 51 | > If there are points **x-axis** labels will rendered from the left of the respective quadrant also they will be displayed at the bottom of the chart, and **y-axis** labels will be rendered at the bottom of the respective quadrant, the quadrant text will render at the top of the respective quadrant. |
| 6dd74de | | | 52 | |
| 6dd74de | | | 53 | > **Note** |
| 6dd74de | | | 54 | > For points x and y value min value is 0 and max value is 1. |
| 6dd74de | | | 55 | |
| 6dd74de | | | 56 | ### Title |
| 6dd74de | | | 57 | |
| 6dd74de | | | 58 | The title is a short description of the chart and it will always render on top of the chart. |
| 6dd74de | | | 59 | |
| 6dd74de | | | 60 | #### Example |
| 6dd74de | | | 61 | |
| 6dd74de | | | 62 | ``` |
| 6dd74de | | | 63 | quadrantChart |
| 6dd74de | | | 64 | title This is a sample example |
| 6dd74de | | | 65 | ``` |
| 6dd74de | | | 66 | |
| 6dd74de | | | 67 | ### x-axis |
| 6dd74de | | | 68 | |
| 6dd74de | | | 69 | The x-axis determines what text would be displayed in the x-axis. In x-axis there is two part **left** and **right** you can pass **both** or you can pass only **left**. The statement should start with `x-axis` then the `left axis text` followed by the delimiter `-->` then `right axis text`. |
| 6dd74de | | | 70 | |
| 6dd74de | | | 71 | #### Example |
| 6dd74de | | | 72 | |
| 6dd74de | | | 73 | 1. `x-axis <text> --> <text>` both the left and right axis text will be rendered. |
| 6dd74de | | | 74 | 2. `x-axis <text>` only the left axis text will be rendered. |
| 6dd74de | | | 75 | |
| 6dd74de | | | 76 | ### y-axis |
| 6dd74de | | | 77 | |
| 6dd74de | | | 78 | The y-axis determines what text would be displayed in the y-axis. In y-axis there is two part **top** and **bottom** you can pass **both** or you can pass only **bottom**. The statement should start with `y-axis` then the `bottom axis text` followed by the delimiter `-->` then `top axis text`. |
| 6dd74de | | | 79 | |
| 6dd74de | | | 80 | #### Example |
| 6dd74de | | | 81 | |
| 6dd74de | | | 82 | 1. `y-axis <text> --> <text>` both the bottom and top axis text will be rendered. |
| 6dd74de | | | 83 | 2. `y-axis <text>` only the bottom axis text will be rendered. |
| 6dd74de | | | 84 | |
| 6dd74de | | | 85 | ### Quadrants text |
| 6dd74de | | | 86 | |
| 6dd74de | | | 87 | The `quadrant-[1,2,3,4]` determine what text would be displayed inside the quadrants. |
| 6dd74de | | | 88 | |
| 6dd74de | | | 89 | #### Example |
| 6dd74de | | | 90 | |
| 6dd74de | | | 91 | 1. `quadrant-1 <text>` determine what text will be rendered inside the top right quadrant. |
| 6dd74de | | | 92 | 2. `quadrant-2 <text>` determine what text will be rendered inside the top left quadrant. |
| 6dd74de | | | 93 | 3. `quadrant-3 <text>` determine what text will be rendered inside the bottom left quadrant. |
| 6dd74de | | | 94 | 4. `quadrant-4 <text>` determine what text will be rendered inside the bottom right quadrant. |
| 6dd74de | | | 95 | |
| 6dd74de | | | 96 | ### Points |
| 6dd74de | | | 97 | |
| 6dd74de | | | 98 | Points are used to plot a circle inside the quadrantChart. The syntax is `<text>: [x, y]` here x and y value is in the range 0 - 1. |
| 6dd74de | | | 99 | |
| 6dd74de | | | 100 | #### Example |
| 6dd74de | | | 101 | |
| 6dd74de | | | 102 | 1. `Point 1: [0.75, 0.80]` here the Point 1 will be drawn in the top right quadrant. |
| 6dd74de | | | 103 | 2. `Point 2: [0.35, 0.24]` here the Point 2 will be drawn in the bottom left quadrant. |
| 6dd74de | | | 104 | |
| 6dd74de | | | 105 | ## Chart Configurations |
| 6dd74de | | | 106 | |
| 6dd74de | | | 107 | | Parameter | Description | Default value | |
| 6dd74de | | | 108 | | --------------------------------- | -------------------------------------------------------------------------------------------------- | :-----------: | |
| 6dd74de | | | 109 | | chartWidth | Width of the chart | 500 | |
| 6dd74de | | | 110 | | chartHeight | Height of the chart | 500 | |
| 6dd74de | | | 111 | | titlePadding | Top and Bottom padding of the title | 10 | |
| 6dd74de | | | 112 | | titleFontSize | Title font size | 20 | |
| 6dd74de | | | 113 | | quadrantPadding | Padding outside all the quadrants | 5 | |
| 6dd74de | | | 114 | | quadrantTextTopPadding | Quadrant text top padding when text is drawn on top ( not data points are there) | 5 | |
| 6dd74de | | | 115 | | quadrantLabelFontSize | Quadrant text font size | 16 | |
| 6dd74de | | | 116 | | quadrantInternalBorderStrokeWidth | Border stroke width inside the quadrants | 1 | |
| 6dd74de | | | 117 | | quadrantExternalBorderStrokeWidth | Quadrant external border stroke width | 2 | |
| 6dd74de | | | 118 | | xAxisLabelPadding | Top and bottom padding of x-axis text | 5 | |
| 6dd74de | | | 119 | | xAxisLabelFontSize | X-axis texts font size | 16 | |
| 6dd74de | | | 120 | | xAxisPosition | Position of x-axis (top , bottom) if there are points the x-axis will always be rendered in bottom | 'top' | |
| 6dd74de | | | 121 | | yAxisLabelPadding | Left and Right padding of y-axis text | 5 | |
| 6dd74de | | | 122 | | yAxisLabelFontSize | Y-axis texts font size | 16 | |
| 6dd74de | | | 123 | | yAxisPosition | Position of y-axis (left , right) | 'left' | |
| 6dd74de | | | 124 | | pointTextPadding | Padding between point and the below text | 5 | |
| 6dd74de | | | 125 | | pointLabelFontSize | Point text font size | 12 | |
| 6dd74de | | | 126 | | pointRadius | Radius of the point to be drawn | 5 | |
| 6dd74de | | | 127 | |
| 6dd74de | | | 128 | ## Chart Theme Variables |
| 6dd74de | | | 129 | |
| 6dd74de | | | 130 | | Parameter | Description | |
| 6dd74de | | | 131 | | -------------------------------- | --------------------------------------- | |
| 6dd74de | | | 132 | | quadrant1Fill | Fill color of the top right quadrant | |
| 6dd74de | | | 133 | | quadrant2Fill | Fill color of the top left quadrant | |
| 6dd74de | | | 134 | | quadrant3Fill | Fill color of the bottom left quadrant | |
| 6dd74de | | | 135 | | quadrant4Fill | Fill color of the bottom right quadrant | |
| 6dd74de | | | 136 | | quadrant1TextFill | Text color of the top right quadrant | |
| 6dd74de | | | 137 | | quadrant2TextFill | Text color of the top left quadrant | |
| 6dd74de | | | 138 | | quadrant3TextFill | Text color of the bottom left quadrant | |
| 6dd74de | | | 139 | | quadrant4TextFill | Text color of the bottom right quadrant | |
| 6dd74de | | | 140 | | quadrantPointFill | Points fill color | |
| 6dd74de | | | 141 | | quadrantPointTextFill | Points text color | |
| 6dd74de | | | 142 | | quadrantXAxisTextFill | X-axis text color | |
| 6dd74de | | | 143 | | quadrantYAxisTextFill | Y-axis text color | |
| 6dd74de | | | 144 | | quadrantInternalBorderStrokeFill | Quadrants inner border color | |
| 6dd74de | | | 145 | | quadrantExternalBorderStrokeFill | Quadrants outer border color | |
| 6dd74de | | | 146 | | quadrantTitleFill | Title color | |
| 6dd74de | | | 147 | |
| 6dd74de | | | 148 | ## Example on config and theme |
| 6dd74de | | | 149 | |
| 6dd74de | | | 150 | ```mermaid-example |
| 6dd74de | | | 151 | --- |
| 6dd74de | | | 152 | config: |
| 6dd74de | | | 153 | quadrantChart: |
| 6dd74de | | | 154 | chartWidth: 400 |
| 6dd74de | | | 155 | chartHeight: 400 |
| 6dd74de | | | 156 | themeVariables: |
| 6dd74de | | | 157 | quadrant1TextFill: "ff0000" |
| 6dd74de | | | 158 | --- |
| 6dd74de | | | 159 | quadrantChart |
| 6dd74de | | | 160 | x-axis Urgent --> Not Urgent |
| 6dd74de | | | 161 | y-axis Not Important --> "Important ❤" |
| 6dd74de | | | 162 | quadrant-1 Plan |
| 6dd74de | | | 163 | quadrant-2 Do |
| 6dd74de | | | 164 | quadrant-3 Delegate |
| 6dd74de | | | 165 | quadrant-4 Delete |
| 6dd74de | | | 166 | ``` |
| 6dd74de | | | 167 | |
| 6dd74de | | | 168 | ```mermaid |
| 6dd74de | | | 169 | --- |
| 6dd74de | | | 170 | config: |
| 6dd74de | | | 171 | quadrantChart: |
| 6dd74de | | | 172 | chartWidth: 400 |
| 6dd74de | | | 173 | chartHeight: 400 |
| 6dd74de | | | 174 | themeVariables: |
| 6dd74de | | | 175 | quadrant1TextFill: "ff0000" |
| 6dd74de | | | 176 | --- |
| 6dd74de | | | 177 | quadrantChart |
| 6dd74de | | | 178 | x-axis Urgent --> Not Urgent |
| 6dd74de | | | 179 | y-axis Not Important --> "Important ❤" |
| 6dd74de | | | 180 | quadrant-1 Plan |
| 6dd74de | | | 181 | quadrant-2 Do |
| 6dd74de | | | 182 | quadrant-3 Delegate |
| 6dd74de | | | 183 | quadrant-4 Delete |
| 6dd74de | | | 184 | ``` |
| 6dd74de | | | 185 | |
| 6dd74de | | | 186 | ### Point styling |
| 6dd74de | | | 187 | |
| 6dd74de | | | 188 | Points can either be styled directly or with defined shared classes |
| 6dd74de | | | 189 | |
| 6dd74de | | | 190 | 1. Direct styling |
| 6dd74de | | | 191 | |
| 6dd74de | | | 192 | ```md |
| 6dd74de | | | 193 | Point A: [0.9, 0.0] radius: 12 |
| 6dd74de | | | 194 | Point B: [0.8, 0.1] color: #ff3300, radius: 10 |
| 6dd74de | | | 195 | Point C: [0.7, 0.2] radius: 25, color: #00ff33, stroke-color: #10f0f0 |
| 6dd74de | | | 196 | Point D: [0.6, 0.3] radius: 15, stroke-color: #00ff0f, stroke-width: 5px ,color: #ff33f0 |
| 6dd74de | | | 197 | ``` |
| 6dd74de | | | 198 | |
| 6dd74de | | | 199 | 2. Classes styling |
| 6dd74de | | | 200 | |
| 6dd74de | | | 201 | ```md |
| 6dd74de | | | 202 | Point A:::class1: [0.9, 0.0] |
| 6dd74de | | | 203 | Point B:::class2: [0.8, 0.1] |
| 6dd74de | | | 204 | Point C:::class3: [0.7, 0.2] |
| 6dd74de | | | 205 | Point D:::class3: [0.7, 0.2] |
| 6dd74de | | | 206 | classDef class1 color: #109060 |
| 6dd74de | | | 207 | classDef class2 color: #908342, radius : 10, stroke-color: #310085, stroke-width: 10px |
| 6dd74de | | | 208 | classDef class3 color: #f00fff, radius : 10 |
| 6dd74de | | | 209 | ``` |
| 6dd74de | | | 210 | |
| 6dd74de | | | 211 | #### Available styles: |
| 6dd74de | | | 212 | |
| 6dd74de | | | 213 | | Parameter | Description | |
| 6dd74de | | | 214 | | ------------ | ---------------------------------------------------------------------- | |
| 6dd74de | | | 215 | | color | Fill color of the point | |
| 6dd74de | | | 216 | | radius | Radius of the point | |
| 6dd74de | | | 217 | | stroke-width | Border width of the point | |
| 6dd74de | | | 218 | | stroke-color | Border color of the point (useless when stroke-width is not specified) | |
| 6dd74de | | | 219 | |
| 6dd74de | | | 220 | > **Note** |
| 6dd74de | | | 221 | > Order of preference: |
| 6dd74de | | | 222 | > |
| 6dd74de | | | 223 | > 1. Direct styles |
| 6dd74de | | | 224 | > 2. Class styles |
| 6dd74de | | | 225 | > 3. Theme styles |
| 6dd74de | | | 226 | |
| 6dd74de | | | 227 | ## Example on styling |
| 6dd74de | | | 228 | |
| 6dd74de | | | 229 | ```mermaid-example |
| 6dd74de | | | 230 | quadrantChart |
| 6dd74de | | | 231 | title Reach and engagement of campaigns |
| 6dd74de | | | 232 | x-axis Low Reach --> High Reach |
| 6dd74de | | | 233 | y-axis Low Engagement --> High Engagement |
| 6dd74de | | | 234 | quadrant-1 We should expand |
| 6dd74de | | | 235 | quadrant-2 Need to promote |
| 6dd74de | | | 236 | quadrant-3 Re-evaluate |
| 6dd74de | | | 237 | quadrant-4 May be improved |
| 6dd74de | | | 238 | Campaign A: [0.9, 0.0] radius: 12 |
| 6dd74de | | | 239 | Campaign B:::class1: [0.8, 0.1] color: #ff3300, radius: 10 |
| 6dd74de | | | 240 | Campaign C: [0.7, 0.2] radius: 25, color: #00ff33, stroke-color: #10f0f0 |
| 6dd74de | | | 241 | Campaign D: [0.6, 0.3] radius: 15, stroke-color: #00ff0f, stroke-width: 5px ,color: #ff33f0 |
| 6dd74de | | | 242 | Campaign E:::class2: [0.5, 0.4] |
| 6dd74de | | | 243 | Campaign F:::class3: [0.4, 0.5] color: #0000ff |
| 6dd74de | | | 244 | classDef class1 color: #109060 |
| 6dd74de | | | 245 | classDef class2 color: #908342, radius : 10, stroke-color: #310085, stroke-width: 10px |
| 6dd74de | | | 246 | classDef class3 color: #f00fff, radius : 10 |
| 6dd74de | | | 247 | ``` |
| 6dd74de | | | 248 | |
| 6dd74de | | | 249 | ```mermaid |
| 6dd74de | | | 250 | quadrantChart |
| 6dd74de | | | 251 | title Reach and engagement of campaigns |
| 6dd74de | | | 252 | x-axis Low Reach --> High Reach |
| 6dd74de | | | 253 | y-axis Low Engagement --> High Engagement |
| 6dd74de | | | 254 | quadrant-1 We should expand |
| 6dd74de | | | 255 | quadrant-2 Need to promote |
| 6dd74de | | | 256 | quadrant-3 Re-evaluate |
| 6dd74de | | | 257 | quadrant-4 May be improved |
| 6dd74de | | | 258 | Campaign A: [0.9, 0.0] radius: 12 |
| 6dd74de | | | 259 | Campaign B:::class1: [0.8, 0.1] color: #ff3300, radius: 10 |
| 6dd74de | | | 260 | Campaign C: [0.7, 0.2] radius: 25, color: #00ff33, stroke-color: #10f0f0 |
| 6dd74de | | | 261 | Campaign D: [0.6, 0.3] radius: 15, stroke-color: #00ff0f, stroke-width: 5px ,color: #ff33f0 |
| 6dd74de | | | 262 | Campaign E:::class2: [0.5, 0.4] |
| 6dd74de | | | 263 | Campaign F:::class3: [0.4, 0.5] color: #0000ff |
| 6dd74de | | | 264 | classDef class1 color: #109060 |
| 6dd74de | | | 265 | classDef class2 color: #908342, radius : 10, stroke-color: #310085, stroke-width: 10px |
| 6dd74de | | | 266 | classDef class3 color: #f00fff, radius : 10 |
| 6dd74de | | | 267 | ``` |