How to add a new shape? #1500
Comments
github-actions
bot
added
the
Status: Triage
jgreywolf
added
Type: Question
and removed
Contributor needed
Status: Triage
|
Lets not allow this issue to die, a new one will be created with the same request in time, like it has already happened with #820 #548 #274 Adding a feature like this would increase the creative freedom of the users. For example, you could create an SVG with Tikz or with Matplotlib, and then use that as a shape of a flowchart in Mermaid. In this way Mermaid would not need to implement the drawing capabilities of Tikz or Matplotlib, because you would draw there, and then use the drawing in Mermaid. |
|
One of the main powers of Mermaid, which is one of the main reasons why some of us even use Mermaid in the first place, is that Mermaid does the layout of shapes in space. Using this definition, "Mermaid does the layout of shapes in space", it would be useful to give custom shapes to Mermaid and have Mermaid then lay them out in space. |
|
This would make Mermaid even more awesome. In general, I appreciate the styling, syntax, and documentation of Mermaid more than PlantUML, but beyond PlantUML's awkward syntax it has wide support for this already. It's not so pretty, but you can easily incorporate "sprites" into your diagrams. It would be really nice if Mermaid also had this feature. |
|
Any update? The basic shapes offered by Mermaid are extremely limited, specifically for flowcharts which can be used for many different applications. |
|
I came up with an example, kind of complicated, but it seems to work in the Online Editor/Mermaid Live Editor; since this is the open issue, I'll post it here. References:
Basically, now that I've found a hoster for SVG (svgur.com), I've uploaded an SVG "cloud" vector image, and I'm using it in an
Here it should be rendered via Github's Mermaid diagrams - and unfortunately, the https://svgshare.com/i/q2Q.svg here is not visible, and the same problem remains if that link is replaced with the cloud_scalable.svg version I uploaded here (and the same problem occurs if you click on Actions/(Download PNG) in Mermaid Live Editor): %%{init: {'theme':'base'}}%%
flowchart LR
%% DummyNode("") crashes the parser, must have at least one character
%%DummyNode("A")
subgraph Border
direction LR
M1["Machine 1"]:::wht;
subgraph CloudContainer[ ]
direction LR
%%CloudImgNode("<img class='BgImgClass' src='https://user-images.githubusercontent.com/48317456/216860238-ada65abe-43e7-45ca-8901-60aa95035eb9.svg' /> <div class='TxtClass'>Subnet <br /> 10.1.1.0/24</div>")
%% text with <br> does not render with position:absolute
%% use img top and div padding to center text in image
CloudImgNode("<img style='position:absolute;left:0;top:7px;color:#fff;' src='https://svgshare.com/i/q2Q.svg' /> <div style='position:relative;z-index:100;color:black;padding:18px;'>Subnet <br /> 10.1.1.0/24 </div>");
end
M2["Machine 2"]:::wht;
M1 --> CloudImgNode;
CloudImgNode --> M2;
end
%% Defining Class Styles
%% background-image:"" passes, but not with any text inside quotes
%% node that classes here get defined with "#graph-div " prepended!
%% however, seemingly <img> and such are included via foreignObject, so cannot refer to these classes
classDef BorderClass fill:#fff,stroke:#fff,stroke-width:4px,color:#fff,stroke-dasharray: 5 5,margin:0,padding:0;
classDef ContainerClass position:relative,padding:0,margin:0,fill:#fff,color:#000,stroke:none;
classDef ImgNodeClass fill:#fff,padding:0,margin:0,stroke:none,margin:0;
classDef wht fill:#fff,color:black,stroke:#000;
%%classDef BgImgClass display:block,position:absolute,left:0,top:0,width:100%;
%%classDef TxtClass display:block,position:absolute,z-index:100,left:0,top:0;
%%classDef InvisibleClass display:none;
%% Custom Styles
%% NOTE: this gets applied to <rect class="basic label-container",
%% not to the sigbling g<g class="label" or the enclosing <g id="flowchart-CloudImgNode-9174"
%% classdef node class; does however apply the class to the enclosing <g id="flowchart-CloudImgNode-9174" element
%%style CloudImgNode fill:#fff,padding:0,margin:0,stroke:none;
%%style CloudImgNode padding:100px,margin:100px;
%%<div class='TxtClass'>Subnet <br /> 10.1.1.0/24</div>
%% Assigning Nodes to Classes
class Border BorderClass;
%% Cannot add multiple classes separated with , (end up as single word)
%% or space (parser crashes)
%% but thankfully, multiple commands work: they do append classes
%%class DummyNode BgImgClass;
%%class DummyNode TxtClass;
%%class DummyNode InvisibleClass;
class CloudContainer ContainerClass;
%%class CloudImgNode BgImgClass;
%%class CloudImgNode TxtClass;
%% gets applied to all childer, too!
class CloudImgNode ImgNodeClass;
This should be the rendered .png right from the Mermaid Live Editor - also here the svg is missing: Note that:
Another thing that would have made things easier:
Here is the code: %%{init: {'theme':'base'}}%%
flowchart LR
%% DummyNode("") crashes the parser, must have at least one character
%%DummyNode("A")
subgraph Border
direction LR
M1["Machine 1"]:::wht;
subgraph CloudContainer[ ]
direction LR
%%CloudImgNode("<img class='BgImgClass' src='https://svgshare.com/i/q24.svg' /> <div class='TxtClass'>Subnet <br /> 10.1.1.0/24</div>")
%% text with <br> does not render with position:absolute
%% use img top and div padding to center text in image
CloudImgNode("<img style='position:absolute;left:0;top:7px;color:#fff;' src='https://svgshare.com/i/q2Q.svg' /> <div style='position:relative;z-index:100;color:black;padding:18px;'>Subnet <br /> 10.1.1.0/24 </div>");
end
M2["Machine 2"]:::wht;
M1 --> CloudImgNode;
CloudImgNode --> M2;
end
%% Defining Class Styles
%% background-image:"" passes, but not with any text inside quotes
%% node that classes here get defined with "#graph-div " prepended!
%% however, seemingly <img> and such are included via foreignObject, so cannot refer to these classes
classDef BorderClass fill:#fff,stroke:#fff,stroke-width:4px,color:#fff,stroke-dasharray: 5 5,margin:0,padding:0;
classDef ContainerClass position:relative,padding:0,margin:0,fill:#fff,color:#000,stroke:none;
classDef ImgNodeClass fill:#fff,padding:0,margin:0,stroke:none,margin:0;
classDef wht fill:#fff,color:black,stroke:#000;
%%classDef BgImgClass display:block,position:absolute,left:0,top:0,width:100%;
%%classDef TxtClass display:block,position:absolute,z-index:100,left:0,top:0;
%%classDef InvisibleClass display:none;
%% Custom Styles
%% NOTE: this gets applied to <rect class="basic label-container",
%% not to the sigbling g<g class="label" or the enclosing <g id="flowchart-CloudImgNode-9174"
%% classdef node class; does however apply the class to the enclosing <g id="flowchart-CloudImgNode-9174" element
%%style CloudImgNode fill:#fff,padding:0,margin:0,stroke:none;
%%style CloudImgNode padding:100px,margin:100px;
%%<div class='TxtClass'>Subnet <br /> 10.1.1.0/24</div>
%% Assigning Nodes to Classes
class Border BorderClass;
%% Cannot add multiple classes separated with , (end up as single word)
%% or space (parser crashes)
%% but thankfully, multiple commands work: they do append classes
%%class DummyNode BgImgClass;
%%class DummyNode TxtClass;
%%class DummyNode InvisibleClass;
class CloudContainer ContainerClass;
%%class CloudImgNode BgImgClass;
%%class CloudImgNode TxtClass;
%% gets applied to all childer, too!
class CloudImgNode ImgNodeClass; |
|
Well, in relation to previous post - tried image base64 inline embedding instead (https://www.base64-image.de/); and with that, now it is possible to download a correct PNG from Mermaid Live editor... However, Github will unfortunately not render even this kind of svg in the mermaid diagram code: %%{init: {'theme':'base'}}%%
flowchart LR
%% DummyNode("") crashes the parser, must have at least one character
%%DummyNode("A")
subgraph Border
direction LR
M1["Machine 1"]:::wht;
subgraph CloudContainer[ ]
direction LR
%%CloudImgNode("<img class='BgImgClass' src='https://svgshare.com/i/q24.svg' /> <div class='TxtClass'>Subnet <br /> 10.1.1.0/24</div>")
%% text with <br> does not render with position:absolute
%% use img top and div padding to center text in ima
CloudImgNode("<img style='position:absolute;left:0;top:7px;color:#fff;' src=' data:image/svg+xml;base64,<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->

<svg
   id="svg2"
   sodipodi:docname="cloud.svg"
   viewBox="0 0 565.40995 316.84399"
   version="1.1"
   inkscape:version="1.1.2 (1:1.1+202202050852+0a00cf5339)"
   width="100%"
   height="100%"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns="http://www.w3.org/2000/svg"
   xmlns:svg="http://www.w3.org/2000/svg"
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:cc="http://creativecommons.org/ns#"
   xmlns:dc="http://purl.org/dc/elements/1.1/">
  <defs
     id="defs4">
    <filter
       id="filter3301"
       inkscape:menu="ABCs"
       color-interpolation-filters="sRGB"
       width="1.0801581"
       y="-0.072974868"
       x="-0.040079068"
       inkscape:menu-tooltip="Bulging, matte jelly covering"
       height="1.1459497"
       inkscape:label="Matte jelly">
      <feGaussianBlur
         id="feGaussianBlur3303"
         result="result0"
         stdDeviation="2"
         in="SourceAlpha" />
      <feComposite
         id="feComposite3305"
         k3="10"
         k2="1"
         result="result3"
         in="SourceGraphic"
         operator="arithmetic"
         in2="result0"
         k1="0"
         k4="0" />
      <feComposite
         id="feComposite3307"
         in2="result3"
         result="fbSourceGraphic"
         in="result3"
         operator="in" />
      <feColorMatrix
         id="feColorMatrix3722"
         in="fbSourceGraphic"
         values="1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0.85 0"
         result="result0" />
      <feGaussianBlur
         id="feGaussianBlur3724"
         stdDeviation="7"
         in="fbSourceGraphicAlpha" />
      <feSpecularLighting
         id="feSpecularLighting3726"
         result="result4"
         specularConstant="0.89999998"
         specularExponent="25"
         surfaceScale="5">
        <feDistantLight
           id="feDistantLight3728"
           elevation="60"
           azimuth="225" />
      </feSpecularLighting>
      <feComposite
         id="feComposite3730"
         operator="atop"
         in2="result0" />
    </filter>
  </defs>
  <sodipodi:namedview
     id="base"
     bordercolor="#666666"
     inkscape:pageshadow="2"
     inkscape:window-y="28"
     pagecolor="#ffffff"
     inkscape:window-height="712"
     inkscape:window-maximized="1"
     inkscape:zoom="0.7"
     inkscape:window-x="0"
     showgrid="false"
     borderopacity="1.0"
     inkscape:current-layer="layer1"
     inkscape:cx="225.71429"
     inkscape:cy="260"
     inkscape:window-width="1366"
     inkscape:pageopacity="0.0"
     inkscape:document-units="px"
     inkscape:pagecheckerboard="0"
     fit-margin-top="4"
     fit-margin-left="4"
     fit-margin-right="4"
     fit-margin-bottom="4" />
  <g
     id="layer1"
     inkscape:label="Layer 1"
     inkscape:groupmode="layer"
     transform="translate(-70.1527,-313.939)">
    <g
       id="g2393">
      <path
         id="path3202"
         d="m 400.22,320.94 c -49.018,0 -90.639,31.126 -105.66,74.406 -12.782,-5.6347 -27.01,-8.6875 -41.719,-8.6875 -52.862,0 -95.688,38.997 -95.688,87.125 0,0.58492 0.0187,1.1678 0.0312,1.75 -2.3682,-0.21862 -4.7582,-0.3125 -7.1875,-0.3125 -40.238,0 -72.844,30.692 -72.844,68.562 0,37.871 32.606,68.594 72.844,68.594 20.103,0 38.318,-7.6712 51.5,-20.062 20.164,13.959 51.04,22.906 85.656,22.906 37.384,0 70.373,-10.427 90.25,-26.344 14.054,20.938 39.394,34.906 68.312,34.906 32.484,0 60.407,-17.64 72.938,-42.969 61.213,-2.6109 109.91,-46.327 109.91,-99.875 0,-55.228 -51.812,-100 -115.72,-100 -4.349,0 -8.6193,0.22113 -12.844,0.625 -18.364,-35.956 -56.139,-60.625 -99.781,-60.625 z"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:6"
         inkscape:connector-curvature="0" />
      <path
         id="path2999"
         sodipodi:rx="95.714287"
         sodipodi:ry="87.14286"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px"
         sodipodi:type="arc"
         sodipodi:open="true"
         sodipodi:cy="473.79218"
         sodipodi:cx="252.85742"
         sodipodi:end="5.788877"
         sodipodi:start="2.932125"
         sodipodi:arc-type="arc"
         d="m 159.23528,491.91259 a 95.714287,87.14286 0 0 1 60.63223,-99.92348 95.714287,87.14286 0 0 1 117.24692,40.4605" />
      <path
         id="path3003"
         sodipodi:rx="110"
         sodipodi:ry="61.42857"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px"
         sodipodi:type="arc"
         sodipodi:open="true"
         sodipodi:cy="553.79077"
         sodipodi:cx="287.14285"
         sodipodi:end="3.0953226"
         sodipodi:start="0"
         sodipodi:arc-type="arc"
         d="M 397.14285,553.79077 A 110,61.42857 0 0 1 289.68748,615.2029 110,61.42857 0 0 1 177.26058,556.63206" />
      <path
         id="path2997"
         sodipodi:rx="72.85714"
         sodipodi:ry="68.571426"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px"
         sodipodi:type="arc"
         sodipodi:open="true"
         sodipodi:cy="543.79077"
         sodipodi:cx="150"
         sodipodi:end="5.2757057"
         sodipodi:start="6.088662"
         sodipodi:arc-type="arc"
         d="m 221.48305,530.53599 a 72.85714,68.571426 0 0 1 -43.26137,76.47284 72.85714,68.571426 0 0 1 -88.312044,-24.44306 72.85714,68.571426 0 0 1 7.611072,-86.34015 72.85714,68.571426 0 0 1 91.384522,-10.41121" />
      <path
         id="path3005"
         sodipodi:rx="80"
         sodipodi:ry="72.85714"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px"
         sodipodi:type="arc"
         sodipodi:open="true"
         sodipodi:cy="550.93359"
         sodipodi:cx="445.71429"
         sodipodi:end="4.1648647"
         sodipodi:start="5.8396447"
         sodipodi:arc-type="arc"
         d="M 517.97333,519.66767 A 80,72.85714 0 0 1 482.52897,615.6179 80,72.85714 0 0 1 376.00683,586.68269 80,72.85714 0 0 1 404.06829,488.72701" />
      <path
         id="path3007"
         sodipodi:rx="111.65392"
         sodipodi:ry="110"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px"
         sodipodi:type="arc"
         sodipodi:open="true"
         sodipodi:cy="430.93362"
         sodipodi:cx="400.22635"
         sodipodi:end="6.1140069"
         sodipodi:start="2.7816269"
         sodipodi:arc-type="arc"
         d="m 295.72845,469.68026 a 111.65392,110 0 0 1 22.86498,-113.79348 111.65392,110 0 0 1 113.64882,-30.33401 111.65392,110 0 0 1 78.04399,86.85987" />
      <path
         id="path3009"
         sodipodi:rx="115.71429"
         sodipodi:ry="100"
         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px"
         sodipodi:type="arc"
         sodipodi:open="true"
         sodipodi:cy="480.93362"
         sodipodi:cx="512.85712"
         sodipodi:end="2.1557112"
         sodipodi:start="3.845175"
         sodipodi:arc-type="arc"
         d="M 424.62156,416.23828 A 115.71429,100 0 0 1 584.171,402.18191 115.71429,100 0 0 1 606.73296,539.40042 115.71429,100 0 0 1 448.96797,564.30953" />
    </g>
  </g>
  <metadata
     id="metadata23">
    <rdf:RDF>
      <cc:Work>
        <dc:format>image/svg+xml</dc:format>
        <dc:type
           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
        <cc:license
           rdf:resource="http://creativecommons.org/publicdomain/zero/1.0/" />
        <dc:publisher>
          <cc:Agent
             rdf:about="http://openclipart.org/">
            <dc:title>Openclipart</dc:title>
          </cc:Agent>
        </dc:publisher>
      </cc:Work>
      <cc:License
         rdf:about="http://creativecommons.org/licenses/publicdomain/">
        <cc:permits
           rdf:resource="http://creativecommons.org/ns#Reproduction" />
        <cc:permits
           rdf:resource="http://creativecommons.org/ns#Distribution" />
        <cc:permits
           rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
      </cc:License>
    </rdf:RDF>
  </metadata>
</svg>
' /> <div style='position:relative;z-index:100;color:black;padding:18px;'>Subnet <br /> 10.1.1.0/24 </div>");
end
M2["Machine 2"]:::wht;
M1 --> CloudImgNode;
CloudImgNode --> M2;
end
%% Defining Class Styles
%% background-image:"" passes, but not with any text inside quotes
%% node that classes here get defined with "#graph-div " prepended!
%% however, seemingly <img> and such are included via foreignObject, so cannot refer to these classes
classDef BorderClass fill:#fff,stroke:#fff,stroke-width:4px,color:#fff,stroke-dasharray: 5 5,margin:0,padding:0;
classDef ContainerClass position:relative,padding:0,margin:0,fill:#fff,color:#000,stroke:none;
classDef ImgNodeClass fill:#fff,padding:0,margin:0,stroke:none,margin:0;
classDef wht fill:#fff,color:black,stroke:#000;
%%classDef BgImgClass display:block,position:absolute,left:0,top:0,width:100%;
%%classDef TxtClass display:block,position:absolute,z-index:100,left:0,top:0;
%%classDef InvisibleClass display:none;
%% Custom Styles
%% NOTE: this gets applied to <rect class="basic label-container",
%% not to the sigbling g<g class="label" or the enclosing <g id="flowchart-CloudImgNode-9174"
%% classdef node class; does however apply the class to the enclosing <g id="flowchart-CloudImgNode-9174" element
%%style CloudImgNode fill:#fff,padding:0,margin:0,stroke:none;
%%style CloudImgNode padding:100px,margin:100px;
%%<div class='TxtClass'>Subnet <br /> 10.1.1.0/24</div>
%% Assigning Nodes to Classes
class Border BorderClass;
%% Cannot add multiple classes separated with , (end up as single word)
%% or space (parser crashes)
%% but thankfully, multiple commands work: they do append classes
%%class DummyNode BgImgClass;
%%class DummyNode TxtClass;
%%class DummyNode InvisibleClass;
class CloudContainer ContainerClass;
%%class CloudImgNode BgImgClass;
%%class CloudImgNode TxtClass;
%% gets applied to all childer, too!
class CloudImgNode ImgNodeClass;
However, the PNG export from the Mermaid Live editor works - unfortunately, Github refuses to render the Markdown link from Mermaid Live editor works (probably because it is too long?): ... and Github even refuses to parse the standalone PNG link as an URL. In any case, I'll just post the changed line, just to point out how less readable everything becomes with each approach:
|
|
Another rework of the previous example, this time using FontAwesome - not even this renders in Github mermaid diagram: %%{init: {'theme':'base'}}%%
flowchart LR
subgraph Border
direction LR
M1["Machine 1"]:::wht;
subgraph CloudContainer[ ]
direction LR
%% text with <br> does not render with position:absolute
%% use img top and div padding to center text in image;
%% color:#c8c8c8 seems not to work here - must escape the # as #35;
CloudImgNode("<div style='position:absolute;left:8px;top:-20px;color:#35;bbb;font-size:80px;'>fa:fa-cloud</div> <div style='position:relative;z-index:100;color:black;padding:18px;'>Subnet <br /> 10.1.1.0/24 </div>");
end
M2["Machine 2"]:::wht;
M1 --> CloudImgNode;
CloudImgNode --> M2;
end
%% Defining Class Styles
%% background-image:"" passes, but not with any text inside quotes
%% node that classes here get defined with "#graph-div " prepended!
%% however, seemingly <img> and such are included via foreignObject, so cannot refer to these classes
classDef BorderClass fill:#fff,stroke:#fff,stroke-width:4px,color:#fff,stroke-dasharray: 5 5,margin:0,padding:0;
classDef ContainerClass position:relative,padding:0,margin:0,fill:#fff,color:#000,stroke:none;
classDef ImgNodeClass fill:#fff,padding:0,margin:0,stroke:none,margin:0;
classDef wht fill:#fff,color:black,stroke:#000;
%% Custom Styles
%% Assigning Nodes to Classes
%% class gets applied to all childer, too!
class Border BorderClass;
class CloudContainer ContainerClass;
class CloudImgNode ImgNodeClass;
At least PNG direct markdown link from Mermaid Live editor works - unfortunately, the alignment of the icon you see in the Live editor and the png below will not be the same (the below is tuned for PNG output) ... and at last I tried with the Unicode symbol for cloud - and this seems to work also in Github mermaid diagram: %%{init: {'theme':'base'}}%%
flowchart LR
subgraph Border
direction LR
M1["Machine 1"]:::wht;
subgraph CloudContainer[ ]
direction LR
%% text with <br> does not render with position:absolute
%% use img top and div padding to center text in image; color:#c8c8c8 seems not to work?
CloudImgNode("<div style='position:absolute;left:12px;top:-10px;color:#35;bbb;font-size:80px;'>#9729;#65039;</div> <div style='position:relative;z-index:100;color:black;padding:18px;'>Subnet <br /> 10.1.1.0/24 </div>");
end
M2["Machine 2"]:::wht;
M1 --> CloudImgNode;
CloudImgNode --> M2;
end
%% Defining Class Styles
%% background-image:"" passes, but not with any text inside quotes
%% node that classes here get defined with "#graph-div " prepended!
%% however, seemingly <img> and such are included via foreignObject, so cannot refer to these classes
classDef BorderClass fill:#fff,stroke:#fff,stroke-width:4px,color:#fff,stroke-dasharray: 5 5,margin:0,padding:0;
classDef ContainerClass position:relative,padding:0,margin:0,fill:#fff,color:#000,stroke:none;
classDef ImgNodeClass fill:#fff,padding:0,margin:0,stroke:none,margin:0;
classDef wht fill:#fff,color:black,stroke:#000;
%% Custom Styles
%% Assigning Nodes to Classes
%% class gets applied to all childer, too!
class Border BorderClass;
class CloudContainer ContainerClass;
class CloudImgNode ImgNodeClass;
|
|
@sdbbs Would you like to officially take this issue on? :) |
jgreywolf
added
Type: Enhancement
|
More information available in #1250 |
jgreywolf
added
Type: New Shape
|
Shape for actors |
|
I think svg support is definitely the route to go. Simple ones are extremely compact compared to rendered images so they can easily be embedded into the markdown. I am wanting a simple cloud shape as well but for now will have to just use a box. |
|
So it seems that the shapes are first created as points and added as functions. For Example, (flowchart shapes) notice the function found at: To Make a Trapezoid, notice the function on Line 120: function trapezoid(parent, bbox, node) {
const w = bbox.width;
const h = bbox.height;
const points = [
{ x: (-2 * h) / 6, y: 0 },
{ x: w + (2 * h) / 6, y: 0 },
{ x: w - h / 6, y: -h },
{ x: h / 6, y: -h },
];
const shapeSvg = insertPolygonShape(parent, w, h, points);
node.intersect = function (point) {
return intersectPolygon(node, points, point);
};
return shapeSvg;
}So make inorder to make new shape, there would need to be a need a way to convert a SVG code into js points. Example SVG: <svg width="100" height="100" xmlns="http://www.w3.org/2000/svg">
<polygon points="10,10 40,10 30,40" fill="none" stroke="black" />
<polyline points="50,10 70,10 70,30 50,30" fill="none" stroke="blue" />
</svg>Python script (untested): import xml.etree.ElementTree as ET
def parse_svg(svg_path):
"""Parse the SVG file and convert its shapes into JavaScript code."""
# Parse the SVG file
tree = ET.parse(svg_path)
root = tree.getroot()
for element in root.iter():
if element.tag.endswith('polygon'):
# Parse the points attribute into a list of coordinate tuples
points = [(float(x), float(y)) for x, y in (p.split(',') for p in element.get('points').split())]
# Get the bounding box width and height
w = max(p[0] for p in points) - min(p[0] for p in points)
h = max(p[1] for p in points) - min(p[1] for p in points)
# Convert points into JavaScript object literals
js_points = [
f"{{ x: {p[0]}, y: {p[1]} }}"
for p in points
]
# Create a JavaScript code snippet
js_code = f"const points = [{', '.join(js_points)}];"
print(f"JavaScript Code:\n{js_code}\n")
def parse_svg_file(svg_path):
"""Parse an SVG file and print JavaScript code for each shape."""
parse_svg(svg_path)
# Usage
parse_svg_file('example.svg')Example output: const points = [{ x: 10, y: 10 }, { x: 40, y: 10 }, { x: 30, y: 40 }];So out NEW function may look like this: function myNewShape(parent, bbox, node) {
const w = bbox.width;
const h = bbox.height;
const points = [
{ x: 10, y: 10 },
{ x: 40, y: 10 },
{ x: 30, y: 40 }
];
const shapeSvg = insertPolygonShape(parent, w, h, points);
node.intersect = function (point) {
return intersectPolygon(node, points, point);
};
return shapeSvg;
}Please let me know if this works?? |
|
example.svg: <svg width="100" height="100" xmlns="http://www.w3.org/2000/svg">
<polygon points="10,10 40,10 30,40" fill="none" stroke="black" />
<polyline points="50,10 70,10 70,30 50,30" fill="none" stroke="blue" />
</svg>Other script versions: Using PHP <?php
function parse_svg($svg_path) {
$xml = simplexml_load_file($svg_path);
foreach ($xml->children() as $element) {
$tag = strtolower($element->getName());
if ($tag === "polygon") {
$points = (string) $element['points'];
$point_pairs = explode(" ", $points);
$js_points = array_map(function ($pair) {
list($x, $y) = explode(",", $pair);
return "{ x: " . floatval($x) . ", y: " . floatval($y) . " }";
}, $point_pairs);
$js_code_content = implode(", ", $js_points);
echo "JavaScript Array Content:\n" . $js_code_content . "\n\n";
}
// Additional logic for other shape types can be added here
}
}
parse_svg('example.svg');
?>Script Functionality: SimpleXML: The script uses PHP's simplexml_load_file function to parse the SVG file. OR Using JS const fs = require('fs');
const { DOMParser } = require('xmldom');
function parseSVG(svgPath) {
// Read the SVG file as a string
const svgContent = fs.readFileSync(svgPath, 'utf8');
// Parse the SVG content into a DOM tree
const doc = new DOMParser().parseFromString(svgContent, 'text/xml');
const polygons = doc.getElementsByTagName('polygon');
for (let i = 0; i < polygons.length; i++) {
const points = polygons[i].getAttribute('points');
const pointPairs = points.split(' ');
const jsPoints = pointPairs.map(pair => {
const [x, y] = pair.split(',');
return `{ x: ${parseFloat(x)}, y: ${parseFloat(y)} }`;
});
const jsCodeContent = jsPoints.join(', ');
console.log(`JavaScript Array Content:\n${jsCodeContent}\n`);
}
}
// Usage
parseSVG('example.svg');Script Functionality: FS Module: The script uses Node.js's fs module to read the SVG file as a string. Output: Conclusion: |
|
Ah Fontawesome support is added. |
I would like to add a custom shape to my diagram, specifically a flow chart, but possibly other types?
I have an SVG file for it. Is there a simple way to add it as a shape in my diagrams, either by using it directly or converting it to another representation and then using it from there?
The text was updated successfully, but these errors were encountered: