最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

リンクの作成

次の種類のリンクをレポートに追加できます。

  • 外部 - レポートの外部の場所 (HTML ページや PDF ファイルなど) へのリンク。mlreportgen.dom.ExternalLink オブジェクトを使用します。

  • 内部 - レポート内の場所へのリンク。mlreportgen.dom.InternalLink オブジェクトを使用します。

リンク ターゲットの作成

InternalLink オブジェクトのリンク ターゲットを指定するには、mlreportgen.dom.LinkTarget オブジェクトの Name プロパティの値を使用します。ExternalLink オブジェクトを作成する場合、LinkTarget オブジェクトの Name の値または URL を使用できます。

この例では、home というリンク ターゲットを作成し、内部リンクのターゲットとして home を使用します。

import mlreportgen.dom.*
d = Document('mydoc');

append(d,LinkTarget('home'));
append(d,InternalLink('home','Go to Top'));

close(d);
rptview(d.OutputPath);

外部リンクの作成

mlreportgen.dom.ExternalLink オブジェクトを使用し、リンク ターゲットとリンク テキストを指定することで、外部リンクを作成します。

import mlreportgen.dom.*
d = Document('mydoc');

append(d,ExternalLink('https://www.mathworks.com/','MathWorks'));

close(d);
rptview('mydoc','html');

内部リンクの作成

レポート内の場所に対するリンクを設定するには、mlreportgen.dom.InternalLink オブジェクトをドキュメントまたはドキュメント要素に追加します。リンク先のドキュメント要素で、mlreportgen.dom.LinkTarget オブジェクトを使用します。たとえば、見出し Author's Biography をもつ節に About the Author リンクを含めることができます。

import mlreportgen.dom.*
d = Document('mydoc');

append(d,InternalLink('bio','About the Author'));
h = Heading(1,LinkTarget('bio'));
append(h,'Author''s Biography');
append(d,h);

close(d);
rptview('mydoc','html');

リンクへのテキストまたはイメージの追加

ExternalLink または InternalLink オブジェクトに対して、テキストまたはイメージを追加するには、そのオブジェクトで append メソッドを使用します。TextImage または CustomElement オブジェクトを追加します。

ページの参照の作成

リンク ターゲットが存在するページへの数値参照を作成できます。たとえば、"15 ページを参照" という形式でページの参照を作成できます。ここで、参照するターゲットは 15 ページのオブジェクト上にあります。たとえば、以下のようにします。

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

% Add target to heading object and append heading and 
% para text to document
h = Heading1(LinkTarget('mytarget'));
append(h,'Referenced Head');
p = Paragraph('Here is some paragraph text.');
append(d,h);
append(d,p);

% Add another page and insert the page reference 
% to the target
p1 = Paragraph('The following paragraph contains the page reference.');
p1.Style = {PageBreakBefore(true)};
p2 = Paragraph('See Page ');
p2.WhiteSpace = 'preserve';
ref = PageRef('mytarget');
append(p2,ref);
append(p2,'.');
append(d,p1);
append(d,p2);

close(d);
rptview(d.OutputPath);

PDF テンプレートでは、<pageref> 要素を使用して、この種類の参照を作成できます。DOM API プログラムでは、この要素で使用するリンク ターゲットを設定しなければなりません。<pageref> は 1 つの引数 (<pageref target="nameoftarget>) を使用します。

このメカニズムの詳細については、mlreportgen.dom.PageRef を参照してください。

参考

| | | |

関連する例

詳細