Main Content

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.

example

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

Input Arguments

expand all

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

ValueSupported in WordSupported in HTML and PDF
'dashed'YesYes
'dashdotstroked'YesNo
'dashsmallgap'YesNo
'dotted'YesYes
'dotdash'YesNo
'dotdotdash'YesNo
'double'YesYes
'doublewave'YesNo
'inset'YesYes
'none'YesYes
'outset'YesYes
'single'YesNo
'solid'NoYes
'thick'YesNo
'thickthinlargegap'YesNo
'thickthinmediumgap'YesNo
'thickthinsmallgap'YesNo
'thinthicklargegap'YesNo
'thinthickmediumgap'YesNo
'thinthicksmallgap'YesNo
'thinthickthinlargegap'YesNo
'thinthickthinmediumgap'YesNo
'thinthickthinsmallgap'YesNo
'threedemboss'YesNo
'threedengrave'YesNo
'triple'YesNo
'wave'YesNo

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

Width of table row separator in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Properties

expand all

Document element color 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, specified as a character vector or string scalar.

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:

NonCopyable
true

Data Types: char | string

Width of the table row separator in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

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

Tag for mlreportgen.dom.RowSep object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for mlreportgen.dom.RowSep object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Examples

collapse all

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