mlreportgen.dom.TableColSpecGroup class

Package: mlreportgen.dom
Superclasses:

Define style for group of table columns

Description

Define the style for a group of table columns. Use a TableColSpec object to override formats specified by a TableColSpecGroup object.

Construction

colSpecGroupObj = TableColSpecGroup() creates a column specification that spans an entire table.

Output Arguments

expand all

Specification of formats for a group of table columns, represented by an mlreportgen.dom.TableColSpecGroup object.

Properties

expand all

This property accepts an array of mlreportgen.dom.TableColSpec objects. The Border property accepts the same array input.

The output format must support the custom attributes of this document element.

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.

If this property is not specified (its value is []), the value is assumed to be 1.

Data Types: double

Format objects that specify the format of a document element.

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.

Examples

collapse all

import mlreportgen.dom.*
d = Document('mydoc','docx');
append(d,'Table');
     
grps(1) = TableColSpecGroup;
grps(1).Style = {Color('red')};
grps(1).Span = 5;
specs(1) = TableColSpec;
specs(1).Style = {Color('green')};
grps(1).ColSpecs = specs;
table = Table(magic(5));
table.ColSpecGroups = grps;

append(d,table);

close(d);
rptview(d.OutputPath);