mlreportgen.ppt.ColSpec class

Package: mlreportgen.ppt
Superclasses:

Formatting for table column

Description

Formatting for a table column.

Construction

colSpecObj = mlreportgen.ppt.ColSpec() creates an empty table column specification.

colSpecObj = mlreportgen.ppt.ColSpec(colWidth) creates a column specification having the specified width.

Input Arguments

colWidth — Width of column

character vector

Width of column, specified in the form valueUnits, where Units is an abbreviation for the width units. These abbreviations are valid:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Output Arguments

colSpecObj — Table column formatting

mlreportgen.ppt.ColSpec object

Table column formatting, returned as an mlreportgen.ppt.ColSpec object.

Properties

Id — ID for PPT API object

character vector | string scalar

ID for PPT API object, specified as a character vector. A session-unique ID is generated as part of object creation. You can specify an ID to replace the generated ID.

Tag — Tag for this PPT API object

character vector | string scalar

Tag for this PPT API object, specified as a character vector. A session-unique tag is generated as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object.

Specifying your own tag value can help you to identify where an issue occurred during presentation generation.

Width — Column width

character vector

Width of table column, specified in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Bold — Option to use bold for text

logical value

Option to use bold for text, specified as a logical. To make text bold, set this property to true or 1. Setting the Bold property adds a corresponding mlreportgen.ppt.Bold format object to the Style property of this presentation element. Removing the Bold property setting removes the object.

Data Types: logical

Font — Default font for text in column

character vector

Default font for text in column, specified as a character vector. Specify a font that appears in the PowerPoint^® list of fonts in the Home tab Font area.

ComplexScriptFont — Font family for complex scripts

character vector

Font family for complex scripts, specified as a character vector. Specify a font family for substituting in a locale that requires a complex script (such as Arabic or Asian) for rendering text.

FontColor — Font color for presentation element

character vector

Font color, specified as a character vector. Use either a CSS color name or a hexadecimal RGB value.

• For a list of CSS color names, see https://www.crockford.com/wrrrld/color.html.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for each for the red, green, and blue values. For example, '#0000ff' specifies blue.

FontSize — Font size

character vector

Font size, specified as a character vector. Use the format valueUnits, where Units is an abbreviation for the font size. These abbreviations are valid:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Italic — Option to use italics for text

[] (default) | logical value

Option to use italics for text, specified as a logical. Set this property to true. Setting the Italic property adds a corresponding mlreportgen.ppt.Italic format object to the Style property of this presentation element. Removing the Italic property setting removes the object.

Data Types: logical

Examples

Set Table Column Formatting

Create a presentation and add a slide.

import mlreportgen.ppt.*
slidesFile = 'myColSpec.pptx';
slides = Presentation(slidesFile);
tableSlide = add(slides,'Title and Content');

Create a table. Create a ColSpec object with a specified width for the first two columns of the table. Specify the BackgroundColor property for the two ColSpec objects. Set the ColSpecs property of the Table object t to the colSpecs, which specifies the formatting for the first two columns.

t = Table(magic(12));
t.Style = {HAlign('center')};

colSpecs(2) = ColSpec('2in');
colSpecs(1) = ColSpec('1in');
colSpecs(1).BackgroundColor = 'red';
colSpecs(2).BackgroundColor = 'green';
t.ColSpecs = colSpecs;

Add the table to the slide, generate the presentation, and open the myColSpec presentation. (The winopen code works on Windows^® platforms.)

replace(slides,'Content',t);
close(slides);

if ispc
    winopen(slidesFile);
end