mlreportgen.dom.Leader class

Package: mlreportgen.dom
Superclasses:

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.

Construction

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

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

Input Arguments

expand all

Type of leader to use, specified as:

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

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

Output Arguments

expand all

Leader, returned as an mlreportgen.dom.Leader object.

Properties

expand all

This read-only property lists child elements of this object.

Custom attributes of this element, specified as an array of mlreportgen.dom.CustomAttribute objects. Use custom attributes supported by the output format.

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.

Type of leader to use, specified as:

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

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

This read-only property lists the parent of this document element.

Format objects that specify the format of a document element.

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

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Methods

Method

Purpose

clone

Copy this object.

Examples

collapse all

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

Introduced in R2016a