mlreportgen.dom.Leader class

Package: mlreportgen.dom

Leader character for PDF output

Description

Create a leader character for PDF documents. A leader is a repeated character that fills out the available space in text.

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

Creation

Description

lead = Leader() creates a leader object using a dot leader.

lead = Leader(pattern) uses the specified leader type.

Input Arguments

pattern — Type of leader to use

'.' (default) | ' ' (space) | 'dots' | 'space'

Type of leader to use, specified as:

• '.' or 'dots' for a dot leader

• ' ' (space character) or 'space' for a space

Properties

Children — Children of document element

array of DOM objects

Children of this document element, specified as an array of DOM objects. This property is read-only.

CustomAttributes — Custom attributes of this element

array of mlreportgen.dom.CustomAttribute objects

Custom attributes of this element, specified as an array of mlreportgen.dom.CustomAttribute objects. Use custom attributes 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

Pattern — Type of leader to use

'.' (default) | ' ' (space) | 'dots' | 'space'

Type of leader to use, specified as:

• '.' or 'dots' for a dot leader

• ' ' (space character) or 'space' for a space

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Style — Format specification

array of format objects

Format objects that specify the format of a document element.

StyleName — Style to apply from style sheet

character vector

Name of the style to apply from the style sheet, specified as a character vector.

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
clone	Copy this object.

Examples

Insert Leaders in a PDF Report

This example uses a dot leader and a space leader in a PDF report.

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

h = Heading1('Cast');
h.HAlign = 'center';

% Create a leader object l using a space as the leader type
% Append the leader object to a Heading2 paragraph
l = Leader(' ');
h2 = Heading2('Role');
append(h2,l);
append(h2,'Actor');
append(d,h);
append(d,h2);

% Create a leader object dotl using the default leader type of a dot
% Define variables for the content
dotl = Leader();
role = 'Romeo';
actor = 'Leonardo DiCaprio';

% Append the variable text and leader object to a paragraph
p = Paragraph();
append(p,role);
append(p,dotl);
append(p,actor);
append(d,p);

% Repeat, updating variables for each new paragraph
% Insert a clone of the dotl object
role = 'Juliet';
actor = 'Claire Danes';
p = Paragraph();
append(p,role);
append(p,clone(dotl));
append(p,actor);
append(d,p);

role = 'Tybalt';
actor = 'John Leguizamo';
p = Paragraph();
append(p,role);
append(p,clone(dotl));
append(p,actor);
append(d,p);

close(d);
rptview(d.OutputPath);

Version History

Introduced in R2016a