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

expand all

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

expand all

Height of object, represented by an mlreportgen.dom.Height 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.

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