mlreportgen.dom.RowSep class

Package: mlreportgen.dom
Superclasses:

Draw lines between table rows

Description

Draw lines (separators) between table rows.

Construction

rowSepObj = RowSep() creates unspecified row separators.

rowSepObj = RowSep(style) creates a row separator of the specified style.

rowSepObj = RowSep(style,color) creates a row separator having the specified style and color.

rowSepObj = RowSep(style,color,width) creates a row separator having the specified style, color, and width.

Input Arguments

style — Line style of table row separator

character vector

Line style of the table row separator, specified as one of these values.

Value	Applies To
	Word	HTML and PDF
'dashed'
'dashdotstroked'
'dashsmallgap'
'dotted'
'dotdash'
'dotdotdash'
'double'
'doublewave'
'inset'
'none'
'outset'
'single'
'solid'
'thick'
'thickthinlargegap'
'thickthinmediumgap'
'thickthinsmallgap'
'thinthicklargegap'
'thinthickmediumgap'
'thinthicksmallgap'
'thinthickthinlargegap'
'thinthickthinmediumgap'
'thinthickthinsmallgap'
'threedemboss'
'threedengrave'
'triple'
'wave'

color — Color of table row separator

character vector

Color of the table row separator, specified as a color, such as 'red' or a hexadecimal RGB value, such as '#0000ff'.

width — Width of table row separator

character vector

Width of table row separator 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

Output Arguments

rowSepObj — Draw lines between table rows

mlreportgen.dom.RowSep object

Table rows separator lines, represented by an mlreportgen.dom.RowSep object.

Properties

Color — Text color

[] (default) | character vector | string scalar

Text color, specified as a character vector or string scalar that consists of a CSS color name (see https://www.w3.org/wiki/CSS/Properties/color/keywords) or a hexadecimal RGB (truecolor) value in the form #RRGGBB.

Setting the Color property adds a corresponding mlreportgen.dom.Color format object to the Style property. Setting the Color property to an empty value removes the object.

Example: 'blue'

Example: '#0000ff'

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.

Style — Line style of table row separator

character vector

Line style for the row separator. See the description of the style input argument for a list of possible values.

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.

Width — Table row separator width

character vector

Width of the table row separator 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

Examples

Use Table Row Separators

Define the row separator as part of the Style property definition for the table.

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

t = Table(magic(5));
t.Style = {Border('inset','crimson','6pt'), ...
   ColSep('double','DarkGreen','3pt'), ...
   RowSep('double','Gold','3pt'), ...
   Width('50%')};

t.TableEntriesInnerMargin = '6pt';
t.TableEntriesHAlign = 'center';
t.TableEntriesVAlign = 'middle';
append(d,t);

close(d);
rptview(d.OutputPath);