[draft] Added support for quadrant chart

This commit is contained in:
Subhash Halder 2023-05-08 19:21:49 +05:30
parent 2dc780a766
commit 272ccded93
17 changed files with 1087 additions and 1 deletions

View File

@ -54,6 +54,9 @@
<li>
<h2><a href="./pie.html">Pie</a></h2>
</li>
<li>
<h2><a href="./quadrantchart.html">Quadrant charts</a></h2>
</li>
<li>
<h2><a href="./requirements.html">Requirements</a></h2>
</li>

54
demos/quadrantchart.html Normal file
View File

@ -0,0 +1,54 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Mermaid Quick Test Page</title>
<link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgo=" />
<style>
div.mermaid {
/* font-family: 'trebuchet ms', verdana, arial; */
font-family: 'Courier New', Courier, monospace !important;
}
</style>
</head>
<body>
<h1>Quadrant chart demos</h1>
<pre class="mermaid">
%%{init: {"quadrantChart": {"quadrantPadding": 10}, "theme": "forest", "themeVariables": {"quadrant1TextFill": "blue"}} }%%
quadrantChart
x-axis Urgent --> Not Urgent
y-axis Not Important --> important
quadrant-1 Plan
quadrant-2 Do
quadrant-3 Deligate
quadrant-4 Delete
</pre>
<pre class="mermaid">
%%{init: {"quadrantChart": {"xAxisPosition": "bottom"} } }%%
quadrantChart
x-axis "Completeness of Vision ❤"
y-axis Ability to Execute
quadrant-1 Leaders
quadrant-2 Challengers
quadrant-3 Niche
quadrant-4 Visionaries
Microsoft: [0.75, 0.75]
Salesforce: [0.55, 0.60]
IBM: [0.51, 0.40]
Incorta: [0.20, 0.30]
</pre>
<hr />
<script type="module">
import mermaid from './mermaid.esm.mjs';
mermaid.initialize({
theme: 'default',
logLevel: 1,
securityLevel: 'loose',
});
</script>
</body>
</html>

View File

@ -27,6 +27,7 @@ export interface MermaidConfig {
state?: StateDiagramConfig;
er?: ErDiagramConfig;
pie?: PieDiagramConfig;
quadrantChart?: QuadrantChartConfig;
requirement?: RequirementDiagramConfig;
mindmap?: MindmapDiagramConfig;
gitGraph?: GitGraphDiagramConfig;
@ -226,6 +227,21 @@ export interface PieDiagramConfig extends BaseDiagramConfig {
textPosition?: number;
}
export interface QuadrantChartConfig extends BaseDiagramConfig {
quadrantPadding?: number;
xAxisLabelPadding?: number;
yAxisLabelPadding?: number;
xAxisLabelFontSize?: number;
yAxisLabelFontSize?: number;
quadrantLabelFontSize: number;
quadrantTextTopPadding: number;
pointTextPadding: number;
pointLabelFontSize: number;
pointRadius: number;
xAxisPosition: 'top' | 'bottom';
yAxisPosition: 'left' | 'right';
}
export interface ErDiagramConfig extends BaseDiagramConfig {
titleTopMargin?: number;
diagramPadding?: number;

View File

@ -1280,6 +1280,117 @@ const config: Partial<MermaidConfig> = {
textPosition: 0.75,
},
quadrantChart: {
/**
* | Parameter | Description | Type | Required | Values |
* | --------------- | ---------------------------------- | ------- | -------- | ------------------- |
* | quadrantPadding | Padding around the quadrant square | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 5
*/
quadrantPadding: 5,
/**
* | Parameter | Description | Type | Required | Values |
* | --------------- | ---------------------------------- | ------- | -------- | ------------------- |
* | xAxisLabelPadding | Padding around x-axis labels | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 5
*/
xAxisLabelPadding: 5,
/**
* | Parameter | Description | Type | Required | Values |
* | --------------- | ---------------------------------- | ------- | -------- | ------------------- |
* | yAxisLabelPadding | Padding around y-axis labels | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 5
*/
yAxisLabelPadding: 5,
/**
* | Parameter | Description | Type | Required | Values |
* | ------------------ | ---------------------------------- | ------- | -------- | ------------------- |
* | xAxisLabelFontSize | x-axis label font size | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 16
*/
xAxisLabelFontSize: 16,
/**
* | Parameter | Description | Type | Required | Values |
* | ------------------ | ---------------------------------- | ------- | -------- | ------------------- |
* | yAxisLabelFontSize | y-axis label font size | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 16
*/
yAxisLabelFontSize: 16,
/**
* | Parameter | Description | Type | Required | Values |
* | ------------------ | ---------------------------------- | ------- | -------- | ------------------- |
* | quadrantLabelFontSize | quadrant title font size | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 16
*/
quadrantLabelFontSize: 16,
/**
* | Parameter | Description | Type | Required | Values |
* | ---------------------- | -------------------------------------------------------------------------- | ------- | -------- | ------------------- |
* | quadrantTextTopPadding | quadrant title padding from top if the quadrant is rendered on top | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 5
*/
quadrantTextTopPadding: 5,
/**
* | Parameter | Description | Type | Required | Values |
* | ---------------------- | -------------------------------------- | ------- | -------- | ------------------- |
* | pointTextPadding | padding between point and point label | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 5
*/
pointTextPadding: 5,
/**
* | Parameter | Description | Type | Required | Values |
* | ---------------------- | ---------------------- | ------- | -------- | ------------------- |
* | pointTextPadding | point title font size | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 12
*/
pointLabelFontSize: 12,
/**
* | Parameter | Description | Type | Required | Values |
* | ------------- | ------------------------------- | ------- | -------- | ------------------- |
* | pointRadius | radius of the point to be drawn | number | Optional | Any positive number |
*
* **Notes:**
* Default value: 5
*/
pointRadius: 5,
/**
* | Parameter | Description | Type | Required | Values |
* | ------------- | ------------------------------- | ------- | -------- | ------------------- |
* | xAxisPosition | position of x-axis labels | string | Optional | 'top' or 'bottom' |
*
* **Notes:**
* Default value: top
*/
xAxisPosition: 'top',
/**
* | Parameter | Description | Type | Required | Values |
* | ------------- | ------------------------------- | ------- | -------- | ------------------- |
* | yAxisPosition | position of y-axis labels | string | Optional | 'left' or 'right' |
*
* **Notes:**
* Default value: left
*/
yAxisPosition: 'left',
},
/** The object containing configurations specific for req diagrams */
requirement: {
useWidth: undefined,

View File

@ -6,6 +6,7 @@ import git from '../diagrams/git/gitGraphDetector.js';
import gantt from '../diagrams/gantt/ganttDetector.js';
import info from '../diagrams/info/infoDetector.js';
import pie from '../diagrams/pie/pieDetector.js';
import quadrantChart from '../diagrams/quadrant-chart/quadrantDetector.js';
import requirement from '../diagrams/requirement/requirementDetector.js';
import sequence from '../diagrams/sequence/sequenceDetector.js';
import classDiagram from '../diagrams/class/classDetector.js';
@ -77,6 +78,7 @@ export const addDiagrams = () => {
git,
stateV2,
state,
journey
journey,
quadrantChart
);
};

View File

@ -0,0 +1,248 @@
/** mermaid
* https://knsv.github.io/mermaid
* (c) 2015 Knut Sveidqvist
* MIT license.
*/
%lex
%options case-insensitive
%x string
%x string
%x md_string
%x title
%x open_directive
%x type_directive
%x arg_directive
%x close_directive
%x acc_title
%x acc_descr
%x acc_descr_multiline
%x point_start
%x point_x
%x point_y
%%
\%\%\{ { this.begin('open_directive'); return 'open_directive'; }
<open_directive>((?:(?!\}\%\%)[^:.])*) { this.begin('type_directive'); return 'type_directive'; }
<type_directive>":" { this.popState(); this.begin('arg_directive'); return ':'; }
<type_directive,arg_directive>\}\%\% { this.popState(); this.popState(); return 'close_directive'; }
<arg_directive>((?:(?!\}\%\%).|\n)*) return 'arg_directive';
\%\%(?!\{)[^\n]* /* skip comments */
[^\}]\%\%[^\n]* /* skip comments */
[\n\r]+ return 'NEWLINE';
\%\%[^\n]* /* do nothing */
title { this.begin("title");return 'title'; }
<title>(?!\n|;|#)*[^\n]* { this.popState(); return "title_value"; }
accTitle\s*":"\s* { this.begin("acc_title");return 'acc_title'; }
<acc_title>(?!\n|;|#)*[^\n]* { this.popState(); return "acc_title_value"; }
accDescr\s*":"\s* { this.begin("acc_descr");return 'acc_descr'; }
<acc_descr>(?!\n|;|#)*[^\n]* { this.popState(); return "acc_descr_value"; }
accDescr\s*"{"\s* { this.begin("acc_descr_multiline");}
<acc_descr_multiline>[\}] { this.popState(); }
<acc_descr_multiline>[^\}]* return "acc_descr_multiline_value";
\s*"x-axis"\s* return 'X-AXIS';
\s*"y-axis"\s* return 'Y-AXIS';
\s*\-\-\>\s* return 'AXIS-TEXT-DELIMITER'
\s*"quadrant-1"\s* return 'QUADRANT_1';
\s*"quadrant-2"\s* return 'QUADRANT_2';
\s*"quadrant-3"\s* return 'QUADRANT_3';
\s*"quadrant-4"\s* return 'QUADRANT_4';
["][`] { this.begin("md_string");}
<md_string>[^`"]+ { return "MD_STR";}
<md_string>[`]["] { this.popState();}
["] this.begin("string");
<string>["] this.popState();
<string>[^"]* return "STR";
\s*\:\s*\[\s* {this.begin("point_start"); return 'point_start';}
<point_start>(1)|(0(.\d+)?) {this.begin('point_x'); return 'point_x';}
<point_start>\s*\] {this.popState();}
<point_x>\s*\,\s* {this.popState(); this.begin('point_y');}
<point_y>(1)|(0(.\d+)?) {this.popState(); return 'point_y';}
"quadrantChart"\s* return 'QUADRANT';
\[[0-1].?[0-9]{5}\] return 'POINT_VALUE'
[A-Za-z]+ return 'ALPHA';
":" return 'COLON';
\+ return 'PLUS';
"," return 'COMMA';
"=" return 'EQUALS';
\= return 'EQUALS';
"*" return 'MULT';
\# return 'BRKT';
[\_] return 'UNDERSCORE';
"." return 'DOT';
"&" return 'AMP';
\- return 'MINUS';
[0-9]+ return 'NUM';
\s return 'SPACE';
";" return 'SEMI';
[!"#$%&'*+,-.`?\\_/] return 'PUNCTUATION';
[\u00AA\u00B5\u00BA\u00C0-\u00D6\u00D8-\u00F6]|
[\u00F8-\u02C1\u02C6-\u02D1\u02E0-\u02E4\u02EC\u02EE\u0370-\u0374\u0376\u0377]|
[\u037A-\u037D\u0386\u0388-\u038A\u038C\u038E-\u03A1\u03A3-\u03F5]|
[\u03F7-\u0481\u048A-\u0527\u0531-\u0556\u0559\u0561-\u0587\u05D0-\u05EA]|
[\u05F0-\u05F2\u0620-\u064A\u066E\u066F\u0671-\u06D3\u06D5\u06E5\u06E6\u06EE]|
[\u06EF\u06FA-\u06FC\u06FF\u0710\u0712-\u072F\u074D-\u07A5\u07B1\u07CA-\u07EA]|
[\u07F4\u07F5\u07FA\u0800-\u0815\u081A\u0824\u0828\u0840-\u0858\u08A0]|
[\u08A2-\u08AC\u0904-\u0939\u093D\u0950\u0958-\u0961\u0971-\u0977]|
[\u0979-\u097F\u0985-\u098C\u098F\u0990\u0993-\u09A8\u09AA-\u09B0\u09B2]|
[\u09B6-\u09B9\u09BD\u09CE\u09DC\u09DD\u09DF-\u09E1\u09F0\u09F1\u0A05-\u0A0A]|
[\u0A0F\u0A10\u0A13-\u0A28\u0A2A-\u0A30\u0A32\u0A33\u0A35\u0A36\u0A38\u0A39]|
[\u0A59-\u0A5C\u0A5E\u0A72-\u0A74\u0A85-\u0A8D\u0A8F-\u0A91\u0A93-\u0AA8]|
[\u0AAA-\u0AB0\u0AB2\u0AB3\u0AB5-\u0AB9\u0ABD\u0AD0\u0AE0\u0AE1\u0B05-\u0B0C]|
[\u0B0F\u0B10\u0B13-\u0B28\u0B2A-\u0B30\u0B32\u0B33\u0B35-\u0B39\u0B3D\u0B5C]|
[\u0B5D\u0B5F-\u0B61\u0B71\u0B83\u0B85-\u0B8A\u0B8E-\u0B90\u0B92-\u0B95\u0B99]|
[\u0B9A\u0B9C\u0B9E\u0B9F\u0BA3\u0BA4\u0BA8-\u0BAA\u0BAE-\u0BB9\u0BD0]|
[\u0C05-\u0C0C\u0C0E-\u0C10\u0C12-\u0C28\u0C2A-\u0C33\u0C35-\u0C39\u0C3D]|
[\u0C58\u0C59\u0C60\u0C61\u0C85-\u0C8C\u0C8E-\u0C90\u0C92-\u0CA8\u0CAA-\u0CB3]|
[\u0CB5-\u0CB9\u0CBD\u0CDE\u0CE0\u0CE1\u0CF1\u0CF2\u0D05-\u0D0C\u0D0E-\u0D10]|
[\u0D12-\u0D3A\u0D3D\u0D4E\u0D60\u0D61\u0D7A-\u0D7F\u0D85-\u0D96\u0D9A-\u0DB1]|
[\u0DB3-\u0DBB\u0DBD\u0DC0-\u0DC6\u0E01-\u0E30\u0E32\u0E33\u0E40-\u0E46\u0E81]|
[\u0E82\u0E84\u0E87\u0E88\u0E8A\u0E8D\u0E94-\u0E97\u0E99-\u0E9F\u0EA1-\u0EA3]|
[\u0EA5\u0EA7\u0EAA\u0EAB\u0EAD-\u0EB0\u0EB2\u0EB3\u0EBD\u0EC0-\u0EC4\u0EC6]|
[\u0EDC-\u0EDF\u0F00\u0F40-\u0F47\u0F49-\u0F6C\u0F88-\u0F8C\u1000-\u102A]|
[\u103F\u1050-\u1055\u105A-\u105D\u1061\u1065\u1066\u106E-\u1070\u1075-\u1081]|
[\u108E\u10A0-\u10C5\u10C7\u10CD\u10D0-\u10FA\u10FC-\u1248\u124A-\u124D]|
[\u1250-\u1256\u1258\u125A-\u125D\u1260-\u1288\u128A-\u128D\u1290-\u12B0]|
[\u12B2-\u12B5\u12B8-\u12BE\u12C0\u12C2-\u12C5\u12C8-\u12D6\u12D8-\u1310]|
[\u1312-\u1315\u1318-\u135A\u1380-\u138F\u13A0-\u13F4\u1401-\u166C]|
[\u166F-\u167F\u1681-\u169A\u16A0-\u16EA\u1700-\u170C\u170E-\u1711]|
[\u1720-\u1731\u1740-\u1751\u1760-\u176C\u176E-\u1770\u1780-\u17B3\u17D7]|
[\u17DC\u1820-\u1877\u1880-\u18A8\u18AA\u18B0-\u18F5\u1900-\u191C]|
[\u1950-\u196D\u1970-\u1974\u1980-\u19AB\u19C1-\u19C7\u1A00-\u1A16]|
[\u1A20-\u1A54\u1AA7\u1B05-\u1B33\u1B45-\u1B4B\u1B83-\u1BA0\u1BAE\u1BAF]|
[\u1BBA-\u1BE5\u1C00-\u1C23\u1C4D-\u1C4F\u1C5A-\u1C7D\u1CE9-\u1CEC]|
[\u1CEE-\u1CF1\u1CF5\u1CF6\u1D00-\u1DBF\u1E00-\u1F15\u1F18-\u1F1D]|
[\u1F20-\u1F45\u1F48-\u1F4D\u1F50-\u1F57\u1F59\u1F5B\u1F5D\u1F5F-\u1F7D]|
[\u1F80-\u1FB4\u1FB6-\u1FBC\u1FBE\u1FC2-\u1FC4\u1FC6-\u1FCC\u1FD0-\u1FD3]|
[\u1FD6-\u1FDB\u1FE0-\u1FEC\u1FF2-\u1FF4\u1FF6-\u1FFC\u2071\u207F]|
[\u2090-\u209C\u2102\u2107\u210A-\u2113\u2115\u2119-\u211D\u2124\u2126\u2128]|
[\u212A-\u212D\u212F-\u2139\u213C-\u213F\u2145-\u2149\u214E\u2183\u2184]|
[\u2C00-\u2C2E\u2C30-\u2C5E\u2C60-\u2CE4\u2CEB-\u2CEE\u2CF2\u2CF3]|
[\u2D00-\u2D25\u2D27\u2D2D\u2D30-\u2D67\u2D6F\u2D80-\u2D96\u2DA0-\u2DA6]|
[\u2DA8-\u2DAE\u2DB0-\u2DB6\u2DB8-\u2DBE\u2DC0-\u2DC6\u2DC8-\u2DCE]|
[\u2DD0-\u2DD6\u2DD8-\u2DDE\u2E2F\u3005\u3006\u3031-\u3035\u303B\u303C]|
[\u3041-\u3096\u309D-\u309F\u30A1-\u30FA\u30FC-\u30FF\u3105-\u312D]|
[\u3131-\u318E\u31A0-\u31BA\u31F0-\u31FF\u3400-\u4DB5\u4E00-\u9FCC]|
[\uA000-\uA48C\uA4D0-\uA4FD\uA500-\uA60C\uA610-\uA61F\uA62A\uA62B]|
[\uA640-\uA66E\uA67F-\uA697\uA6A0-\uA6E5\uA717-\uA71F\uA722-\uA788]|
[\uA78B-\uA78E\uA790-\uA793\uA7A0-\uA7AA\uA7F8-\uA801\uA803-\uA805]|
[\uA807-\uA80A\uA80C-\uA822\uA840-\uA873\uA882-\uA8B3\uA8F2-\uA8F7\uA8FB]|
[\uA90A-\uA925\uA930-\uA946\uA960-\uA97C\uA984-\uA9B2\uA9CF\uAA00-\uAA28]|
[\uAA40-\uAA42\uAA44-\uAA4B\uAA60-\uAA76\uAA7A\uAA80-\uAAAF\uAAB1\uAAB5]|
[\uAAB6\uAAB9-\uAABD\uAAC0\uAAC2\uAADB-\uAADD\uAAE0-\uAAEA\uAAF2-\uAAF4]|
[\uAB01-\uAB06\uAB09-\uAB0E\uAB11-\uAB16\uAB20-\uAB26\uAB28-\uAB2E]|
[\uABC0-\uABE2\uAC00-\uD7A3\uD7B0-\uD7C6\uD7CB-\uD7FB\uF900-\uFA6D]|
[\uFA70-\uFAD9\uFB00-\uFB06\uFB13-\uFB17\uFB1D\uFB1F-\uFB28\uFB2A-\uFB36]|
[\uFB38-\uFB3C\uFB3E\uFB40\uFB41\uFB43\uFB44\uFB46-\uFBB1\uFBD3-\uFD3D]|
[\uFD50-\uFD8F\uFD92-\uFDC7\uFDF0-\uFDFB\uFE70-\uFE74\uFE76-\uFEFC]|
[\uFF21-\uFF3A\uFF41-\uFF5A\uFF66-\uFFBE\uFFC2-\uFFC7\uFFCA-\uFFCF]|
[\uFFD2-\uFFD7\uFFDA-\uFFDC]
return 'UNICODE_TEXT';
<<EOF>> return 'EOF';
/lex
%start start
%% /* language grammar */
start
: eol start
| directive start
| QUADRANT document
;
document
: /* empty */
| document line
;
line
: statement eol { $$ = $1 }
;
statement
:
| axisDetails
| quadrantDetails
| points
| title title_value { $$=$2.trim();yy.setDiagramTitle($$); }
| acc_title acc_title_value { $$=$2.trim();yy.setAccTitle($$); }
| acc_descr acc_descr_value { $$=$2.trim();yy.setAccDescription($$); }
| acc_descr_multiline_value { $$=$1.trim();yy.setAccDescription($$); } | section {yy.addSection($1.substr(8));$$=$1.substr(8);}
| directive
;
points
: text point_start point_x point_y {yy.addPoints($1, $3, $4);};
axisDetails
: X-AXIS text AXIS-TEXT-DELIMITER text {yy.setXAxisLeftText($2); yy.setXAxisRightText($4);}
| X-AXIS text {yy.setXAxisLeftText($2);}
| Y-AXIS text AXIS-TEXT-DELIMITER text {yy.setYAxisBottomText($2); yy.setYAxisTopText($4);}
| Y-AXIS text {yy.setYAxisBottomText($2);}
;
quadrantDetails
: QUADRANT_1 text {yy.setQuadrant1Text($2)}
| QUADRANT_2 text {yy.setQuadrant2Text($2)}
| QUADRANT_3 text {yy.setQuadrant3Text($2)}
| QUADRANT_4 text {yy.setQuadrant4Text($2)}
;
directive
: openDirective typeDirective closeDirective
| openDirective typeDirective ':' argDirective closeDirective
;
eol
: NEWLINE
| SEMI
| EOF
;
openDirective
: open_directive { yy.parseDirective('%%{', 'open_directive'); }
;
typeDirective
: type_directive { yy.parseDirective($1, 'type_directive'); }
;
argDirective
: arg_directive { $1 = $1.trim().replace(/'/g, '"'); yy.parseDirective($1, 'arg_directive'); }
;
closeDirective
: close_directive { yy.parseDirective('}%%', 'close_directive', 'pie'); }
;
text: textNoTagsToken
{ $$={text:$1, type: 'text'};}
| text textNoTagsToken
{ $$={text:$1.text+''+$2, type: $1.type};}
| STR
{ $$={text: $1, type: 'text'};}
| MD_STR
{ $$={text: $1, type: 'markdown'};}
;
alphaNum
: alphaNumToken
{$$=$1;}
| alphaNum alphaNumToken
{$$=$1+''+$2;}
;
alphaNumToken : PUNCTUATION | AMP | UNICODE_TEXT | NUM| ALPHA | COMMA | PLUS | EQUALS | MULT | DOT | BRKT| UNDERSCORE ;
textNoTagsToken: alphaNumToken | SPACE | MINUS;
%%

View File

@ -0,0 +1,284 @@
import { scaleLinear } from 'd3';
export class QuadrantBuilder {
totalWidth = 500;
totalHeight = 500;
quadrantPadding = 5;
xAxisLabelPadding = 5;
yAxisLabelPadding = 5;
xAxisLabelFontSize = 16;
yAxisLabelFontSize = 16;
quadrantLabelFontSize = 16;
quadrantTextTopPadding = 5;
pointTextPadding = 5;
pointLabelFontSize = 12;
pointRadius = 5;
points = [];
quadrant1Text = '';
quadrant2Text = '';
quadrant3Text = '';
quadrant4Text = '';
xAxisLeftText = '';
xAxisRightText = '';
yAxisBottomText = '';
yAxisTopText = '';
xAxisPosition = 'top';
yAxisPosition = 'left';
quadrant1Fill = '#8bc2f3';
quadrant2Fill = '#faebd7';
quadrant3Fill = '#00ffff';
quadrant4Fill = '#f0ffff';
quadrant1TextFill = '#93690e';
quadrant2TextFill = '#8644ff';
quadrant3TextFill = '#e3004d';
quadrant4TextFill = '#000000';
pointFill = '#60B19C';
pointTextFill = '#0000ff';
xAxisTextFill = '#000000';
yAxisTextFill = '#000000';
showXAxis = true;
showYAxis = true;
constructor() {}
clear() {
this.points = [];
this.quadrant1Text = '';
this.quadrant2Text = '';
this.quadrant3Text = '';
this.quadrant4Text = '';
this.xAxisLeftText = '';
this.xAxisRightText = '';
this.yAxisBottomText = '';
this.yAxisTopText = '';
}
addPoints(points) {
this.points = this.points.concat([...points]);
}
set quadrant1Text(text) {
this.quadrant1Text = text;
}
set quadrant2Text(text) {
this.quadrant2Text = text;
}
set quadrant3Text(text) {
this.quadrant3Text = text;
}
set quadrant4Text(text) {
this.quadrant4Text = text;
}
set xAxisLeftText(text) {
this.xAxisLeftText = text;
}
set xAxisRightText(text) {
this.xAxisRightText = text;
}
set yAxisTopText(text) {
this.yAxisTopText = text;
}
set yAxisBottomText(text) {
this.yAxisBottomText = text;
}
set totalWidth(width) {
this.totalWidth = width;
}
set totalHeight(height) {
this.totalHeight = height;
}
build() {
const showXAxis = (!this.xAxisLeftText && !this.xAxisRightText) ? false: this.showXAxis;
const showYAxis = (!this.yAxisTopText && !this.yAxisBottomText) ? false: this.showYAxis;
const quadrantLeft =
this.quadrantPadding +
((this.yAxisPosition === 'left' && showYAxis) ? this.yAxisLabelPadding * 2 + this.yAxisLabelFontSize : 0);
const quadrantTop =
this.quadrantPadding +
((this.xAxisPosition === 'top' && showXAxis) ? this.xAxisLabelPadding * 2 + this.xAxisLabelFontSize : 0);
const quadrantWidth =
this.totalWidth -
(this.quadrantPadding * 2 + (showYAxis ? this.yAxisLabelPadding * 2 + this.yAxisLabelFontSize: 0));
const quadrantHeight =
this.totalHeight -
(this.quadrantPadding * 2 + (showXAxis ? this.xAxisLabelPadding * 2 + this.xAxisLabelFontSize: 0));
const quadrantHalfWidth = quadrantWidth / 2;
const quadrantHalfHeight = quadrantHeight / 2;
const axisLabels = [];
if (this.xAxisLeftText && showXAxis) {
axisLabels.push({
text: this.xAxisLeftText,
fill: this.xAxisTextFill,
x: quadrantLeft,
y:
this.xAxisPosition === 'top'
? this.xAxisLabelPadding
: this.xAxisLabelPadding + quadrantTop + quadrantHeight,
fontSize: this.xAxisLabelFontSize,
verticalPos: 'left',
horizontalPos: 'top',
rotation: 0,
});
}
if (this.xAxisRightText && showXAxis) {
axisLabels.push({
text: this.xAxisRightText,
fill: this.xAxisTextFill,
x: quadrantLeft + quadrantHalfWidth,
y:
this.xAxisPosition === 'top'
? this.xAxisLabelPadding
: this.xAxisLabelPadding + quadrantTop + quadrantHeight,
fontSize: this.xAxisLabelFontSize,
verticalPos: 'left',
horizontalPos: 'top',
rotation: 0,
});
}
if (this.yAxisBottomText && showYAxis) {
axisLabels.push({
text: this.yAxisBottomText,
fill: this.yAxisTextFill,
x:
this.yAxisPosition === 'left'
? this.yAxisLabelPadding
: this.yAxisLabelPadding + quadrantLeft + quadrantWidth,
y: quadrantTop + quadrantHeight,
fontSize: this.yAxisLabelFontSize,
verticalPos: 'left',
horizontalPos: 'top',
rotation: -90,
});
}
if (this.yAxisTopText && showYAxis) {
axisLabels.push({
text: this.yAxisTopText,
fill: this.yAxisTextFill,
x:
this.yAxisPosition === 'left'
? this.yAxisLabelPadding
: this.yAxisLabelPadding + quadrantLeft + quadrantWidth,
y: quadrantTop + quadrantHalfHeight,
fontSize: this.yAxisLabelFontSize,
verticalPos: 'left',
horizontalPos: 'top',
rotation: -90,
});
}
const quadrants = [
{
text: this.quadrant1Text,
textFill: this.quadrant1TextFill,
x: quadrantLeft + quadrantHalfWidth,
y: quadrantTop,
width: quadrantHalfWidth,
height: quadrantHalfHeight,
fill: this.quadrant1Fill,
},
{
text: this.quadrant2Text,
textFill: this.quadrant2TextFill,
x: quadrantLeft,
y: quadrantTop,
width: quadrantHalfWidth,
height: quadrantHalfHeight,
fill: this.quadrant2Fill,
},
{
text: this.quadrant3Text,
textFill: this.quadrant3TextFill,
x: quadrantLeft,
y: quadrantTop + quadrantHalfHeight,
width: quadrantHalfWidth,
height: quadrantHalfHeight,
fill: this.quadrant3Fill,
},
{
text: this.quadrant4Text,
textFill: this.quadrant4TextFill,
x: quadrantLeft + quadrantHalfWidth,
y: quadrantTop + quadrantHalfHeight,
width: quadrantHalfWidth,
height: quadrantHalfHeight,
fill: this.quadrant4Fill,
},
];
quadrants.forEach((quadrant, i) => {
// place the text in the center of the box
if (this.points.length === 0) {
quadrant.text = {
text: quadrant.text,
fill: quadrant.textFill,
x: quadrant.x + quadrant.width / 2,
y: quadrant.y + quadrant.height / 2,
fontSize: this.quadrantLabelFontSize,
verticalPos: 'center',
horizontalPos: 'center',
rotation: 0,
};
// place the text top of the quadrant square
} else {
quadrant.text = {
text: quadrant.text,
fill: quadrant.textFill,
x: quadrant.x + quadrant.width / 2,
y: quadrant.y + this.quadrantTextTopPadding,
fontSize: this.quadrantLabelFontSize,
verticalPos: 'center',
horizontalPos: 'top',
rotation: 0,
};
}
delete quadrant.textFill;
});
const xAxis = scaleLinear()
.domain([0, 1])
.range([quadrantLeft, quadrantWidth + quadrantLeft]);
const yAxis = scaleLinear()
.domain([0, 1])
.range([quadrantHeight + quadrantTop, quadrantTop]);
const points = this.points.map((point) => {
const props = {
x: xAxis(point.x),
y: yAxis(point.y),
fill: this.pointFill,
radius: this.pointRadius,
};
props.text = {
text: point.text,
fill: this.pointTextFill,
x: props.x,
y: props.y + this.pointTextPadding,
verticalPos: 'center',
horizontalPos: 'top',
fontSize: this.pointLabelFontSize,
rotation: 0,
};
return props;
});
return {
points,
quadrants,
axisLabels,
};
}
}

View File

@ -0,0 +1,129 @@
import { log } from '../../logger.js';
import mermaidAPI from '../../mermaidAPI.js';
import * as configApi from '../../config.js';
import { sanitizeText } from '../common/common.js';
import {
setAccTitle,
getAccTitle,
setDiagramTitle,
getDiagramTitle,
getAccDescription,
setAccDescription,
clear as commonClear,
} from '../../commonDb.js';
import { QuadrantBuilder } from './quadrantBuilder.js';
const config = configApi.getConfig();
function textSanitizer(text) {
return sanitizeText(text.trim(), config);
}
const quadrantBuilder = new QuadrantBuilder();
function setQuadrant1Text(textObj) {
quadrantBuilder.quadrant1Text = textSanitizer(textObj.text);
}
function setQuadrant2Text(textObj) {
quadrantBuilder.quadrant2Text = textSanitizer(textObj.text);
}
function setQuadrant3Text(textObj) {
quadrantBuilder.quadrant3Text = textSanitizer(textObj.text);
}
function setQuadrant4Text(textObj) {
quadrantBuilder.quadrant4Text = textSanitizer(textObj.text);
}
function setXAxisLeftText(textObj) {
quadrantBuilder.xAxisLeftText = textSanitizer(textObj.text);
}
function setXAxisRightText(textObj) {
quadrantBuilder.xAxisRightText = textSanitizer(textObj.text);
}
function setYAxisTopText(textObj) {
quadrantBuilder.yAxisTopText = textSanitizer(textObj.text);
}
function setYAxisBottomText(textObj) {
quadrantBuilder.yAxisBottomText = textSanitizer(textObj.text);
}
function addPoints(textObj, x, y) {
console.log(textObj, x, y);
quadrantBuilder.addPoints([{ x, y, text: textSanitizer(textObj.text) }]);
}
function setWidth(width) {
quadrantBuilder.totalWidth = width;
}
function setHeight(height) {
quadrantBuilder.totalHeight = height;
}
function getQuadrantData() {
const config = configApi.getConfig();
const { themeVariables, quadrantChart: quadrantChartConfig } = config;
quadrantBuilder.quadrant1Fill = themeVariables.quadrant1Fill;
quadrantBuilder.quadrant2Fill = themeVariables.quadrant2Fill;
quadrantBuilder.quadrant3Fill = themeVariables.quadrant3Fill;
quadrantBuilder.quadrant4Fill = themeVariables.quadrant4Fill;
quadrantBuilder.quadrant1TextFill = themeVariables.quadrant1TextFill;
quadrantBuilder.quadrant2TextFill = themeVariables.quadrant2TextFill;
quadrantBuilder.quadrant3TextFill = themeVariables.quadrant3TextFill;
quadrantBuilder.quadrant4TextFill = themeVariables.quadrant4TextFill;
quadrantBuilder.pointFill = themeVariables.quadrantPointFill;
quadrantBuilder.pointTextFill = themeVariables.quadrantPointTextFill;
quadrantBuilder.xAxisTextFill = themeVariables.quadrantXAxisTextFill;
quadrantBuilder.yAxisTextFill = themeVariables.quadrantYAxisTextFill;
quadrantBuilder.quadrantPadding = quadrantChartConfig.quadrantPadding;
quadrantBuilder.xAxisLabelPadding = quadrantChartConfig.xAxisLabelPadding;
quadrantBuilder.yAxisLabelPadding = quadrantChartConfig.yAxisLabelPadding;
quadrantBuilder.xAxisLabelFontSize = quadrantChartConfig.xAxisLabelFontSize;
quadrantBuilder.yAxisLabelFontSize = quadrantChartConfig.yAxisLabelFontSize;
quadrantBuilder.quadrantLabelFontSize = quadrantChartConfig.quadrantLabelFontSize;
quadrantBuilder.quadrantTextTopPadding = quadrantChartConfig.quadrantTextTopPadding;
quadrantBuilder.pointTextPadding = quadrantChartConfig.pointTextPadding;
quadrantBuilder.pointLabelFontSize = quadrantChartConfig.pointLabelFontSize;
quadrantBuilder.pointRadius = quadrantChartConfig.pointRadius;
quadrantBuilder.xAxisPosition = quadrantChartConfig.xAxisPosition;
quadrantBuilder.yAxisPosition = quadrantChartConfig.yAxisPosition;
return quadrantBuilder.build();
}
export const parseDirective = function (statement, context, type) {
mermaidAPI.parseDirective(this, statement, context, type);
};
const clear = function () {
quadrantBuilder.clear();
commonClear();
};
export default {
setWidth,
setHeight,
setQuadrant1Text,
setQuadrant2Text,
setQuadrant3Text,
setQuadrant4Text,
setXAxisLeftText,
setXAxisRightText,
setYAxisTopText,
setYAxisBottomText,
addPoints,
getQuadrantData,
parseDirective,
clear,
setAccTitle,
getAccTitle,
setDiagramTitle,
getDiagramTitle,
getAccDescription,
setAccDescription,
};

View File

@ -0,0 +1,20 @@
import type { DiagramDetector, ExternalDiagramDefinition } from '../../diagram-api/types.js';
const id = 'quadrantChart';
const detector: DiagramDetector = (txt) => {
return txt.match(/^\s*quadrantChart/) !== null;
};
const loader = async () => {
const { diagram } = await import('./quadrantDiagram.js');
return { id, diagram };
};
const plugin: ExternalDiagramDefinition = {
id,
detector,
loader,
};
export default plugin;

View File

@ -0,0 +1,13 @@
import { DiagramDefinition } from '../../diagram-api/types.js';
// @ts-ignore: TODO Fix ts errors
import parser from './parser/quadrant.jison';
import db from './quadrantDb.js';
import styles from './styles.js';
import renderer from './quadrantRenderer.js';
export const diagram: DiagramDefinition = {
parser,
db,
renderer,
styles,
};

View File

@ -0,0 +1,131 @@
import { select, scaleLinear } from 'd3';
import * as configApi from '../../config.js';
import { log } from '../../logger.js';
import { configureSvgSize } from '../../setupGraphViewbox.js';
export const draw = (txt, id, _version, diagObj) => {
function getDominantBaseLine(horizintalPos) {
return horizintalPos === 'top' ? 'text-before-edge' : 'middle';
}
function getTextAnchor(verticalPos) {
return verticalPos === 'left' ? 'start' : 'middle';
}
function getTransformation(data) {
return `translate(${data.x}, ${data.y}) rotate(${data.rotation || 0})`;
}
const conf = configApi.getConfig();
log.debug('Rendering info diagram\n' + txt);
const securityLevel = conf.securityLevel;
// Handle root and Document for when rendering in sandbox mode
let sandboxElement;
if (securityLevel === 'sandbox') {
sandboxElement = select('#i' + id);
}
const root =
securityLevel === 'sandbox'
? select(sandboxElement.nodes()[0].contentDocument.body)
: select('body');
const svg = root.select(`[id="${id}"]`);
const group = svg.append('g').attr('class', 'main');
// const bounds = svg.node().getBox();
// const width = bounds.width + padding * 2;
// const height = bounds.height + padding * 2;
const width = 500;
const height = 500;
diagObj.db.setHeight(height);
diagObj.db.setWidth(width);
svg.attr('width', width);
svg.attr('height', height);
const quadrantData = diagObj.db.getQuadrantData();
const quadrantsGroup = group.append('g').attr('class', 'quadrants');
const dataPointGroup = group.append('g').attr('class', 'data-points');
const labelGroup = group.append('g').attr('class', 'labels');
const quadrants = quadrantsGroup
.selectAll('g.quadrant')
.data(quadrantData.quadrants)
.enter()
.append('g')
.attr('class', 'quadrant');
quadrants
.append('rect')
.attr('x', data => data.x)
.attr('y', data => data.y)
.attr('width', data => data.width)
.attr('height', data => data.height)
.attr('fill', data => data.fill);
quadrants
.append('text')
.attr('x', 0)
.attr('y', 0)
.attr('fill', data => data.text.fill)
.attr('font-size', data => data.text.fontSize)
.attr('dominant-baseline', data => getDominantBaseLine(data.text.horizontalPos))
.attr('text-anchor', data => getTextAnchor(data.text.verticalPos))
.attr('transform', data => getTransformation(data.text))
.text(data => data.text.text);
const labels = labelGroup
.selectAll('g.label')
.data(quadrantData.axisLabels)
.enter()
.append('g')
.attr('class', 'label')
labels
.append('text')
.attr('x', 0)
.attr('y', 0)
.text(data => data.text)
.attr('fill', data => data.fill)
.attr('font-size', data => data.fontSize)
.attr('dominant-baseline', data => getDominantBaseLine(data.horizontalPos))
.attr('text-anchor', data => getTextAnchor(data.verticalPos))
.attr('transform', data => getTransformation(data))
const dataPoints = dataPointGroup
.selectAll('g.data-point')
.data(quadrantData.points)
.enter()
.append('g')
.attr('class', 'data-point')
dataPoints
.append('circle')
.attr('cx', data => data.x)
.attr('cy', data => data.y)
.attr('r', data => data.radius)
.attr('fill', data => data.fill);
dataPoints
.append('text')
.attr('x', 0)
.attr('y', 0)
.text(data => data.text.text)
.attr('fill', data => data.text.fill)
.attr('font-size', data => data.text.fontSize)
.attr('dominant-baseline', data => getDominantBaseLine(data.text.horizontalPos))
.attr('text-anchor', data => getTextAnchor(data.text.verticalPos))
.attr('transform', data => getTransformation(data.text))
};
export default {
draw,
};

View File

@ -0,0 +1,5 @@
const getStyles = (options) =>
`
`;
export default getStyles;

View File

@ -220,6 +220,20 @@ class Theme {
this.pieOuterStrokeColor = this.pieOuterStrokeColor || 'black';
this.pieOpacity = this.pieOpacity || '0.7';
/* quadrant-graph */
this.quadrant1Fill = this.quadrant1Fill || this.primaryColor;
this.quadrant2Fill = this.quadrant2Fill || adjust(this.quadrant1Fill, {r: 5, g: 5, b: 5});
this.quadrant3Fill = this.quadrant3Fill || adjust(this.quadrant1Fill, {r: 10, g: 10, b: 10});
this.quadrant4Fill = this.quadrant4Fill || adjust(this.quadrant1Fill, {r: 15, g: 15, b: 15});
this.quadrant1TextFill = this.quadrant1TextFill || this.primaryTextColor;
this.quadrant2TextFill = this.quadrant2TextFill || adjust(this.quadrant1TextFill, {r: -5, g: -5, b: -5});
this.quadrant3TextFill = this.quadrant3TextFill || adjust(this.quadrant1TextFill, {r: -10, g: -10, b: -10});
this.quadrant4TextFill = this.quadrant4TextFill || adjust(this.quadrant1TextFill, {r: -15, g: -15, b: -15});
this.quadrantPointFill = this.quadrantPointFill || this.secondaryColor;
this.quadrantPointTextFill = this.quadrantPointTextFill || this.secondaryTextColor;
this.quadrantXAxisTextFill = this.quadrantXAxisTextFill || this.primaryTextColor;
this.quadrantYAxisTextFill = this.quadrantYAxisTextFill || this.primaryTextColor;
/* requirement-diagram */
this.requirementBackground = this.requirementBackground || this.primaryColor;
this.requirementBorderColor = this.requirementBorderColor || this.primaryBorderColor;

View File

@ -226,6 +226,20 @@ class Theme {
this.pieOuterStrokeColor = this.pieOuterStrokeColor || 'black';
this.pieOpacity = this.pieOpacity || '0.7';
/* quadrant-graph */
this.quadrant1Fill = this.quadrant1Fill || this.primaryColor;
this.quadrant2Fill = this.quadrant2Fill || adjust(this.quadrant1Fill, {r: 5, g: 5, b: 5});
this.quadrant3Fill = this.quadrant3Fill || adjust(this.quadrant1Fill, {r: 10, g: 10, b: 10});
this.quadrant4Fill = this.quadrant4Fill || adjust(this.quadrant1Fill, {r: 15, g: 15, b: 15});
this.quadrant1TextFill = this.quadrant1TextFill || this.primaryTextColor;
this.quadrant2TextFill = this.quadrant2TextFill || adjust(this.quadrant1TextFill, {r: -5, g: -5, b: -5});
this.quadrant3TextFill = this.quadrant3TextFill || adjust(this.quadrant1TextFill, {r: -10, g: -10, b: -10});
this.quadrant4TextFill = this.quadrant4TextFill || adjust(this.quadrant1TextFill, {r: -15, g: -15, b: -15});
this.quadrantPointFill = this.quadrantPointFill || this.secondaryColor;
this.quadrantPointTextFill = this.quadrantPointTextFill || this.secondaryTextColor;
this.quadrantXAxisTextFill = this.quadrantXAxisTextFill || this.primaryTextColor;
this.quadrantYAxisTextFill = this.quadrantYAxisTextFill || this.primaryTextColor;
/* class */
this.classText = this.primaryTextColor;

View File

@ -247,6 +247,20 @@ class Theme {
this.pieOuterStrokeColor = this.pieOuterStrokeColor || 'black';
this.pieOpacity = this.pieOpacity || '0.7';
/* quadrant-graph */
this.quadrant1Fill = this.quadrant1Fill || this.primaryColor;
this.quadrant2Fill = this.quadrant2Fill || adjust(this.quadrant1Fill, {r: 5, g: 5, b: 5});
this.quadrant3Fill = this.quadrant3Fill || adjust(this.quadrant1Fill, {r: 10, g: 10, b: 10});
this.quadrant4Fill = this.quadrant4Fill || adjust(this.quadrant1Fill, {r: 15, g: 15, b: 15});
this.quadrant1TextFill = this.quadrant1TextFill || this.primaryTextColor;
this.quadrant2TextFill = this.quadrant2TextFill || adjust(this.quadrant1TextFill, {r: -5, g: -5, b: -5});
this.quadrant3TextFill = this.quadrant3TextFill || adjust(this.quadrant1TextFill, {r: -10, g: -10, b: -10});
this.quadrant4TextFill = this.quadrant4TextFill || adjust(this.quadrant1TextFill, {r: -15, g: -15, b: -15});
this.quadrantPointFill = this.quadrantPointFill || this.secondaryColor;
this.quadrantPointTextFill = this.quadrantPointTextFill || this.secondaryTextColor;
this.quadrantXAxisTextFill = this.quadrantXAxisTextFill || this.primaryTextColor;
this.quadrantYAxisTextFill = this.quadrantYAxisTextFill || this.primaryTextColor;
/* requirement-diagram */
this.requirementBackground = this.requirementBackground || this.primaryColor;
this.requirementBorderColor = this.requirementBorderColor || this.primaryBorderColor;

View File

@ -215,6 +215,20 @@ class Theme {
this.pieOuterStrokeColor = this.pieOuterStrokeColor || 'black';
this.pieOpacity = this.pieOpacity || '0.7';
/* quadrant-graph */
this.quadrant1Fill = this.quadrant1Fill || this.primaryColor;
this.quadrant2Fill = this.quadrant2Fill || adjust(this.quadrant1Fill, {r: 5, g: 5, b: 5});
this.quadrant3Fill = this.quadrant3Fill || adjust(this.quadrant1Fill, {r: 10, g: 10, b: 10});
this.quadrant4Fill = this.quadrant4Fill || adjust(this.quadrant1Fill, {r: 15, g: 15, b: 15});
this.quadrant1TextFill = this.quadrant1TextFill || this.primaryTextColor;
this.quadrant2TextFill = this.quadrant2TextFill || adjust(this.quadrant1TextFill, {r: -5, g: -5, b: -5});
this.quadrant3TextFill = this.quadrant3TextFill || adjust(this.quadrant1TextFill, {r: -10, g: -10, b: -10});
this.quadrant4TextFill = this.quadrant4TextFill || adjust(this.quadrant1TextFill, {r: -15, g: -15, b: -15});
this.quadrantPointFill = this.quadrantPointFill || this.secondaryColor;
this.quadrantPointTextFill = this.quadrantPointTextFill || this.secondaryTextColor;
this.quadrantXAxisTextFill = this.quadrantXAxisTextFill || this.primaryTextColor;
this.quadrantYAxisTextFill = this.quadrantYAxisTextFill || this.primaryTextColor;
/* requirement-diagram */
this.requirementBackground = this.requirementBackground || this.primaryColor;
this.requirementBorderColor = this.requirementBorderColor || this.primaryBorderColor;

View File

@ -246,6 +246,20 @@ class Theme {
this.pieOuterStrokeColor = this.pieOuterStrokeColor || 'black';
this.pieOpacity = this.pieOpacity || '0.7';
/* quadrant-graph */
this.quadrant1Fill = this.quadrant1Fill || this.primaryColor;
this.quadrant2Fill = this.quadrant2Fill || adjust(this.quadrant1Fill, {r: 5, g: 5, b: 5});
this.quadrant3Fill = this.quadrant3Fill || adjust(this.quadrant1Fill, {r: 10, g: 10, b: 10});
this.quadrant4Fill = this.quadrant4Fill || adjust(this.quadrant1Fill, {r: 15, g: 15, b: 15});
this.quadrant1TextFill = this.quadrant1TextFill || this.primaryTextColor;
this.quadrant2TextFill = this.quadrant2TextFill || adjust(this.quadrant1TextFill, {r: -5, g: -5, b: -5});
this.quadrant3TextFill = this.quadrant3TextFill || adjust(this.quadrant1TextFill, {r: -10, g: -10, b: -10});
this.quadrant4TextFill = this.quadrant4TextFill || adjust(this.quadrant1TextFill, {r: -15, g: -15, b: -15});
this.quadrantPointFill = this.quadrantPointFill || this.secondaryColor;
this.quadrantPointTextFill = this.quadrantPointTextFill || this.secondaryTextColor;
this.quadrantXAxisTextFill = this.quadrantXAxisTextFill || this.primaryTextColor;
this.quadrantYAxisTextFill = this.quadrantYAxisTextFill || this.primaryTextColor;
/* requirement-diagram */
this.requirementBackground = this.requirementBackground || this.primaryColor;
this.requirementBorderColor = this.requirementBorderColor || this.primaryBorderColor;