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 (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'

Нет линии

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

HTML и PDF

'inset'

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

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

'none'

Нет линии

The 'hidden' тип границы также не создает линию. Однако конфликтующие границы обрабатываются по-разному 'hidden' типы, чем для 'none' типы. The '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 - picas

  • 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 - picas

  • 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 - picas

  • pt - точки

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

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

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

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

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

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

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

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

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

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

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

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

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

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

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

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

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

Методы

Метод

Цель

append

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

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

appendFooterRow

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

appendHeaderRow

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

clone

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

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

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