mlreportgen.dom.Color class

Package: mlreportgen.dom
Superclasses:

Color of document element

Description

Specifies the color of a document element.

Construction

colorObj = Color() creates a black color object.

colorObj = Color(colorName) creates a color object based on the specified CSS color name.

colorObj = Color(rgbValue) creates a color object using the hexadecimal RGB color value.

Input Arguments

expand all

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

A character vector using the following RGB format: #RRGGBB. Use # as the first character and two-digit hexadecimal numbers each for the red, green, and blue values. For example, '#0000ff' specifies blue.

Output Arguments

expand all

Color for document element, represented by an mlreportgen.dom.Color object.

Properties

expand all

Hexadecimal number representing an RGB color value. For example, '#8b008b' specifies dark magenta. You can use either uppercase or lowercase letters as part of a hexadecimal value.

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.

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.

Either a CSS color name or a hexadecimal RGB value.

Examples

collapse all

Create a blue color object and apply it to a paragraph. Instead of specifying the CSS color name 'blue', you could use the hexadecimal value '#0000ff'.

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

colorfulStyle = {Bold,Color('blue')};
p = Paragraph('deep sky blue paragraph');
p.Style = colorfulStyle;
append(d,p);

close(d);
rptview('test',doctype);