export

ライブ スクリプトまたは関数を標準形式に変換

R2022a 以降

構文

path = export(file)

path = export(file,outputfile)

path = export(___,Name=Value)

説明

path = export(file) は、指定されたライブ スクリプトまたは関数を同じ名前の PDF ファイルに変換し、変換後のファイルの絶対パスを返します。変換されたファイルは、ライブ エディターで出力をインライン表示した場合のライブ スクリプトまたは関数とほぼ同じ外観です。ライブ スクリプトにコントロールまたはタスクが含まれている場合、ライブ エディターはそれらをコードとして変換後のファイルに保存します。

この構文は、変換後のファイルを現在のフォルダーに保存します。既定では、export は変換後のファイルの作成時に、matlab.editor エクスポート設定で指定された値を使用します。

path = export(file,outputfile) は、変換後のファイルのファイル名と場所を指定します。outputfile にファイル拡張子が含まれている場合、関数 export はライブ スクリプトまたは関数をその形式に変換します。

path = export(___,Name=Value) は、前述の構文にある入力引数の組み合わせに加え、1 つ以上の名前と値の引数を使用して変換後のファイルをカスタマイズするオプションを指定します。たとえば、指定したファイルを PDF ファイルではなく Microsoft^® Word ドキュメントに変換したり、コードを非表示にするかどうかを指定したり、変換後のファイルの用紙サイズとページの向きを調整したりできます。

例

ライブ スクリプトの PDF ファイルへのエクスポート

ライブ スクリプトをコード、出力、および書式設定されたテキストを含む PDF ファイルに変換し、現在のフォルダーに保存します。

export("myscript.mlx")

ans =
    'C:\myfiles\myscript.pdf'

ライブ スクリプトの Microsoft Word ドキュメントへのエクスポート

ライブ スクリプトをコード、出力、および書式設定されたテキストを含む Microsoft Word ドキュメントに変換します。

wordfile = export("myscripts\myscript.mlx","myconvertedfiles\livescripts\myscript.docx")

wordfile =
    'C:\myfiles\myconvertedfiles\livescripts\myscript.docx'

ライブ スクリプトのマークダウン ファイルへのエクスポート

ライブ スクリプトをマークダウン ファイルに変換します。まず、イメージおよび Figure を埋め込まない場合について説明し、次に埋め込む場合について説明します。

myscript.mlx をマークダウン ファイルに変換します。既定では、イメージおよび Figure はマークダウン ファイル内に埋め込まれません。MATLAB^® はマークダウン ファイルと、ライブ スクリプトから生成されたイメージおよび Figure を含む myscript_media という名前のフォルダーを作成します。

mdfile = export("myscript.mlx",Format="markdown")

mdfile =
    'C:\myfiles\myscript.md'

myscript.mlx を、HTML マークアップや埋め込みイメージおよび Figure を含むマークダウン ファイルに変換します。このカスタマイズは、変換後のファイルを使用する予定のアプリケーションで HTML マークアップや埋め込みイメージおよび Figure がサポートされている場合に役立ちます。

mdfile = export("myscript.mlx",Format="markdown",EmbedImages=true, ...
    AcceptHTML=true)

mdfile =
    'C:\myfiles\myscript.md'

変換後のファイルのカスタマイズ

名前と値の引数を使用してコードを非表示にし、変換後のファイルのページ サイズと向きを変更します。

wordfile = export("myscript.mlx","C:\Work\myfiles\myscript.docx", ...
    HideCode=true,PageSize="A4",Orientation="Landscape")

wordfile =
    'C:\Work\myfiles\myscript.docx'

入力引数

file — 変換するライブ スクリプトまたは関数の名前

string スカラー | 文字ベクトル

変換するライブ スクリプトまたは関数の名前。string スカラーまたは文字ベクトルとして指定します。file は絶対パスまたは相対パスとして指定します。file が MATLAB パス上にない場合は、.mlx 拡張子を含めます。

outputfile — 変換後のファイルの名前

string スカラー | 文字ベクトル

変換後のファイルの名前。string スカラーまたは文字ベクトルとして指定します。outputfile は絶対パスまたは相対パスとして指定します。outputfile で指定する保存先フォルダーは存在しなければならず、書き込み可能でなければなりません。

export は、outputfile のファイル拡張子を使用して変換後のファイルの形式を判別します。たとえば、outputfile の拡張子が .docx である場合、export はライブ スクリプトまたは関数を Microsoft Word ドキュメントに変換します。

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。ここで Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。

例: path = export("myfiles/mylivescript.mlx",Format="docx")

出力オプション

Format — 出力形式

"pdf" (既定値) | "html" | "docx" | "latex" | "m" | "markdown" | "ipynb"

出力形式。次の表内の値のいずれかとして指定します。

値	出力形式	既定のファイル拡張子
"pdf" (既定)	Portable Document Format (PDF)	.pdf
"html"	ハイパーテキスト マークアップ言語	.html
"docx"	Microsoft Word ドキュメント	.docx
"latex"	LaTeX	.tex
"m"	MATLAB コード ファイル	.m
"markdown" (R2023b 以降)	マークダウン ファイル	.md
"ipynb" (R2023b 以降)	Jupyter® Notebook	.ipynb

Format は outputfile で指定された形式よりも優先されます。outputfile にファイル拡張子が含まれていない場合、export は指定された Format の既定のファイル拡張子を使用します。

LaTeX へのエクスポート時に個別の matlab.sty ファイルが存在していない場合、MATLAB はそのファイルを出力ドキュメントと同じフォルダー内に作成します。LaTeX スタイル ドキュメントとしても知られている STY ファイルを使用すると、出力ドキュメントの外観をきめ細かく制御できます。

例: path = export("myfiles/mylivescript.mlx","myfiles/outfile.xml",Format="html") は、拡張子が .xml の HTML ファイルを作成します。

OpenExportedFile — 変換後のファイルを開くかどうか

false または 0 (既定値) | true または 1

変換後のファイルを作成後に開くかどうか。数値または logical 0 (false) または 1 (true) として指定します。

例: path = export("myfiles/mylivescript.mlx",OpenExportedFile=true)

PageSize — ページ サイズ

"Letter" | "Legal" | "Tabloid" | "A2" | "A3" | "A4" | "A5"

変換後のファイルのページ サイズ。次の表に示す標準的な用紙タイプの値のいずれかとして指定します。

値	用紙サイズ (幅×高さ)
"Letter"	8.5×11 インチ (米国での既定値)
"Legal"	8.5×14 インチ
"Tabloid"	11×17 インチ
"A2"	42×59.4 cm
"A3"	29.7×42 cm
"A4"	21×29.7 cm (ヨーロッパおよびアジアでの既定値)
"A5"	14.8×21 cm

このオプションは、Microsoft Word ドキュメント、PDF ファイル、または LaTeX ファイルに変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx",PageSize="Legal")

Orientation — ページの向き

"Portrait" (既定値) | "Landscape"

変換後のファイルのページの向き。"Portrait" または "Landscape" として指定します。

このオプションは、Microsoft Word ドキュメント、PDF ファイル、または LaTeX ファイルに変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx",Orientation="Landscape")

Margins — ドキュメントの余白

[72 72 72 72] (既定値) | 1 行 4 列のベクトル

変換後のファイルのドキュメントの余白。余白値の 1 行 4 列のベクトルとして、[left top right bottom] という形式で指定します。余白値はそれぞれ、ポイント単位で、0 ～ 255 の正の整数として指定します。72 ポイントの値は、1 インチまたは 2.54 cm と等価です。

このオプションは、Microsoft Word ドキュメント、PDF ファイル、または LaTeX ファイルに変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx",Margins=[25 72 72 25])

IncludeOutputs — 出力を含めるかどうか

true または 1 (既定値) | false または 0

R2023b 以降

出力を変換後のファイルに含めるかどうか。数値または logical 1 (true) または 0 (false) として指定します。

このオプションは、マークダウン ファイルまたは Jupyter Notebook に変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.md",IncludeOutputs=false)

コードのオプション

Run — コードを実行するかどうか

false または 0 (既定値) | true または 1

コードを実行して出力を変換後のファイルに含めるかどうか。数値または logical 0 (false) または 1 (true) として指定します。

Run を true に設定して export を実行することは、ライブ エディターではサポートされていません。Run を true に設定して export を実行するには、コマンド ウィンドウまたはエディターを使用してください。

例: path = export("myfiles/mylivescript.mlx",Run=true)

CatchError — エラーをキャッチするかどうか

true または 1 (既定値) | false または 0

変換時にライブ スクリプトまたは関数の実行中のエラーをキャッチするかどうか。数値または logical 1 (true) または 0 (false) として指定します。CatchError が true でエラーが発生した場合、export は変換後のファイルにエラーを含めます。CatchError が false でエラーが発生した場合、export はエラーをコマンド ウィンドウに表示し、変換後のファイルを作成しません。

例: path = export("myfiles/mylivescript.mlx",CatchError=false)

HideCode — コードを非表示にするかどうか

true または 1 | false または 0

コードを非表示にするかどうか。数値または logical 1 (true) または 0 (false) として指定します。HideCode が true の場合、ライブ スクリプトまたは関数のコードは変換後のファイルで非表示になります (含まれません)。HideCode が false の場合、コードは含まれます。このオプションを指定しない場合、export はライブ スクリプトまたは関数の現在の保存された状態を使用して、変換後のファイルでコードを非表示にするかどうかを判別します。たとえば、指定したライブ スクリプトまたは関数が最後に保存された際にコードが非表示になっていた場合、コードは変換後のファイルでも非表示になります。

メモ

PDF、Microsoft Word、HTML、LaTeX、マークダウン、または Jupyter Notebook にエクスポートする場合、ライブ エディターはコントロールおよびタスクをコードとして保存します。コントロールおよびタスクが含まれているライブ スクリプトがあり、エクスポート前にコードを非表示にした場合、変換後のファイルにはコントロールもタスクも含まれません。

例: path = export("myfiles/mylivescript.mlx",HideCode=false)

ProgrammingLanguage — コードのプログラミング言語

"matlab" (既定値) | string スカラー | 文字ベクトル

R2023b 以降

変換するコードのプログラミング言語。string スカラーまたは文字ベクトルとして指定します。サポートされている言語には "matlab" と "python" があります。

このオプションは、マークダウン ファイルまたは Jupyter Notebook に変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.md",ProgrammingLanguage="python")

AcceptHTML — HTML を含めるかどうか

false または 0 (既定値) | true または 1

R2023b 以降

HTML を変換後のファイルに含めるかどうか。数値または logical 0 (false) または 1 (true) として指定します。変換後のファイルを使用する予定のアプリケーションで HTML がサポートされている場合は、AcceptHTML を 1 または true に設定します。AcceptHTML が 0 または false の場合、タイトルの色、イメージの配置、およびイメージと Figure のサイズは変換後のファイルで維持されません。

このオプションは、マークダウン ファイルに変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.md",AcceptHTML=true)

RenderLaTeXOnline — 外部オンライン サービスを使用して LaTeX マークアップをレンダリングするかどうか

"off" (既定値) | "svg" | "png" | "jpeg"

R2023b 以降

外部オンライン サービスを使用して LaTeX マークアップをレンダリングするかどうか。次のいずれかのオプションとして指定します。

• "off" (既定の設定) — LaTeX および TeX マークアップをレンダリングしません。多くのマークアップ レンダラーで LaTeX および TeX マークアップをネイティブにレンダリングできるため、関数 export でマークアップをレンダリングする必要はありません。

• "svg" — 外部オンライン サービスを使用して LaTeX および TeX マークアップをレンダリングし、レンダリングされたマークアップの SVG イメージを生成します。

• "png" — 外部オンライン サービスを使用して LaTeX および TeX マークアップをレンダリングし、レンダリングされたマークアップの PNG イメージを生成します。

• "jpeg" — 外部オンライン サービスを使用して LaTeX および TeX マークアップをレンダリングし、レンダリングされたマークアップの JPEG イメージを生成します。

RenderLaTeXOnline を "svg"、"png"、または "jpeg" に設定する場合、関数 export が生成されたイメージを変換後のファイルに挿入できるようにするために、AcceptHTML を true に設定する必要があります。

このオプションは、マークダウン ファイルに変換する場合にのみ使用できます。

メモ

既定では、export は外部オンライン サービスを使用して LaTeX マークアップをレンダリングしません。RenderLaTeXOnline を "svg"、"png"、または "jpeg" として指定した場合、export は https://latex.codecogs.com/ 外部オンライン サービスを使用して LaTeX マークアップをレンダリングします。

例: path = export("myfiles/mylivescript.mlx","mylivescript.md",RenderLaTeXOnline="svg")

メディア オプション

FigureFormat — 図の形式

"png" | "jpeg" | "bmp" | "svg" | "eps" | "pdf"

変換後のファイルにおける出力図の形式。"png"、"jpeg"、"bmp"、"svg"、"eps" または "pdf" として指定します。既定では、PDF ファイル、マークダウン ファイル、および Jupyter Notebook のこの名前と値の引数の値は "png" です。LaTeX ファイルの場合、既定値は "eps" です。

このオプションは、PDF ファイル、LaTeX ファイル、マークダウン ファイル、または Jupyter Notebook に変換する場合にのみ使用できます。また、このオプションを有効にするには、名前と値の引数 Run を true にする必要があります。

例: path = export("myfiles/mylivescript.mlx",Run=true,FigureFormat="jpeg")

FigureResolution — 図の解像度

600 (既定値) | 正の整数

変換後のファイルにおける出力図の解像度。DPI 単位で、36 ～ 2880 の正の整数で指定します。

このオプションは、PDF ファイル、LaTeX ファイル、マークダウン ファイル、または Jupyter Notebook に変換する場合にのみ使用できます。また、このオプションを有効にするには、名前と値の引数 Run を true にする必要があります。

例: path = export("myfiles/mylivescript.mlx",Run=true,FigureResolution=800)

EmbedImages — イメージおよび Figure を埋め込むかどうか

false または 0 (既定値) | true または 1

R2023b 以降

変換後のファイルにイメージおよび Figure を埋め込むかどうか。数値または logical 0 (false) または 1 (true) として指定します。EmbedImages が true の場合、イメージおよび Figure は変換後のファイルに保存されます。EmbedImages が false の場合、イメージおよび Figure は別個のフォルダーに保存されます。このフォルダーは変換後のファイルと同じフォルダーにあり、フォルダー名は変換するファイルの名前に "_media" を追加したものになります。

このオプションは、マークダウン ファイルまたは Jupyter Notebook に変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.md",EmbedImages=true)

GenerateFigureAnimationVideo — Figure のアニメーションをビデオとしてエクスポートするかどうか

false または 0 (既定値) | true または 1

R2023b 以降

Figure のアニメーションをビデオとしてエクスポートするかどうか。数値または logical 0 (false) または 1 (true) として指定します。GenerateFigureAnimationVideo が true の場合は、FigureAnimationVideoFormat に値を指定する必要もあります。

このオプションは、Windows^® および macOS システムで HTML ファイルに変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.html",GenerateFigureAnimationVideo=true,FigureAnimationVideoFormat="MPEG-4")

FigureAnimationVideoFormat — 生成されるビデオの形式

"MPEG-4"

R2023b 以降

生成されるビデオの形式。"MPEG-4" として指定します。このオプションを有効にするには、GenerateFigureAnimationVideo を true に設定しなければなりません。

このオプションは、Windows および macOS システムで HTML ファイルに変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.html",GenerateFigureAnimationVideo=true,FigureAnimationVideoFormat="MPEG-4")

MediaLocation — 生成されたビデオを保存する場所

string スカラー | 文字ベクトル

R2023b 以降

生成されたビデオを保存する場所。string スカラーまたは文字ベクトルとして指定します。MediaLocation は絶対パスまたは相対パスとして指定します。MediaLocation を指定しなかった場合、export は生成されたビデオを file_media という名前のフォルダーに保存します。ここで、file は変換するライブ スクリプトまたは関数の名前です。

このオプションは、Windows および macOS システムで HTML ファイル、LaTeX ファイル、マークダウン ファイル、または Jupyter Notebook に変換する場合にのみ使用できます。

例: path = export("myfiles/mylivescript.mlx","mylivescript.html",GenerateFigureAnimationVideo=true,FigureAnimationVideoFormat="MPEG-4",MediaLocation="myfiles/mymedia")

バージョン履歴

R2022a で導入

R2024a: 名前と値の引数 AcceptHTML および EmbedImages が既定で false

名前と値の引数 AcceptHTML および EmbedImages の既定値が false または 0 になりました。以前は、これらの名前と値の引数の既定値は true または 1 でした。マークダウン ファイルに変換する際に HTML マークアップを含めるには、AcceptHTML を true に設定します。マークダウン ファイルまたは Jupyter Notebook に変換する際にイメージおよび Figure を埋め込むには、EmbedImages を true に設定します。

R2023b: Figure のアニメーションを Windows および macOS システムにビデオとして保存

HTML にエクスポートする場合に、名前と値の引数 GenerateFigureAnimationVideo、FigureAnimationVideoFormat、および MediaLocation を使用して、Figure のアニメーションをビデオとして保存できます。Figure のアニメーションのビデオとしての保存は、Windows および macOS システムでのみサポートされています。

たとえば、ライブ スクリプト mylivescript.mlx を HTML に変換し、mylivescript.mlx で生成された Figure のアニメーションを MPEG-4 ビデオとして保存します。

path = export("myfiles/mylivescript.mlx","mylivescript.html", ...
  GenerateFigureAnimationVideo=true,FigureAnimationVideoFormat="MPEG-4", ...
  MediaLocation="myfiles/mymedia")

R2023b: マークダウン ファイルと Jupyter Notebook へのライブ スクリプトおよび関数の変換

拡張子が .md または .ipynb の出力ファイル名を指定することで、ライブ スクリプトおよび関数をマークダウン ファイルおよび Jupyter Notebook に変換できます。あるいは、名前と値の引数 Format を "markdown" または "ipynb" に設定することもできます。

たとえば、ライブ スクリプト penny.mlx をマークダウン ファイルおよび Jupyter Notebook に変換します。

export("penny.mlx","penny.md")
export("penny.mlx","penny.ipynb")

参考

設定

• matlab.editor 設定

関数

• publish

トピック

• ライブ スクリプトと関数を共有およびエクスポートする方法
• ライブ エディターでライブ スクリプトを作成