mlreportgen.dom.Table class

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

Создайте таблицу

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

Описание

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

Конструкция

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

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

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

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

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

расширить все

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

Свойства

расширить все

Цвет фона, заданный как вектор символов или строковый скаляр, который состоит из названия цвета 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' - поток слева направо

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

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

  • 'center'

  • 'left'

  • 'right'

Примечание

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

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

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

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

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

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

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

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

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

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

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

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

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

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

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

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

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

  • 'center'

  • 'left'

  • 'right'

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

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

  • 'top'

  • 'middle'

  • 'bottom'

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

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

clone

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

entry

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

row

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

Примеры

свернуть все

Открыть Live Script
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);

См. также

| | | | | |

Темы

MATLAB Report Generator

Поддержка

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