mlreportgen.dom.Group Class

Namespace: mlreportgen.dom

Group of document objects

expand all in page

Description

Use an object of the mlreportgen.dom.Group class to create a group of document objects that you can append multiple times in a document without having to manually clone the group. When you append a group to a document, the DOM interface clones the group.

Tip

You can use mlreportgen.dom.Group and mlreportgen.dom.Container objects to produce collections of document elements.

  • Use a group object to append the same content in multiple places in a document without having to clone the group. Group objects do not have a Style property for using the same applicable styles to all document elements in the group.

  • Use a container object to create a div, section, or article container element and to use the same applicable styles to all document elements in the container. To append the same container object contents in multiple places in a document, use the mlreportgen.dom.Container.clone method.

To see what DOM objects you can append an mlreportgen.dom.Group object to, see Append mlreportgen.dom.Group object to DOM class object .

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

Creation

Description

groupObj = Group creates an empty group.

example

Properties

expand all

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess
public
SetAccess
private
NonCopyable
true

Children of this object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

GetAccess
public
SetAccess
private
NonCopyable
true

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

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

Methods

expand all

Examples

collapse all

import mlreportgen.dom.*;
myReport = Document("myDoc","html");

x = 0:pi/100:2*pi;
y = sin(x);
plot1 = plot(x,y);
saveas(plot1,"plot1.png")

plotimage = Image("plot1.png");
para = Paragraph("Value of the sine function from 0 to 2pi");
groupForPlot = Group();
append(groupForPlot,para);
append(groupForPlot,plotimage);
append(myReport,groupForPlot);

close(myReport);
rptview("myDoc","html");

More About

expand all

Version History

Introduced in R2014b

See Also

Topics