🐯

Plotlyで出力したSVGの読み書きをするTips

2023/08/10 に公開

前回の記事でデータ個数によるグラフの違いを解説しました。
今回はSVG出力された画像から凡例とグラフを分けるTipsを紹介します。

SVGの操作はPython標準搭載のxmlライブラリを使用しました。
<a href="https://docs.python.org/ja/3/library/xml.etree.elementtree.html" style="" target="_blank" rel="nofollow noopener noreferrer">https://docs.python.org/ja/3/library/xml.etree.elementtree.html</a> <a class="header-anchor-link" href="#%E5%89%8D%E6%AE%B5%3A-%E5%89%8D%E5%9B%9E%E5%87%BA%E5%8A%9B%E3%81%97%E3%81%9F%E3%82%B0%E3%83%A9%E3%83%95" aria-hidden="true"/> 前段: 前回出力したグラフ</h2> 今回は以下コード（前回記事）で出力した画像を基に分割作業を行います。 <div class="code-block-container"><pre class="language-python"><code class="language-python">import numpy as np import plotly.graph_objects as go import plotly.io as pio N = 20 random_x = np.linspace(0, 1, N) random_y0 = np.random.randn(N) + 5 random_y1 = np.random.randn(N) plot = [ go.Scatter( mode="lines+markers", x=random_x, y=random_y0, name="sampleA", line=dict(color="blue", dash="solid"), marker=dict(symbol="circle-open"), go.Scatter( mode="lines+markers", x=random_x, y=random_y1, name="sampleB", line=dict(color="red", dash="solid"), marker=dict(symbol="circle-open"), fig = go.Figure(data=plot) # SVG出力 pio.write_image(fig, "./output.svg", format="svg") </code></pre></div>出力された画像はこちら この画像から凡例とグラフを別々に出力したいと思います。 <a class="header-anchor-link" href="#%E7%94%BB%E5%83%8F%E3%81%AE%E6%A7%8B%E6%88%90%E8%A6%81%E7%B4%A0%E3%82%92%E7%A2%BA%E8%AA%8D%E3%81%99%E3%82%8B" aria-hidden="true"/> 画像の構成要素を確認する</h2> 画像の要素をデベロッパーツールで解析します。 凡例のところだけ切り抜くと以下のようになります。 &lt;!-- レイアウト情報 --&gt; &lt;g class="infolayer"&gt; &lt;!-- 凡例関係 --&gt; &lt;g class="legend"&gt; &lt;rect class="bg"&gt;&lt;/rect&gt; &lt;g class="scrollbox"&gt; &lt;g class="groups"&gt; &lt;!-- ここに凡例の各要素が格納されている --&gt; &lt;g class="traces"&gt;&lt;/g&gt; &lt;g class="traces"&gt;&lt;/g&gt; &lt;rect class="scrollbar"&gt;&lt;/rect&gt; &lt;/svg&gt; </code></pre></div><code>infolayer→legend</code> の順で掘っていければ目的の凡例に辿り着けそうです。 <a class="header-anchor-link" href="#%E5%87%A1%E4%BE%8B%E5%87%BA%E5%8A%9B%E7%94%A8%E3%81%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88%E3%82%92%E6%BA%96%E5%82%99%E3%81%99%E3%82%8B" aria-hidden="true"/> 凡例出力用のテンプレートを準備する</h2> 凡例の位置は画像からの絶対値で決まっているようです。 <code>&lt;g class="legend" ... transform="translate(*,*)"&gt;</code>の translate は不要のため テンプレートを準備し、そこに取得した要素を挿入する形にしました。 そのテンプレートがこちらです。 <code>width, height</code>は環境に合わせて適宜修正してください。 class="main-svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="700" height="500" style="" viewBox="0 0 700 500" &lt;g class="infolayer"&gt; &lt;g class="legend" pointer-events="all"&gt;&lt;/g&gt; &lt;/svg&gt; <a class="header-anchor-link" href="#svg%E3%82%92xml%E3%81%A8%E3%81%97%E3%81%A6%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8B" aria-hidden="true"/> SVGをXMLとして読み取る</h2> SVGをXMLとして読み込みます。 画像は上で紹介した<code>./output.svg</code>です。 <div class="code-block-container"><pre class="language-python"><code class="language-python">import xml.etree.ElementTree as ET from pathlib import Path input_path = Path("./output.svg") tree = ET.parse(input_path) # 要素を取得 root = tree.getroot() print(root) # &lt;Element '{http://www.w3.org/2000/svg}svg' at *********&gt; </code></pre></div><code>root</code>が要素のルートになります。 ここから検索して目的の凡例を取得します。 <a class="header-anchor-link" href="#%E5%87%A1%E4%BE%8B%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B" aria-hidden="true"/> 凡例を取得する</h2> 凡例の要素を取得します。 gタグは<code>{http://www.w3.org/2000/svg}g</code>で要素検索が可能です。 <code>SVG読込→レイアウト検索→凡例検索→要素取得</code> の順番です。 <div class="code-block-container"><pre class="language-python"><code class="language-python">import xml.etree.ElementTree as ET from pathlib import Path # xmlで読み込んだgタグ SVG_G_TAG = "{http://www.w3.org/2000/svg}g" input_path = Path("./output.svg") tree = ET.parse(input_path) root = tree.getroot() # 大元gタグからレイアウト情報取得 g_elems = root.findall(SVG_G_TAG) info_elems = next(filter(lambda x: x.attrib["class"] == "infolayer", g_elems)) # レイアウト情報から凡例取得 layer_elems = info_elems.findall(SVG_G_TAG) legend_elems = next(filter(lambda x: x.attrib["class"] == "legend", layer_elems)) </code></pre></div>findall()でgタグを全て取得します。 その後、<code>next*filter</code>を使用しgタグの中からレイアウト情報と凡例それぞれのクラス名で検索し、要素を特定します。 これで<code>&lt;g class="legend"&gt;...&lt;/g&gt;</code>が取得できました。 <a class="header-anchor-link" href="#%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88%E3%81%AB%E8%A6%81%E7%B4%A0%E3%82%92%E8%BF%BD%E5%8A%A0%E3%81%99%E3%82%8B" aria-hidden="true"/> テンプレートに要素を追加する</h2> 取得できた要素をテンプレートに追加します。 まずは読み込みと凡例の箇所まで検索します。 <div class="code-block-container"><pre class="language-python"><code class="language-python">import xml.etree.ElementTree as ET from pathlib import Path template_path = Path("./legend_template.svg") template_tree = ET.parse(template_path) template_root = template_tree.getroot() # 凡例のタグを取得 template_legend = template_root.find(f"{SVG_G_TAG}/{SVG_G_TAG}") if template_legend is None: raise </code></pre></div>findメソッドは検索条件に一致する要素を取得します。 結果は<code>Optional</code>なので、一度None判定を入れて型アノテーションを確定させます。 その後、テンプレートの凡例に対して要素を追加します。 追加するにはappendメソッドを使用します。 <div class="code-block-container"><pre class="language-python"><code class="language-python"># テンプレートに凡例を追加 [template_legend.append(elem) for elem in legend_elems] </code></pre></div><code>legend_elems</code>が元画像から取得した凡例要素です。 リストの内包表記で凡例以下のタグを全て追加します。 <a class="header-anchor-link" href="#%E5%87%A1%E4%BE%8B%E7%94%BB%E5%83%8F%E5%87%BA%E5%8A%9B" aria-hidden="true"/> 凡例画像出力</h2> 凡例画像を出力します。 しかし、そのまま出力すると<code>ns:0</code>という<code>Namespace</code>が追加されてしまいます。 そのため、<a href="https://zenn.dev/soh92/articles/f20994e755974f" target="_blank">こちらの記事</a>を参考に<code>ns:0</code>を追加しないように上書きします。 <iframe id="zenn-embedded__b1e3ac5db69bd" src="https://embed.zenn.studio/card#zenn-embedded__b1e3ac5db69bd" data-content="https%3A%2F%2Fzenn.dev%2Fsoh92%2Farticles%2Ff20994e755974f" frameborder="0" scrolling="no" loading="lazy"/><a href="https://zenn.dev/soh92/articles/f20994e755974f" style="" target="_blank">https://zenn.dev/soh92/articles/f20994e755974f</a> # 結果反映 template_tree = ET.ElementTree(template_root) # ns:0対策 namespaces = { node[0]: node[1] for _, node in ET.iterparse(template_path, events=["start-ns"]) for key, value in namespaces.items(): ET.register_namespace(key, value) # 凡例出力 legend_output_path = Path("./legend.svg") template_tree.write(legend_output_path) </code></pre></div>出力された画像を確認します。 凡例だけ切り抜くことに成功しました。 <a class="header-anchor-link" href="#%E5%85%83%E7%94%BB%E5%83%8F%E3%81%8B%E3%82%89%E5%87%A1%E4%BE%8B%E3%82%92%E5%89%8A%E9%99%A4" aria-hidden="true"/> 元画像から凡例を削除</h2> 元画像から凡例部分を削除して出力します。 要素の削除にはremoveメソッドを使用します。 <div class="code-block-container"><pre class="language-python"><code class="language-python"># 凡例部分削除 info_elems.remove(legend_elems) # 変更反映 tree = ET.ElementTree(root) # xmlタグ対策 target_namespaces = { node[0]: node[1] for _, node in ET.iterparse(input_path, events=["start-ns"]) for key, value in target_namespaces.items(): ET.register_namespace(key, value) # 凡例を切り取ったグラフ出力 graph_output_path = Path("./graph.svg") tree.write(graph_output_path) </code></pre></div>グラフの画像を確認します。 凡例が切り取られているのが確認できました！ <a class="header-anchor-link" href="#%E5%AE%9F%E8%A3%85%E3%82%B3%E3%83%BC%E3%83%89" aria-hidden="true"/> 実装コード</h2> 上記の処理の実装コードです。 <div class="code-block-container"><pre class="language-python"><code class="language-python">import xml.etree.ElementTree as ET from pathlib import Path # xmlで読み込んだgタグ SVG_G_TAG = "{http://www.w3.org/2000/svg}g" input_path = Path("./output.svg") template_path = Path("./legend_template.svg") tree = ET.parse(input_path) root = tree.getroot() # 大元gタグから情報レイヤー取得 g_elems = root.findall(SVG_G_TAG) info_elems = next(filter(lambda x: x.attrib["class"] == "infolayer", g_elems)) # 情報一覧から凡例取得 layer_elems = info_elems.findall(SVG_G_TAG) legend_elems = next(filter(lambda x: x.attrib["class"] == "legend", layer_elems)) template_tree = ET.parse(template_path) template_root = template_tree.getroot() # 凡例のタグを取得 template_legend = template_root.find(f"{SVG_G_TAG}/{SVG_G_TAG}") if template_legend is None: raise # テンプレートに凡例を追加 [template_legend.append(elem) for elem in legend_elems] # 結果反映 template_tree = ET.ElementTree(template_root) # ns:0対策 namespaces = { node[0]: node[1] for _, node in ET.iterparse(template_path, events=["start-ns"]) for key, value in namespaces.items(): ET.register_namespace(key, value) # 凡例出力 legend_output_path = Path("./legend.svg") template_tree.write(legend_output_path) # 凡例部分削除 info_elems.remove(legend_elems) # 変更反映 tree = ET.ElementTree(root) # ns:0対策 target_namespaces = { node[0]: node[1] for _, node in ET.iterparse(input_path, events=["start-ns"]) for key, value in target_namespaces.items(): ET.register_namespace(key, value) # 凡例を切り取ったグラフ出力 graph_output_path = Path("./graph.svg") tree.write(graph_output_path) <a class="header-anchor-link" href="#svg%E3%81%AFxml%E3%81%A8%E3%81%97%E3%81%A6%E6%93%8D%E4%BD%9C%E5%8F%AF%E8%83%BD" aria-hidden="true"/> SVGはXMLとして操作可能</h2> plotlyから凡例を切り取る方法を紹介しました。 SVGはXMLとして読み込んで処理ができる事を発見したので

SVG 出力したグラフから凡例を切り取りたい…