mlreportgen.dom.TableHeader class

Package: mlreportgen.dom
Superclasses:

Table header

Description

Table header for labeling columns.

Properties

expand all

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

The style of the line separating the columns of a table or table section (header, body, footer), as specified by a mlreportgen.dom.ColSep object.

See the description of the Border property for a description of the possible values.

Color of line separating columns, specified as either:

Width of the line separating table columns, in the form valueUnits. Use one of these abbreviations for the Units:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

For example, for a column separator of 3 points, set the ColSepWidth property to '3pt'.

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.

The style of a line separating the rows of a table or table section (header, body, or footer).

See the description of the Border property for a description of the possible values.

Color of lines separating table rows, specified as one of these values:

  • The name of a color. See the mlreportGen.dom.Color class reference page for a list of supported colors.

  • A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

Width of lines separating table rows in the form valueUnits, where Units is an abbreviation for the units. Use one of these abbreviations:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

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

Array of format objects (such as Bold objects) that specify the format for the table header.

This property overrides corresponding formats defined by the style sheet style specified by the StyleName property.

Name of a style specified in the style sheet of the document or document part to which the table header is appended

The style that specifies the appearance of the table header in the output document, for formats not specified by Style property.

Horizontal alignment of table entries, specified as 'center', 'left', or 'right'.

Data Types: char

The inner margin is the margin between table cell content and the cell borders in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Cell array of format objects that specify the format for table entries.

Vertical alignment of table cell content, specified as one of these values:

  • 'top'

  • 'middle'

  • 'bottom'

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

append

Appends a row of table entries to this table header.

entry

Get a header entry.

row

Get a header row.