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 these values.

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

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 document element

character vector

ID for this document element, specified as a character vector. 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 document element

character vector

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

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