mlreportgen.dom. Класс FormalTable

Пакет: 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. Например, #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'

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

Стиль строки, разделяющей столбцы табличного или табличного раздела (заголовок, тело, нижний колонтитул), как задано объектом 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. Units является сокращением от модулей. Допустимые сокращения:

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

  • cm — 'centimeters'

  • \in 'inches'

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

  • pc — цицеро

  • pt — 'points'

Это списки свойств только для чтения родительский элемент этого элемента документа.

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

См. описание свойства 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'

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

Уникальный идентификатор сеанса сгенерирован как часть создания элемента документа. Сгенерированный тег имеет форму CLASS:ID, где CLASS является классом элемента, и ID является значением свойства Id объекта. Можно задать тег, чтобы заменить сгенерированный тег.

Например, чтобы облегчить идентифицировать, где проблема произошла во время генерации документов, можно задать собственное значение тега.

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

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

  • cm — 'centimeters'

  • \in 'inches'

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

  • pc — цицеро

  • pt — 'points'

Методы

Метод

Цель

append

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

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

clone

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

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

Для просмотра документации необходимо авторизоваться на сайте