mlreportgen.dom.Group class

Package: mlreportgen.dom

Group of document objects

Description

Group of document objects that you can append multiple times in a document without you having to 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.

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

Creation

Description

groupObj = Group() creates an empty group.

Properties

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Children — Children of document element

array of DOM objects

Children of this document element, specified as an array of DOM objects. This property is read-only.

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public Methods

Method	Purpose
append	Append a DOM object to the group

Version History

Introduced in R2014b