mlreportgen.dom.BackgroundColor class

Package: mlreportgen.dom
Superclasses:

Background color of document element

Description

Specifies the background color of a document element

Construction

backgroundColorObj = BackgroundColor() creates a white background.

backgroundColorObj = BackgroundColor(colorName) creates a background color object based on the specified CSS color name.

backgroundColorObj = BackgroundColor(rgbValue) creates a background color object using the hexadecimal RGB color value.

Input Arguments

expand all

The name of a color, specified as a character vector. 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

Background color for a report object, returned as an mlreportgen.dom.BackgroundColor 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, specified as a character vector.

Examples

collapse all

Create a deep sky blue background color object and apply it to a paragraph. Instead of specifying the CSS color name DeepSkyBlue, you can use the hexadecimal value #00bfff.

import mlreportgen.dom.*;
     doctype = 'html';
     d = Document('test',doctype);
     blue = 'DeepSkyBlue';
     % blue = '#00BFFF';
     colorfulStyle = {Bold,Color(blue),BackgroundColor('Yellow')};
     p = Paragraph('deep sky blue paragraph with yellow background');
     p.Style = colorfulStyle;
     append(d,p);
     close(d);
     rptview('test',doctype);