mlreportgen.dom.CounterInc class
Package: mlreportgen.dom
Superclasses:
Number stream counter incrementers
Description
Create numbering stream counter incrementers.
Construction
creates
an empty counter incrementer.counterIncObj
= CounterInc()
creates
a counter incrementer for each specified numbering streams. Assigning
this format to the style of a DOM object causes the associated stream
counters to be incremented when the object is appended to a document.counterIncObj
= CounterInc(streamNames)
Input Arguments
streamNames
— Numbering stream names
character vector
Numbering stream names, specified as a character vector. To specify multiple stream names, add a space between the stream names.
Output Arguments
counterIncObj
— Numbering stream counter incrementers
mlreportgen.dom.CounterInc
objects
Numbering stream counter incrementers, represented by mlreportgen.dom.CounterInc
objects.
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.
StreamNames
— Numbering stream names
character vector
Numbering stream names, specified as a character vector. To specify multiple stream names, add a space between the stream names.
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.
Examples
Increment Chapter Numbering
import mlreportgen.dom.*; doctype = 'html'; d = Document('test',doctype); p = Paragraph('Chapter '); p.Style = {CounterInc('chapter'),WhiteSpace('preserve')}; append(p,AutoNumber('chapter')); append(d,p); p = Paragraph('Chapter '); p.Style = {CounterInc('chapter'), WhiteSpace('preserve')}; append(p,AutoNumber('chapter')); append(d,p); close(d); rptview('test',doctype);
Specify Multiple Streams for CounterInc and CounterReset
import mlreportgen.dom.* rpt = Document('MyReport','docx'); chapterStyle = {WhiteSpace('pre'), ... CounterReset('table figure'), ... CounterInc('chapter') ... }; topicChapterStyle = {WhiteSpace('pre'), ... CounterReset('table figure'), ... CounterInc('chapter topic') ... }; figureStyle = {WhiteSpace('pre'), ... CounterInc('figure'),Italic(true)}; chapter = Heading(1,'Chapter: '); chapter.Style = chapterStyle; append(chapter,AutoNumber('chapter')); append(chapter,' Introduction to number streams.'); append(rpt, chapter); image = append(rpt,Image(which('b747.jpg'))); image.Width = '2in'; image.Height = '2in'; para = append(rpt, Paragraph('Figure ')); para.Style = figureStyle; append(para, AutoNumber('chapter')); append(para, '.'); append(para, AutoNumber('figure')); image = append(rpt,Image(which('ngc6543a.jpg'))); image.Width = '2in'; image.Height = '2in'; para = append(rpt,Paragraph('Figure ')); para.Style = figureStyle; append(para, AutoNumber('chapter')); append(para, '.'); append(para, AutoNumber('figure')); chapter = Heading(1, 'Chapter: '); chapter.Style = topicChapterStyle; append(chapter, AutoNumber('chapter')); append(chapter,' Topic: '); append(chapter,AutoNumber('topic')); append(chapter,' How to reset and increment streams.'); append(rpt,chapter); image = append(rpt,Image(which('b747.jpg'))); image.Width = '2in'; image.Height = '2in'; para = append(rpt,Paragraph('Figure ')); para.Style = figureStyle; append(para, AutoNumber('chapter')); append(para, '.'); append(para, AutoNumber('figure')); close(rpt); rptview(rpt.OutputPath);
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)