mlreportgen.dom.OPCPart Class

Namespace: mlreportgen.dom

Document part to include in OPC package

Description

Document part to include in an OPC package.

The mlreportgen.dom.OPCPart class is a handle class.

Creation

Description

opcPartObj = OPCPart creates an empty OPC part.

opcPartObj = OPCPart(name,sourcePath) creates a part having the specified name whose source file is located at the specified path. Appending the part to a document using the Document.package method causes a copy of the source file to be inserted in the document package at the location specified by the part name.

Input Arguments

name — Name of part

character vector

Name of part, specified as a character vector or string scalar.

sourcePath — Path of source file for part

character vector

Path of source file for part, specified as a character vector or string scalar.

Properties

ContentType — Content type of part

"" (default) | character vector | string scalar

Specifies the content type using a file extension, specified as a character vector or string scalar. For a list of file content types, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.

If you do not set this property and the part is one of the types listed below, the DOM interface sets the content type when you append the part to a document.

File Type	File Extension
Cascading style sheet	.css
Icon	.cur
Windows® metafile	.emf
Encapsulated PostScript®	.eps
GIF image	.gif
HTML	.html
JPEG image	.jpe
JPEG image	.jpeg
JPEG image	.jpg
JavaScript®	.js
JavaScript object Notation	.json
PNG image	.png
PSD	.psd
Rich Text Format	.rtf
Scalable Vector Graphics	.svg
TIFF image	.tif
TIFF image	.tiff
TrueType font	.ttf
Plain text	.txt

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Name — Path of part

"" (default) | character vector | string scalar

Path of this part relative to the root of the package, specified as a character vector or string scalar. For example, to add an image named myimage.jpg to a document images folder, specify the path as "/images/myimage.jpg". Specify Name using only ASCII characters.

For information about OPC part names, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

RelatedPart — Path name of part to which specified part is related

"" (default) | character vector | string scalar

For information about OPC part names, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

RelationshipID — Relationship ID

"" (default) | character vector | string scalar

For information about OPC relationship IDs, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

RelationshipType — Relationship type

"" (default) | character vector | string scalar

Specifies a relationship type using a file extension, specified as a character vector or string scalar. For a list of file content types, see https://en.wikipedia.org/wiki/Open_Packaging_Conventions.

If you do not set this property and the part is one of these types, the DOM interface sets the content type when you append the part to a document.

File Type	File Extension
Cascading style sheet	.css
Icon	.cur
Windows metafile	.emf
Encapsulated PostScript	.eps
GIF image	.gif
HTML	.html
JPEG image	.jpe
JPEG image	.jpeg
JPEG image	.jpg
JavaScript	.js
JavaScript object Notation	.json
PNG image	.png
PSD	.psd
Rich Text Format	.rtf
Scalable Vector Graphics	.svg
TIFF image	.tif
TIFF image	.tiff
TrueType font	.ttf
Plain text	.txt

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

SourceFilePath — Source file path

"" (default) | character vector | string scalar

Source file path, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Examples

Add a File to an OPC Package

This code inserts a copy of the data.json file in the data subfolder of the mydoc package. This example assumes that there is a data.json file in the current folder.

import mlreportgen.dom.*;
d = Document("mydoc","html");
package(d,OPCPart("/data/data.json","data.json"));
close(d);

Version History

Introduced in R2014b

R2024b: Removal of BMP for image output

Report Generator no longer supports BMP (bitmap) as an output image format. This affects snapshots, images from files, and watermarks in both the Report Explorer and the Report, DOM, and PPT APIs. See print for more information.