mlreportgen.dom.AutoNumberStream class

Package: mlreportgen.dom
Superclasses:

Numbering stream

Description

A numbering stream generates a sequence of numbers for numbering chapters, tables, figures, and other document objects. To create a numbering stream object, use the mlreportgen.dom.Document.createAutoNumberStream method.

Properties

CharacterCase — Character case of generated numbers

'lower' | 'upper'

Character case of generated numbers, specified as:

• 'lower' — lowercase (for example, a, b ,c)

• 'upper' — uppercase (for example, A, B, C)

CharacterType — Character type of generated numbers

'alphabetic' | 'arabic' | 'roman'

Character type of generated numbers, specified as:

• 'alphabetic' — for example, a, b, c

• 'arabic' — for example, 1, 2, 3

• 'roman' — for example, i, ii, iii

Id — ID for document element

character vector

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.

InitialValue — Initial value of generated number

character vector

The value of this property should be one less than the number that you want to be generated first. For example, if you want the number of the first item to be numbered by this stream to be 2, set the value of this property to 1.

StreamName — Name of numbering stream

character vector

Name of numbering stream, specified as a character vector.

Tag — Tag for document element

character vector

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.