mlreportgen.dom.Table class

Пакет: mlreportgen.dom
Суперклассы:

Составьте таблицу

Описание

Используйте mlreportgen.dom.Table объект задать таблицу. Добавьте строки и записи таблицы, чтобы добавить содержимое в таблицу. Можно задать свойства столбца.

Конструкция

tableObj = Table(nCols) составляет пустую таблицу, имеющую конкретное количество столбцов. Используйте этого конструктора в качестве начальной точки для того, чтобы составить таблицу с нуля.

tableObj = Table(array) возвращает таблицу, содержимое которой задано массивом. Конструктор преобразует основные типы MATLAB® в соответствующие типы DOM, например, векторы символов к Текстовым объектам.

tableObj = Table(array,style) составляет таблицу, имеющую заданный стиль. Стиль задан style должен быть задан в шаблоне, используемом, чтобы создать документ, к которому добавлена эта таблица.

Входные параметры

развернуть все

Количество столбцов таблицы в виде двойного.

Типы данных: double

Табличное содержимое тела в виде:

  • Двумерный числовой массив

  • Двумерный категориальный массив

  • Двумерный массив ячеек, который может содержать:

    • Векторы символов

    • Один - или двумерный массив ячеек

    • double

    • mlreportgen.dom.Text объект

    • mlreportgen.dom.Paragraph объект

    • mlreportgen.dom.Image объект

    • mlreportgen.dom.Table объект

    • mlreportgen.dom.FormalTable объект

    • mlreportgen.dom.OrderedList объект

    • mlreportgen.dom.UnorderedList объект

    • mlreportgen.dom.ExternalLink объект

    • mlreportgen.dom.InternalLink объект

    • mlreportgen.dom.CharEntity объект

Разработайте для таблицы в виде вектора символов. Заданный стиль должен быть задан в шаблоне, используемом документом, к которому вы добавляете эту таблицу.

Выходные аргументы

развернуть все

Таблица, представленная mlreportgen.dom.Table объект.

Свойства

развернуть все

Цвет фона в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html), или шестнадцатеричный RGB (истинный цвет) значение в форме #RRGGBB.

Установка BackgroundColor свойство добавляет соответствующий mlreportgen.dom.BackgroundColor объект формата к Style свойство. Установка BackgroundColor свойство к пустому значению удаляет объект.

Пример: 'blue'

Пример: '#0000ff'

Тип границы, чтобы чертить в виде одного из этих значений.

Ограничьте значениеОписаниеПоддерживаемые Выходные типы

'dashed'

Пунктирная линия

Все выходные типы

'dashdotstroked'

Линия с переменными диагональными тире и точкой

Word

'dashsmallgap'

Пунктирная линия с маленьким разрывом между тире

Word

'dotted'

Пунктирная линия

Все выходные типы

'dotdash'

Линия с чередованием точек и тире

Word

'dotdotdash'

Линия с чередованием двойных точек и тире

Word

'double'

Двойная линия

Все выходные типы

'doublewave'

Удвойте волнистую линию

Word

'groove'

3-D эффект формировал канавки линия

HTML и PDF

'hidden'

Никакая линия

Смотрите обсуждение ниже этой таблицы.

HTML и PDF

'inset'

3-D линия эффекта

Все выходные типы

'none'

Никакая линия

Смотрите обсуждение ниже этой таблицы.

Все выходные типы

'outset'

3-D линия эффекта

Все выходные типы

'ridge'

3-D эффект остроконечная линия

HTML и PDF

'single'

Одна строка

Word

'solid'

Одна строка

HTML и PDF

'thick'

Толстая линия

Word

'thickthinlargegap'

Пунктирная линия с чередованием толстых и тонких тире с большим разрывом

Word

'thickthinmediumgap'

Пунктирная линия с чередованием толстых и тонких тире со средним разрывом

Word

'thickthinsmallgap'

Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывом

Word

'thinthicklargegap'

Пунктирная линия с переменными тонкими и толстыми тире со средним разрывом

Word

'thinthickmediumgap'

Пунктирная линия с переменными тонкими и толстыми тире, со средним разрывом

Word

'thinthicksmallgap'

Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывом

Word

'thinthickthinlargegap'

Пунктирная линия с переменными тонкими и толстыми тире с большим разрывом

Word

'thinthickthinmediumgap'

Пунктирная линия с переменными тонкими и толстыми тире со средним разрывом

Word

'thinthickthinsmallgap'

Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывом

Word

'threedemboss'

Рельефная линия эффекта

Word

'threedengrave'

Выгравированная линия эффекта

Word

'triple'

Тройная линия

Word

'wave'

Волнистая линия

Word

Значение 'on' границы коллапсов соседних элементов в одну границу. Значение 'off' сохраняет границы соседних элементов.

Цвет рамки в виде также:

  • Имя цвета. Имя должно быть названием цвета CSS. См. https://www.crockford.com/wrrrld/color.html.

  • Шестнадцатеричный RGB (истинный цвет) значение как #RRGGBB. Например, #0000ff оттенок синего цвета.

Ширина границы таблицы, заданная в форме valueUnits, где Units сокращение от модулей. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Дочерние элементы этого элемента документа в виде массива Объектов DOM. Это свойство доступно только для чтения.

Стиль линии, разделяющей столбцы табличного или табличного раздела (заголовок, тело, нижний колонтитул), как задано mlreportgen.dom.ColSep объект.

См. описание Border свойство для описания возможных значений.

Цвет столбцов разделения линии в виде также:

  • Имя цвета. Имя должно быть названием цвета CSS. См. https://www.crockford.com/wrrrld/color.html.

  • Шестнадцатеричный RGB (истинный цвет) значение как #RRGGBB. Например, #0000ff оттенок синего цвета.

Ширина столбцов таблицы разделения линии, в форме valueUnits. Используйте одно из этих сокращений от Units:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Например, для разделителя столбцов 3 точек, устанавливает ColSepWidth свойство к '3pt'.

Массив mlreportgen.dom.TableColSpecGroup объекты, который задает ширину, выравнивание и другие свойства группы столбцов. Первый объект применяется к первой группе столбцов, второму объекту второй группе, и так далее. Задайте количество столбцов, принадлежащих каждой группе, использующей Span свойство TableColSpecGroup объект. Например, если первый объект имеет промежуток 2, он применяется к первым двум столбцам. Если у второй группы есть промежуток 3, она применяется к следующим трем столбцам и так далее.

Пользовательские атрибуты должны поддерживаться выходным типом документа, к которому добавлен этот элемент документа.

Направление для текста, чтобы течь в виде одного из этих значений:

  • 'ltr' — теките слева направо

  • 'rtl' — теките справа налево

Выравнивание по горизонтали этой таблицы в виде одного из этих значений:

  • 'center'

  • 'left'

  • 'right'

Примечание

Чтобы предотвратить переполнение больших таблиц в PDF выход, установите Width свойство.

ID для этого элемента документа в виде вектора символов или строкового скаляра. DOM генерирует уникальный идентификатор сеанса, когда он создает элемент документа. Можно задать собственный ID.

Количество столбцов таблицы в виде целого числа. Это свойство доступно только для чтения. Чтобы задать количество столбцов, составьте таблицу при помощи синтаксиса mlreportgen.dom.Table(nCols). В противном случае, Table конструктор определяет количество столбцов от табличного содержимого. Если вы добавляете строки в таблицу или записи в строку и количество изменений столбцов, значение NCols свойство обновляется. Если строки все не имеют того же количества записей, строка с наибольшим числом записей таблицы определяет количество столбцов в таблице.

Количество строк в этой таблице в виде целого числа. Это свойство доступно только для чтения. Table конструктор определяет количество строк от табличного содержимого. Если вы добавляете строки в таблицу, значение NRows свойство обновляется.

Оставленное добавление отступа в форме valueUnitsМодули сокращение от модулей. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Родительский элемент этого элемента документа в виде Объекта DOM. Это свойство доступно только для чтения.

Стиль линии, разделяющей строки табличного или табличного раздела (заголовок, тело или нижний колонтитул).

См. описание Border свойство для описания возможных значений.

Цвет линий, разделяющих строки таблицы в виде одного из этих значений:

  • Имя цвета. Смотрите mlreportGen.dom.Color страница ссылки класса для списка поддерживаемых цветов.

  • Шестнадцатеричный RGB (истинный цвет) значение как #RRGGBB. Например, #0000ff оттенок синего цвета.

Ширина линий, разделяющих строки таблицы в форме valueUnits, где Units сокращение от модулей. Используйте одно из этих сокращений:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Массив объектов формата (таких как Bold объекты), которые задают формат для этой таблицы.

Это свойство заменяет соответствующие форматы, заданные стилем таблицы стилей, заданным StyleName свойство.

Имя стиля задало в таблице стилей части документа или документа, к которой добавлена эта таблица

Стиль, который задает внешний вид этой таблицы в выходном документе для форматов, не заданных Style свойство.

Выравнивание по горизонтали записей таблицы в виде одного из этих значений:

  • 'center'

  • 'left'

  • 'right'

Типы данных: char

Выравнивание по вертикали содержимого ячейки таблицы в виде одного из этих значений:

  • 'top'

  • 'middle'

  • 'bottom'

Внутреннее поле является полем между содержимым ячейки таблицы и границами ячейки в форме valueUnits где Units сокращение от модулей. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Массив ячеек объектов формата, которые задают формат для записей таблицы.

Пометьте для этого элемента документа в виде вектора символов.

DOM генерирует уникальный для сеанса тег, когда он создает элемент документа. Структурируйте тег как class:id, где class класс элемента и id значение Id свойство. Можно задать тег, чтобы заменить сгенерированный тег. Определение вашего собственного тега может облегчить идентифицировать, где проблема произошла во время генерации документов.

Процент (например, '100%') из страницы width (минус поля для отчетов Word) или много единиц измерения, имея формат valueUnitsМодули сокращение от модулей. Это допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Методы

Метод

Цель

append

Добавьте содержимое к таблице.

clone

Клонируйте эту таблицу.

entry

Получите запись таблицы.

row

Создайте строку таблицы.

Примеры

свернуть все

import mlreportgen.dom.*;
d = Document('myreport','html');
open(d); 

t = Table(magic(5));
t.Style = {RowHeight('1in')};
t.Border = 'solid';
t.BorderWidth = '1px';
t.ColSep = 'solid';
t.ColSepWidth = '1';
t.RowSep = 'solid';
t.RowSepWidth = '1';

% Set this property first to prevent overwriting alignment properties
t.TableEntriesStyle = {FontFamily('Arial'),Width('1in'),Color('red'),Bold};
t.TableEntriesHAlign = 'center';
t.TableEntriesVAlign = 'middle';

append(d,t);
close(d);
rptview(d.OutputPath);