mlreportgen.dom.RowSep Class

Namespace: mlreportgen.dom

Draw lines between table rows

Description

Draw lines (separators) between table rows.

The mlreportgen.dom.RowSep class is a handle class.

Creation

Description

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.

Border Style	Description	Supported in Microsoft® Word	Supported in HTML and PDF
"dashed"	Dashed line	yes	yes
"dashdotstroked"	Line with alternating diagonal dashes and dot	yes	yes
"dashsmallgap"	Dashed line with a small gap between dashes	yes	yes
"dotted"	Dotted line	yes	yes
"dotdash"	Line with alternating dots and dashes	yes	no
"dotdotdash"	Line with alternating double dots and a dash	yes	no
"double"	Double line	yes	yes
"doublewave"	Double wavy line	yes	no
"groove"	3-D effect grooved line	no	yes
"hidden"	No line When there is a conflicting border style, the "hidden" border style takes precedence over the conflicting border style, which results in no line displaying.	no	yes
"inset"	3-D effect line	no	yes
"none"	No line When there is a conflicting border style, the conflicting border style takes precedence over "none", which results in the conflicting border style displaying.	yes	yes
"outset"	3-D effect line	yes	yes
"ridge"	3-D effect ridged line	no	yes
"single"	Single line	yes	yes
"solid"	Single line	no	yes
"thick"	Thick line	yes	no
"thickthinlargegap"	Dashed line with alternating thick and thin dashes with a large gap	yes	no
"thickthinmediumgap"	Dashed line with alternating thick and thin dashes with a medium gap	yes	no
"thickthinsmallgap"	Dashed line with alternating thick and thin dashes with a small gap	yes	no
"thinthicklargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthicksmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"thinthickthinlargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickthinmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthickthinsmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"threedemboss"	Embossed effect line	yes	no
"threedengrave"	Engraved effect line	yes	no
"triple"	Triple line	yes	no
"wave"	Wavy line	yes	no

Note

For Microsoft Word reports, when you assign an mlreportgen.dom.Border object to the Style property of an mlreportgen.dom.TableHeaderEntry, mlreportgen.dom.TableEntry, or mlreportgen.dom.HorizontalRule object, the reporter does not support "inset" or "outset" styles for this property.

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 | string scalar

Width of table row separator, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Properties

Color — Document element object color

[] (default) | character vector | string scalar

Document element object color, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Note

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"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Width — Table row separator width

[] (default) | character vector | string scalar

Table row separator width, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "3pt" specifies three points.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Row separator style

[] (default) | "none" | "solid" | "dot" | ... | ...

Row separator style, specified as a character vector or string scalar. See the description of the style input argument for a list of possible values.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The DOM API 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

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);

Version History

Introduced in R2014b