Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.dom.ListStyleType class

Package: mlreportgen.dom
Superclasses:

Bullet or number style for HTML and PDF output

Description

Specifies the bullet or number style for an mlreportgen.dom.ListItem object for HTML and PDF output.

Note

The default fonts used for PDF output support commonly used bulleted and numbered list item styles. For rarer styles, you must specify a font family that supports the style in the list item’s Style property or style sheet. You must also configure the DOM API to use the specified font family. See Configure PDF Fonts.

Construction

ListStyleObj = ListStyleType() specifies a 'disc' style bullet type, which is a filled circle.

ListStyleObj = ListStyleType(Value) specifies a bullet or numbering type using any value available for the CSS list-style-type property.

Input Arguments

expand all

Bullet or number style, specified as one of these character vectors.

Style valueBullet or number type
'disc'Filled circle (default)
'armenian'Armenian numbering
'circle'Open circle
'cjk-ideographic'Plain ideographic numbers
'decimal'Number
'decimal-leading-zero'Number with leading zeroes, i.e., 01, 02, 03, and so on
'georgian'Georgian numbering
'hebrew'Hebrew numbering
'hiragana'Hiragana numbering
'hiragana-iroha'Hiragana-iroha numbering
'katakana'Ktakana nnumbering
'katakana-iroha'Katakana-iroha numbering
'lower-alpha'Lowercase alphabetic numbering
'lower-greek'Lowercase Greek alphabetic numbering
'lower-latin'Lowercase Latin alphabetic numbering
'lower-roman'Lowercase roman numerals
'none'No bullet or number
'upper-alpha'Uppercase alphabetic numbering
'upper-latin'Uppercase Latin numbering
'upper-roman'Uppercase roman numerals

Output Arguments

expand all

Bullet or number style for a list item, returned as an mlreportgen.dom.ListStyleType 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.

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.

Bullet or number style, specified as one of these values.

Style valueBullet or number type
'disc'Filled circle (default)
'circle'Open circle
'cjk-ideographic'Plain ideographic numbers
'decimal'Number
'decimal-leading-zero'Number with leading zeroes, i.e., 01, 02, 03, and so on
'hiragana'Hiragana numbering
'hiragana-iroha'Hiragana-iroha numbering
'katakana'Ktakana nnumbering
'katakana-iroha'Katakana-iroha numbering
'lower-alpha'Lowercase alphabetic numbering
'lower-greek'Lowercase Greek alphabetic numbering
'lower-latin'Lowercase Latin alphabetic numbering
'lower-roman'Lowercase roman numerals
'none'No marker
'upper-alpha'Uppercase alphabetic numbering
'upper-latin'Uppercase Latin numbering
'upper-roman'Uppercase roman numerals

Examples

expand all

Create a document mylist for HTML, the default output type. Add a paragraph to the document and define two list items, giving each the ListStyleType property of 'lower-greek'. Create an ordered list object procedure and append the two list items to it, and then append the unordered list to the document.

import mlreportgen.dom.*;
d = Document('mylist');
p = Paragraph('This list uses Greek numbering.');
append(d,p);

step1 = ListItem('Do this step first.');
step2 = ListItem('Now do this step.');
step1.Style = {ListStyleType('lower-greek')};
step2.Style = {ListStyleType('lower-greek')};
procedure = OrderedList();
append(procedure,step1);
append(procedure,step2);
append(d,procedure);

close(d);
rptview('mylist');
Was this topic helpful?