mlreportgen.dom.UnorderedList class

Package: mlreportgen.dom

Unordered (bulleted) list

Description

Specifies an unordered (bulleted) list.

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

Creation

Description

unorderedListObj = UnorderedList() creates an empty unordered list.

unorderedListObj = UnorderedList(items) creates an unordered list of the specified list items.

Input Arguments

items — Content to include in unordered list

array of doubles | array of character vectors | categorical array | cell array

Content to include in an unordered list, specified as an array of doubles, an array of character vectors, a categorical array, or a one-dimensional cell array.

The cell array can contain a combination of the following:

• A character vector

• A number

• A Boolean value

• One of the following DOM objects:

  • mlreportgen.dom.Text

  • mlreportgen.dom.Paragraph

  • mlreportgen.dom.ExternalLink

  • mlreportgen.dom.InternalLink

  • mlreportgen.dom.Table

  • mlreportgen.dom.Image

  • mlreportgen.dom.CustomElement

• Horizontal one-dimensional array (for a sublist)

To append an unordered list, use an UnorderedList DOM object instead of using the items argument.

Properties

CustomAttributes — Custom attributes of document element

array of mlreportgen.dom.CustomAttribute objects

Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format.

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

Style — Format specification

array of format objects

Format objects that specify the format of a document element.

Stylename — List style name

character vector

The style specified by Stylename must be defined in the template used to create the document element to which you append this list.

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 Use the UnorderedList.append method similar to how you use OrderedList.append.	Append items to this list.
clone Use the UnorderedList.clone method similar to how you use Paragraph.clone.	Copy the list.

Examples

Create an Unordered List

import mlreportgen.dom.*;
d = Document('mydoc');

ul = UnorderedList({Text('a'),'b',1,{'c',Paragraph('d')}});
append(d,ul);

close(d);
rptview('mydoc','html');

Version History

Introduced in R2014b