mlreportgen.dom.FormalTable class

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

Формальная таблица

Описание

Задает формальную таблицу, которая является таблицей, которая имеет тело и опционально табличный заголовок, табличный нижний колонтитул или обоих. Табличным заголовком, телом и нижним колонтитулом является mlreportgen.dom.TableHeader, mlreportgen.dom.TableBody, и mlreportgen.dom.TableFooter объекты, соответственно.

Конструкция

formalTableObj = FormalTable() составляет пустую формальную таблицу. Используйте этого конструктора в качестве начальной точки, чтобы составить формальную таблицу с нуля.

formalTableObj = FormalTable(ncols) составляет пустую формальную таблицу, имеющую конкретное количество столбцов.

formalTableObj = FormalTable(body) составляет формальную таблицу с заданным содержимым тела. Конструктор преобразует основные типы MATLAB® в соответствующие Объекты DOM. Например, конструктор преобразует векторы символов в mlreportgen.dom.Text объекты.

formalTableObj = FormalTable(body,styleName) составляет формальную таблицу, имеющую заданное содержимое тела и стиль.

formalTableObj = FormalTable(header,body) составляет формальную таблицу с заголовком и телом с помощью заданного содержимого и пустого нижнего колонтитула.

formalTableObj = FormalTable(header,body,styleName) составляет формальную таблицу с помощью заданного содержимого и стиля. Таблица имеет пустой нижний колонтитул.

formalTableObj = FormalTable(header,body,footer) составляет формальную таблицу с заданным содержимым для тела, заголовка и нижнего колонтитула.

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

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

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

Типы данных: 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 объект

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

Массив ячеек может содержать:

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

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

  • 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.FormalTable объект.

Свойства

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

Цвет фона в виде вектора символов или строкового скаляра, который состоит из названия цвета 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' — Теките слева направо (столбец 1 находится налево в таблице).

  • 'rtl' — Теките справа налево (столбец 1 находится направо в таблице).

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

  • 'center'

  • 'left'

  • 'right'

Примечание

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

Табличный конструктор создает табличный объект заголовка и присваивает его этому свойству, когда формальная таблица создается. Вы не можете впоследствии установить это свойство. Однако можно добавить содержимое к табличному телу и установить его свойства через это свойство.

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

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

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

Можно задать:

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

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

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

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

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

Можно установить StyleName свойство любого формального табличного раздела. Установка StyleName заменяет стиль, заданный самой формальной таблицей. Однако, если вы делаете это для документа Word, необходимо явным образом задать ширину каждого столбца в разделе, чтобы гарантировать, что все разделы имеют ту же ширину. Word, в отличие от HTML и PDF, не имеет никакой встроенной поддержки формальных таблиц. Чтобы обработать это, интерфейс DOM представляет формальную таблицу как три таблицы, один для каждого раздела, встроенного в 3x1 таблица.

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

Внутреннее поле является полем между содержимым ячейки таблицы и границами ячейки в форме 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

Используйте FormalTable.append похожий на то, как вы используете TableRow.append.

Добавьте строку записей таблицы к таблице

appendFooterRow

Добавьте строку, чтобы представить нижний колонтитул в виде таблицы

appendHeaderRow

Добавьте строку, чтобы представить заголовок в виде таблицы

clone

Используйте FormalTable.clone тем же путем вы используете Paragraph.clone.

Скопируйте таблицу