exponenta event banner

mlreportgen.dom.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 (truecolor) в форме #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'

Без строки

'none' тип границы также не приводит к появлению строки. Однако конфликтующие границы обрабатываются по-разному для 'hidden' типы, чем для 'none' типы. 'hidden' тип границы имеет приоритет над конфликтующим типом границы. Конфликтующий тип границы имеет приоритет над 'none' тип.

HTML и PDF

'inset'

3-D строка эффекта

Все типы вывода

'none'

Без строки

'hidden' тип границы также не приводит к появлению строки. Однако конфликтующие границы обрабатываются по-разному для 'hidden' типы, чем для 'none' типы. 'hidden' тип границы имеет приоритет над конфликтующим типом границы. Конфликтующий тип границы имеет приоритет над '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 (truecolor) как #RRGGBB. Например, #0000ff - оттенок синего.

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

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

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

Цвет разделяющих колонн, указанный как:

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

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

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

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

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

Направление потока колонны, указанное как:

  • 'ltr' - Поток слева направо (столбец 1 находится слева в таблице).

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

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

  • 'center'

  • 'left'

  • 'right'

Примечание

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

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

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

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

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

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

Можно указать:

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

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

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

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

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

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

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

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

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

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

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

Методы

Метод

Цель

append

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

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

appendFooterRow

Добавить строку в нижний колонтитул таблицы

appendHeaderRow

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

clone

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

Копирование таблицы