mlreportgen.dom.Height class

Package: mlreportgen.dom
Superclasses:

Height of object

Description

Specifies the height of an image.

Construction

heightObj = Height() creates a format object that specifies a height of 1 inch.

heightObj = Height(value) creates a height object having the specified height.

Input Arguments

value — Height of object

'1in' (default) | character vector

Height of the object, 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

Output Arguments

heightObj — Height of object

mlreportgen.dom.Height object

Height of object, represented by an mlreportgen.dom.Height object.

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.

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.

Value — Object height

1in (default) | character vector

character vector having the format valueUnits, where Units is an abbreviation for the units in which the height is expressed. The following abbreviations are valid:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points