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

expand all

Use one of these values.

ValueApplies To
DOCXHTML 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' 

You can specify:

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

expand all

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

Properties

expand all

You can specify:

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.

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

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

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

Bottom border segment color, specified as a character vector.

Bottom border segment style, specified as a character vector.

Bottom border segment width, specified as a character vector.

Top border segment color, specified as a character vector.

Top border segment style, specified as a character vector.

Top border segment width, specified as a character vector.

Left border segment color, specified as a character vector.

Left border segment style, specified as a character vector.

Left border segment width, specified as a character vector.

Right border segment color, specified as a character vector.

Right border segment style, specified as a character vector.

Right border segment width, specified as a character vector.

Examples

collapse all

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