Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

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 hexidecimal RGB color value.

Input Arguments

expand all

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

A character vector using the following RGB format: #RRGGBB. Use # as the first character and two-digit hexidecimal numbers for 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 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.

Either a CSS color name or a hexidecimal RGB value.

Examples

expand 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);
Was this topic helpful?