mlreportgen.dom.Group class

Package: mlreportgen.dom
Superclasses:

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.

Construction

groupObj = Group() creates an empty group.

Output Arguments

expand all

Group of document objects, represented by an mlreportgen.dom.Group object.

Properties

expand all

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

This read-only property lists child elements of this object.

This read-only property lists the parent of this document element.

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Methods

Method

Purpose

append

Append a DOM object to the group