mlreportgen.dom.CounterInc Class

Namespace: mlreportgen.dom

Number stream counter incrementers

Description

Create numbering stream counter incrementers.

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

Creation

Description

counterIncObj = CounterInc creates an empty counter incrementer.

counterIncObj = CounterInc(streamNames) 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.

Input Arguments

streamNames — Numbering stream names

character vector

Numbering stream names, specified as a character vector or string scalar. To specify multiple stream names, add a space between the stream names.

Properties

Id — Object identifier for mlreportgen.dom.CounterInc object

character vector | string scalar

Object identifier for the mlreportgen.dom.CounterInc object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable

true

Data Types: char | string

StreamNames — Numbering stream names

character vector

Numbering stream names, specified as a character vector or string scalar. To specify multiple stream names, add a space between the stream names.

Tag — Tag for mlreportgen.dom.CounterInc object

character vector | string scalar

Tag for the mlreportgen.dom.CounterInc object, specified as a character vector or string scalar. The DOM API 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable

true

Data Types: char | string

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

Specify multiple counter streams for chapters and for figures within the chapters.

import mlreportgen.dom.*
rpt = Document('MyReport','pdf');

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);

Version History

Introduced in R2014b