開発者リファレンス

どれを使えばいい？

どれも、あなたのマシンの、あなたのプロセスの中で動きます。Node.js 版は裏のスレッドで変換するので、イベントループは止まりません。Python 版は変換中に GIL を手放します。サーバーもアカウントも通信も要りません。

コマンド：docsvg

形式はファイルの拡張子で決まります。拡張子がないときや汎用的なときは、ファイルの先頭の内容も見て判断します。成功すると終了コード0、失敗すると1で終わり、理由を標準エラーに出します。

docsvg <INPUT> --output <FOLDER> [options]
docsvg reverse <SVG or FOLDER> --output <FILE>
docsvg transform <SVG or -> --output <SVG or -> [options]

変換：docsvg <INPUT> --output <FOLDER>

書き戻し：docsvg reverse

整形：docsvg transform

すべての入出力形式 →

変換で書き出されるもの

出力先は新しいフォルダか空のフォルダでなければいけません。既存のファイルを上書きすることはありません。conversion.json は変換全体の記録です。convert() や preview() の戻り値にも同じ項目が入ります（Node.js ではキャメルケースの名前になります）。

out/
├── page-0001.svg
├── page-0002.svg
└── conversion.json

Node.js

エラーは Promise の reject として届きます。Error のメッセージは問題の種類で始まります（"invalid input"、"unsupported input"、"safety limit exceeded"、"I/O error"）。

const { convert, preview, reverse, transform } = require('document-svg')

async function main() {
  const result = await preview('slides.pptx', { maxPages: 50 })
  console.log(result.pageCount, result.needsReview)
  const firstPageSvg = result.pages[0].svg

  const report = await convert('slides.pptx', 'out/slides', { jobs: 2 })
  await reverse('out/slides', 'slides-copy.pptx')
  const small = transform(firstPageSvg, { minify: true })
}

main().catch(console.error)

preview() と convert() のオプション

transform() のオプション

document-svg/preview-ui（ブラウザで動きます。ネイティブコードなし）

プレビューの手順ガイド →npm のパッケージページ →

Python

インストールは document-svg、import は document_svg です。戻り値は conversion.json と同じ項目を持つ普通の辞書です。

from document_svg import convert, preview, reverse, transform

result = preview("report.docx", max_pages=50)
print(result["page_count"], result["needs_review"])
first_page_svg = result["pages"][0]["svg"]

report = convert("report.docx", "out/report", jobs=2)
reverse("out/report", "report-copy.docx")
small = transform(first_page_svg, minify=True)

preview() と convert() のオプション（キーワード引数）

例外

PyPI のパッケージページ →

Rust

公開APIは、クレートの直下（上の関数、そのオプションとレポートの型、Error）と ir・svg モジュールだけです。内部の読み込み処理はリリースごとに変わりえます。

use document_svg::{convert_path, ConvertOptions};

fn main() -> Result<(), document_svg::Error> {
    let options = ConvertOptions { jobs: 2, ..ConvertOptions::default() };
    let report = convert_path("report.pdf", "out/report", &options)?;
    println!("{} pages, {} warnings", report.page_count, report.warnings.len());
    Ok(())
}

ConvertOptions の項目

Error の種類

docs.rs のAPIドキュメント →crates.io のページ →

Webページで表示する

できます。ページはふつうのSVG画像なので、どのブラウザでも表示できます。画面に出す方法は2つあります。

1. サーバーや Electron のメインプロセスで Node.js を使って変換し、SVGを画面に送り、preview-ui で表示します（Node.js の節とプレビューガイドを参照）。対応しているすべての形式で使えます。

2. WebAssembly 版でブラウザの中だけで変換し、用意された <docsvg-viewer> 要素で表示します。アップロードもサーバーも要りません。対象は PDF、Word、Excel、PowerPoint で、サムネイル、拡大縮小、幅・ページに合わせる、回転、全画面、文字検索、表示中のページの保存ができます。

<script type="module" src="/bindings/wasm/web/docsvg-viewer.js"></script>
<docsvg-viewer thumbnails></docsvg-viewer>

<script type="module">
  const viewer = document.querySelector('docsvg-viewer')
  viewer.options = { maxPages: 200 }          // optional limits
  fileInput.addEventListener('change', () => viewer.openFile(fileInput.files[0]))
</script>

<docsvg-viewer> の早見表

• WebAssembly 版はパッケージとして配布していません。bindings/wasm からビルドし（Rust と wasm-bindgen が必要）、bindings/wasm/web を自分のサイトから配信します。
• HTTP で配信してください。file:// で開いても動きません。Content-Security-Policy を使うなら、script に 'wasm-unsafe-eval'、worker に 'self' が必要です。
• ページは <img> の Blob URL で表示され、ビューアが文書のSVGをページに差し込むことはありません。

ブラウザでビューアを試す →ビューアのビルドと配置の方法 →

上限の一覧

どの上限も、巨大なファイルや壊れたファイルからマシンを守るためのものです。用途に合わせて下げるのはかまいません。難しいファイルを通すためだけに上げないでください。

安全性と限界 →