mlreportgen.dom.Border class

Package: mlreportgen.dom
Superclasses:

Border properties of object

Description

Specifies the border properties of an object.

Construction

borderObj = Border() creates an unspecified border.

borderObj = Border(style) creates a border having the specified style.

borderObj = Border(style,color) creates a border having the specified style and color.

borderObj = Border(style,color,width) creates a border having the specified style, color, and width.

Input Arguments

style — Default style of border segments

character vector

Use one of the values in the table.

Border Value	Description	Supported Output Types
'dashed'	Dashed line	All output types
'dashdotstroked'	Line with alternating diagonal dashes and dot	Word
'dashsmallgap'	Dashed line with a small gap between dashes	Word
'dotted'	Dotted line	All output types
'dotdash'	Line with alternating dots and dashes	Word
'dotdotdash'	Line with alternating double dots and a dash	Word
'double'	Double line	All output types
'doublewave'	Double wavy line	Word
'groove'	3-D effect grooved line	HTML and PDF
'hidden'	No line The 'none' border type also produces no line. However, conflicting borders are handled differently for 'hidden' types than for 'none' types. The 'hidden' border type takes precedence over a conflicting border type. A conflicting border type takes precedence over the 'none' type.	HTML and PDF
'inset'	3-D effect line	All output types
'none'	No line The 'hidden' border type also produces no line. However, conflicting borders are handled differently for 'hidden' types than for 'none' types. The 'hidden' border type takes precedence over a conflicting border type. A conflicting border type takes precedence over the 'none' type.	All output types
'outset'	3-D effect line	All output types
'ridge'	3-D effect ridged line	HTML and PDF
'single'	Single line	Word
'solid'	Single line	HTML and PDF
'thick'	Thick line	Word
'thickthinlargegap'	Dashed line with alternating thick and thin dashes with a large gap	Word
'thickthinmediumgap'	Dashed line with alternating thick and thin dashes with a medium gap	Word
'thickthinsmallgap'	Dashed line with alternating thick and thin dashes with a small gap	Word
'thinthicklargegap'	Dashed line with alternating thin and thick dashes with a medium gap	Word
'thinthickmediumgap'	Dashed line with alternating thin and thick dashes, with a medium gap	Word
'thinthicksmallgap'	Dashed line with alternating thin and thick dashes with a small gap	Word
'thinthickthinlargegap'	Dashed line with alternating thin and thick dashes with a large gap	Word
'thinthickthinmediumgap'	Dashed line with alternating thin and thick dashes with a medium gap	Word
'thinthickthinsmallgap'	Dashed line with alternating thin and thick dashes with a small gap	Word
'threedemboss'	Embossed effect line	Word
'threedengrave'	Engraved effect line	Word
'triple'	Triple line	Word
'wave'	Wavy line	Word

color — Color of border

character vector

You can specify:

• The name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

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

width — Width of border

character vector

Width of the border, specified as a character vector, in the format valueUnits. 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

borderObj — Table border

mlreportgen.dom.Border object

Table border, represented by an mlreportgen.dom.Border object.

Properties

Color — Default color of border segments

character vector

You can specify:

• The name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• 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.

Style — Default style of border segments

character vector

For details, see the description of the style input argument for the mlreportgen.dom.Border constructor.

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 — Width of border

character vector

Width of the border, specified as a character vector 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

BottomColor — Bottom border segment color

character vector

Bottom border segment color, specified as a character vector.

BottomStyle — Bottom border segment style

character vector

Bottom border segment style, specified as a character vector.

BottomWidth — Bottom border segment width

character vector

Bottom border segment width, specified as a character vector.

TopColor — Top border segment color

character vector

Top border segment color, specified as a character vector.

TopStyle — Top border segment style

character vector

Top border segment style, specified as a character vector.

TopWidth — Top border segment width

character vector

Top border segment width, specified as a character vector.

LeftColor — Left border segment color

character vector

Left border segment color, specified as a character vector.

LeftStyle — Left border segment style

character vector

Left border segment style, specified as a character vector.

LeftWidth — Left border segment width

character vector

Left border segment width, specified as a character vector.

RightColor — Right border segment color

character vector

Right border segment color, specified as a character vector.

RightStyle — Right border segment style

character vector

Right border segment style, specified as a character vector.

RightWidth — Right border segment width

character vector

Right border segment width, specified as a character vector.

Examples

Format Table Borders

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
t = Table(magic(5));
t.Style = {Border('inset','crimson','6pt'),Width('50%')};
t.TableEntriesInnerMargin = '6pt';
append(d,t);
close(d);
rptview('test',doctype);