mlreportgen.dom.LineSpacing class

Package: mlreportgen.dom
Superclasses:

Spacing between lines of paragraph

Description

Specifies the spacing between lines of a paragraph.

Construction

lineSpacingObj = LineSpacing() specifies line spacing equal to the height of one line at the paragraph font size.

lineSpacingObj = LineSpacing(multiple) specifies a line spacing as a multiple of the paragraph text line height (for example, 1.5).

lineSpacingObj = LineSpacing(spacingHeight) specifies line spacing as a dimension, for example, '10pt'.

lineSpacingObj = LineSpacing(spacingHeight,spacingType) specifies line spacing value and type.

Input Arguments

expand all

Scalar that specifies the line spacing relative to the paragraph text line height.

Height of line spacing in the form valueUnits, where Units is an abbreviation for the units. These abbreviations are valid:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Type of line spacing, specified as one of these values:

  • 'multiple' — Value is the spacing in terms of number of lines.

  • 'exact' — Value is the exact size of the line spacing.

  • 'atleast' — Value is the minimum size of the line spacing (applies only to Microsoft® Word)

Output Arguments

expand all

Spacing between lines of paragraph, represented by an mlreportgen.dom.LineSpacing 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 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.

Type of line spacing, specified as one of these values:

  • 'multiple' — Value is the spacing in terms of number of lines.

  • 'exact' — Value is the exact size of the line spacing.

  • 'atleast' — Value is the minimum size of the line spacing (applies only to Word)

Height of line spacing in the form valueUnits, where Units is an abbreviation for the units. These abbreviations are valid:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Examples

collapse all

p = Paragraph();
p.Style = {LineSpacing(1.5)};