mlreportgen.dom.ColSep Class

Namespace: mlreportgen.dom

Draw lines between table columns

expand all in page

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.

example

Input Arguments

expand all

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

Separator width as a percentage, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10%" specifies ten percent. Valid abbreviations are:

px — Pixels
cm — Centimeters
in — Inches
mm — Millimeters
pc — Picas
pt — Points
% — Percent

Properties

expand all

`Color` — Column separator color
`[]` (default) | character vector | string scalar

Column separator 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.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`Width` — Separator width
`[]` (default) | character vector | string scalar

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

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "100%"

Example: "3pt" specifies three points.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`Style` — Column Separator style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Column Separator style, specified as a character vector or string scalar. Specify 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.

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

collapse all

Specify Table Column Separator

Open Live Script

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

mlreportgen.dom.ColSep Class

Description

Creation

Description

Input Arguments

`style` — Style of column separator in table
character vector

`color` — Color of column separator in table
character vector

`width` — Width of column separator in the table
character vector | string scalar

Properties

`Color` — Column separator color
`[]` (default) | character vector | string scalar

Attributes:

`Width` — Separator width
`[]` (default) | character vector | string scalar

Attributes:

`Style` — Column Separator style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Attributes:

`Tag` — Tag
character vector | string scalar

Attributes:

`Id` — Object identifier
character vector | string scalar

Attributes:

Examples

Specify Table Column Separator

Version History

See Also

Topics

mlreportgen.dom.ColSep Class

Description

Creation

Description

Input Arguments

style — Style of column separator in table character vector

color — Color of column separator in table character vector

width — Width of column separator in the table character vector | string scalar

Properties

Color — Column separator color [] (default) | character vector | string scalar

Attributes:

Width — Separator width [] (default) | character vector | string scalar

Attributes:

Style — Column Separator style [] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Attributes:

Tag — Tag character vector | string scalar

Attributes:

Id — Object identifier character vector | string scalar

Attributes:

Examples

Specify Table Column Separator

Version History

See Also

Topics

`style` — Style of column separator in table
character vector

`color` — Color of column separator in table
character vector

`width` — Width of column separator in the table
character vector | string scalar

`Color` — Column separator color
`[]` (default) | character vector | string scalar

`Width` — Separator width
`[]` (default) | character vector | string scalar

`Style` — Column Separator style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`Tag` — Tag
character vector | string scalar

`Id` — Object identifier
character vector | string scalar