mlreportgen.dom.ColSep class

Package: mlreportgen.dom

Draw lines between table columns

Description

Draw lines between table columns.

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

Creation

Description

colSepObj = ColSep() creates unspecified column separators.

colSepObj = ColSep(style) creates a column separator of the specified style.

colSepObj = ColSep(style,color) creates a column separator having the specified style and color.

colSepObj = ColSep(style,color,width) creates a column separator having the specified style, color, and width.

Input Arguments

style — Style of column separator in table

character vector

Style of the table column separator, specified as one of these values.

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

color — Color of column separator in table

character vector

You can specify:

• The name of a color. The name must be a CSS color name. See https://www.w3.org/wiki/CSS/Properties/color/keywords.

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

width — Width of column separator in the table

character vector

Separator width as a percentage, for example, '100%', or a number of units of measurement in the form valueUnits. Units is an abbreviation for the units. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Properties

Color — Separator color

character vector

You can specify:

• The name of a color. The name must be a CSS color name. See https://www.w3.org/wiki/CSS/Properties/color/keywords.

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

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format for separator

array of format objects

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

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

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Width — Separator width

character vector

Separator width as a percentage, for example, '100%', or a number of units of measurement in the form valueUnits. Units is an abbreviation for the units. Use one of these abbreviations for the units of a width.

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Data Types: char

Examples

Specify Table Column Separator

This example creates table and sets the border, column separator, and row separator styles. The TableEntriesStyle property formats the table entries.

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

t.Style = { ...
    RowHeight('0.75in'), ...
    Border('solid','Green','6pt'), ...
    ColSep('double','DarkGreen','3pt'), ...
    RowSep('single','DarkGreen')};

t.TableEntriesStyle = { ...
    Width('0.75in'), ...
    InnerMargin('0'), ...
    OuterMargin('0'), ...
    HAlign('center'), ...
    VAlign('middle') };
    
append(d,t);
close(d);
rptview(d.OutputPath);

Version History

Introduced in R2014b