mlreportgen.dom.ImageMap クラス

名前空間: mlreportgen.dom

イメージのハイパーリンク領域のマップ

このページをすべて展開する

説明

mlreportgen.dom.ImageMap クラスのオブジェクトを使用して、イメージ領域のマップを作成します。これは、クリックしてブラウザーでコンテンツを開いたり、同じページ内の別の場所に移動したりできるイメージ内の領域のことです。PDF 出力または HTML 出力を使用してレポート内にイメージ マップを作成できます。mlreportgen.dom.ImageArea を使用して領域を定義し、マップに追加します。ImageMap を mlreportgen.dom.Image クラスの Map に割り当てます。

mlreportgen.dom.ImageMap クラスは handle クラスです。

作成

説明

map = ImageMap は空のイメージ マップを作成します。ImageMap.append メソッドを使用して、イメージ領域をマップに追加します。

例

プロパティ

すべて展開する

スタイルシート定義スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft® Word レポートでは、ドキュメント テンプレートで定義されていないスタイル名は無視されます。Microsoft Word テンプレートの詳細については、DOM API レポート プログラムのテンプレートを参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素オブジェクトの書式指定。DOM 書式オブジェクトの cell 配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。このドキュメント要素オブジェクトに適用されない書式は無視されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: cell

ドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このオブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

このオブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

タグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。この値を使用すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

領域のサイズと位置、および領域をクリックしたときに発生するアクションを指定する ImageArea オブジェクトを定義します。次に、その領域を ImageMap オブジェクトに追加します。

import mlreportgen.dom.*
d = Document("imageArea","pdf");

% Create a plot and save it as an image file
x = 0:pi/100:2*pi;
y = sin(x);
plot(x,y);
annotation("textbox", [0.2,0.4,0.1,0.1],...
           "string", "Help on plot function");
saveas(gcf,"plot_img.png");

% Create the DOM image object and append it to your document
plot1 = Image("plot_img.png");
append(d,plot1);

% Define the area and link target using ImageArea
target = ["https://www.mathworks.com/help/matlab/ref/" ...
"plot.html?searchHighlight=plot"];
area1 = ImageArea( target, ...
"plot function help",160,340,383,392);

% Create the image map object and append the area to it
map = ImageMap();
append(map,area1);
plot1.Map = map;

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

詳細

すべて展開する

バージョン履歴

R2014b で導入

参考

|

トピック