mlreportgen.ppt.ColSpec class

Package: mlreportgen.ppt

Formatting for table column

Description

Use an object of the mlreportgen.ppt.ColSpec class to format the content of a table column in a PPT API presentation. Specify formats by setting the format properties, adding format objects to the Style property, or a combination of the two. See Presentation Formatting Approaches.

The mlreportgen.ppt.ColSpec class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

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

colSpecObj = mlreportgen.ppt.ColSpec(colWidth) sets the Width property to colWidth.

Properties

Width — Column width

[] (default) | character vector | string scalar

Table column width, specified as a character vector or string scalar that consists of a number followed by a unit of measurement. For example, '2in' specifies 2 inches. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Bold — Option to use bold for the column text

[] (default) | true or 1 | false or 0

Option to use bold for column text, specified as a numeric or logical 1 (true) or 0 (false). To make text bold, set this property to true or 1.

Font — Font family for column text

[] (default) | character vector | string scalar

Font family for the column text, specified as a character vector or string scalar. Specify a font that appears in the font list in Microsoft^® PowerPoint^®. To see the font list, in PowerPoint, on the Home tab, in the Font group, click the arrow to the right of the font.

ComplexScriptFont — Font family for complex scripts

[] (default) | character vector | string scalar

Font family for complex scripts, specified as a character vector or string scalar. Specify a font family to use when substituting in a locale that requires a complex script, such as Arabic or Asian, for rendering text.

FontColor — Font color of column text

[] (default) | character vector | string scalar

Font color of the column text, specified as a character vector or string scalar, formatted as 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 the red, green, and blue values. For example, '#0000ff' specifies blue.

FontSize — Font size of column text

[] (default) | character vector | string scalar

Font size of the column text, specified as a character vector or string scalar that consists of a number followed by a unit of measurement. For example, '11pt' specifies 11 points. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Italic — Option to use italic for column text

[] (default) | true or 1 | false or 0

Option to use italic for column text, specified as a numeric or logical 1 (true) or 0 (false). If Italic is true or 1, text renders in italic. If Italic is false or 0, text renders as roman (straight).

Strike — Strikethrough style of column text

[] (default) | 'single' | 'none' | 'double'

Strikethrough style of the column text, specified as a character vector or string scalar. Specify one of these values:

• 'single' — Single horizontal line

• 'none' — No strikethrough line

• 'double' — Double horizontal line

Subscript — Option to render column text as a subscript

[] (default) | true or 1 | false or 0

Option to render column text as a subscript, specified as a numeric or logical 1 (true) or 0 (false). If Subscript is true or 1, text renders as a subscript. If Subscript is false or 0, text renders as regular text.

Superscript — Option to render column text as a superscript

[] (default) | true or 1 | false or 0

Option to render column text as a superscript, specified as a numeric or logical 1 (true) or 0 (false). If Superscript is true or 1, text renders as a superscript. If Superscript is false or 0, text renders as regular text.

Underline — Underline style for column text

[] (default) | 'single' | 'double' | ...

Underline style for column text, specified as a character vector or string scalar. Specify one of the values in the table.

Value	Description
'single'	Single underline
'double'	Double underline
'heavy'	Thick underline
'words'	Only words underlined (not spaces)
'dotted'	Dotted underline
'dottedheavy'	Thick, dotted underline
'dash'	Dashed underline
'dashheavy'	Thick, dashed underline
'dashlong'	Long, dashed underline
'dashlongheavy'	Thick, long, dashed underline
'dotdash'	Dot-dash underline
'dotdashheavy'	Thick, dot-dash underline
'dotdotdash'	Dot-dot-dash underline
'dotdotdashheavy'	Thick, dot-dot-dash underline
'wavy'	Wavy underline
'wavyheavy'	Thick, wavy underline
'wavydouble'	Wavy, double underline
'none'	No underline

BackgroundColor — Column background color

[] (default) | character vector | string scalar

Background color, specified as a character vector or string scalar, formatted as 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 the red, green, and blue values. For example, '#0000ff' specifies blue.

HAlign — Horizontal alignment of column content

[] (default) | 'center' | 'left' | ...

Horizontal alignment of the content in table entries of the column, specified as a character vector or string scalar. Specify one of the values in the table.

Value	Description
'center'	Centered
'left'	Left-justified
'right'	Right-justified
'justified'	Left and right-justified, spacing words evenly
'distributed'	Left and right-justified, spacing letters evenly
'thaiDistributed'	Left and right-justified Thai text, spacing characters evenly
'justifiedLow'	Justification for Arabic text

VAlign — Vertical alignment of column content

[] (default) | 'top' | 'bottom' | ...

Vertical alignment of the content in table entries of the column, specified as a character vector or string scalar. Specify one of the values in the table.

Value	Description
'top'	Vertically aligned to the top
'bottom'	Vertically aligned to the bottom of the table entry
'middle'	Vertically aligned to the middle of the table entry
'topCentered'	Vertically aligned to the top and horizontally aligned to the center of the table entry
'bottomCentered'	Vertically aligned to the bottom and horizontally aligned to the center of the table entry
'middleCentered'	Vertically aligned to the middle and horizontally aligned to the center of the table entry

TextOrientation — Orientation of column text

[] (default) | 'horizontal' | 'down' | 'up'

Orientation of the column text, specified as a character vector or string scalar. Specify one of the values in the table.

Value	Description
'horizontal'	Text orientation is horizontal.
'down'	Text orientation is vertical, with the content rotated 90 degrees, clockwise.
'up'	Text orientation is vertical, with the content rotated 90 degrees, counterclockwise.

See Specify Orientation of Column Text.

Style — Column formatting

cell array of PPT format objects

Column formatting, specified as a cell array of PPT API format objects. Formats that do not apply to a ColSpec object are ignored.

Children — Children of this PPT API object

cell array of PPT objects

Child elements of this object, specified as a cell array of PPT objects. This property is read-only.

Parent — Parent of this PPT API object

PPT object

Parent of this object, specified as a PPT object. This property is read-only.

Tag — Tag for this PPT API object

character vector | string scalar

Tag for this PPT API object, specified as a character vector or string scalar. 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.

Id — ID for this PPT API object

character vector | string scalar

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

Examples

Specify Table Column Formatting

Create a presentation and add a slide.

import mlreportgen.ppt.*

ppt = Presentation('myColSpec.pptx');
open(ppt);
slide = add(ppt,'Title and Content');

Create a table. Specify the width and background color of the first two columns of the table.

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.

replace(slide,'Content',t);

Close and view the presentation.

close(ppt);
rptview(ppt);

Specify Orientation of Column Text

Create a presentation.

import mlreportgen.ppt.*
ppt = Presentation("myTextOrientation.pptx");
open(ppt);

Add a slide to the presentation.

slide = add(ppt,"Title and Table");

Create a table.

table = Table({'Col 1','Col 2';'entry 1','entry 2'});
table.Height = "2in";
table.Style = [table.Style {VAlign("middleCentered")}];

Define the formatting for the table columns by using mlreportgen.ppt.ColSpec objects. Specify that the orientation of the text in the first column is vertical, rotated 90 degrees, counterclockwise. Specify that the orientation of the text in the second column is vertical, rotated 90 degrees, clockwise.

colSpecs(1) = ColSpec("1in");
colSpecs(1).TextOrientation = "up";
colSpecs(2) = ColSpec("1in");
colSpecs(2).TextOrientation = "down";

Assign the ColSpec objects to the Table object.

table.ColSpecs = colSpecs;

Add the table to the slide.

replace(slide,"Table",table);

Close and view the presentation

close(ppt);
rptview(ppt);