mlreportgen.dom.AutoNumber class

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

Автоматически сгенерированный номер

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

Описание

Автоматически сгенерированный номер для объекта элемента документа DOM.

Конструкция

autoObj = AutoNumber() создает автоматически сгенерированный номер без заданного потока номеров.

autoObj = AutoNumber(stream) создает число на основе заданного потока нумерации.

autoObj = AutoNumber(stream,styleName) создает число с использованием заданного стиля.

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

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

Задайте нумерационный поток, используя значение mlreportgen.dom.AutoNumberStream StreamName объекта свойство.

Если указанный поток не существует, интерфейс DOM создает поток арабского номера с заданным именем с начальным значением 0. Чтобы использовать поток с другими свойствами, такими как римские цифры, создайте поток с помощью mlreportgen.dom.Document.createAutoNumberStream.

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

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

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

Автоматически созданный числовой объект, заданный как mlreportgen.dom.AutoNumber объект.

Свойства

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

Цвет фона, заданный как вектор символов или строковый скаляр, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html) или шестнадцатеричного значения RGB (truecolor) в форме #RRGGBB.

Установка BackgroundColor свойство добавляет соответствующее mlreportgen.dom.BackgroundColor форматировать объект в Style свойство. Установка BackgroundColor свойство для пустого значения удаляет объект.

Пример: 'blue'

Пример: '#0000ff'

Чтобы сделать текст жирным, задайте для этого свойства true или 1. Если это свойство пусто, и StyleName свойство для этого элемента документа задает стиль таблицы стилей, вес номера определяется этим стилем. Установка Bold свойство добавляет соответствующее mlreportGen.dom.Bold форматировать объект в Style свойство этого элемента документа. Удаление Bold установка свойства удаляет объект.

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

Цвет текста, заданный как вектор символов или строковый скаляр, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html) или шестнадцатеричного значения RGB (truecolor) в форме #RRGGBB.

Установка Color свойство добавляет соответствующее mlreportgen.dom.Color форматировать объект в Style свойство. Установка Color свойство для пустого значения удаляет объект.

Пример: 'blue'

Пример: '#0000ff'

Пользовательские атрибуты этого элемента документа, заданные как массив mlreportgen.dom.CustomAttribute объекты. Пользовательские атрибуты должны поддерживаться форматом выхода.

Имя семейства шрифтов для текста, заданное как вектор символов или строковый скаляр.

Установка FontFamilyName свойство добавляет соответствующее mlreportgen.dom.FontFamily форматировать объект в Style свойство. Установка FontFamilyName свойство совпадает с настройкой FontName свойство mlreportgen.dom.FontFamily объект. Установка FontFamilyName свойство для пустого значения удаляет объект.

Чтобы задать замены для шрифта, не указывайте семейство шрифтов, задав это свойство. Вместо этого создайте и добавьте mlreportgen.dom.FontFamily объект для Style свойство.

Пример: 'Courier New'

Если вам нужно задать замены для этого шрифта, не устанавливайте это свойство. Вместо этого создайте и добавьте mlreportgen.dom.FontFamily объект для Style свойство этого элемента документа.

Установка FontSize свойство добавляет соответствующее mlreportGen.dom.FontSize форматировать объект в Style свойство для этого элемента документа. Удаление FontSize установка свойства удаляет объект.

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

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

Чтобы использовать курсив для числа, задайте для этого свойства true. Если это свойство пусто, и StyleName свойство для этого элемента документа задает стиль таблицы стилей, наклон числа определяется этим стилем. Установка Italic свойство добавляет соответствующее mlreportGen.dom.Italic форматировать объект в Style свойство этого элемента документа. Удаление Italic установка свойства удаляет объект.

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

Зачеркивание текста, заданное как одно из следующих значений:

  • 'none' - Без зачеркивания

  • 'single' - Одна линия

  • 'double' - Двойная линия (только для отчетов Word)

Установка Strike свойство добавляет соответствующее mlreportgen.dom.Strike форматировать объект в Style свойство для этого элемента документа. Установка Strike свойство для пустого значения удаляет объект.

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

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

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

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

Тип подчеркивания, заданный как одно из значений в этой таблице.

Подчеркивание значенияОписаниеПоддерживаемые выходные типы

'single'

Одна линия

Все

'words'

Подчеркивайте все символы, кроме пространств

Word

'double'

Двойная линия

Word

'thick'

Толстая линия

Word

'dotted'

Пунктирная линия

Word

'dottedHeavy'

Толстая пунктирная линия

Word

'dash'

Штриховая линия

Word

'dashedHeavy'

Линия с тяжелыми штрихами

Word

'dashLong'

Линия с длинными штрихами

Word

'dashLongHeavy'

Линия с тяжелыми длинными штрихами

Word

'dotDash'

Пунктирная линия

Word

'dashDotHeavy'

Тяжелая штрих-пунктирная линия

Word

'dotDotDash'

Пунктирная линия

Word

'dashDotDotHeavy'

Линия с тяжелыми штрихами с двумя точками между штрихами

Word

'wave'

Волнистая линия

Word

'wavyHeavy'

Тяжеловолнистый

Word

'wavyDouble'

Двойная волнистая линия

Word

'none'

Нет подчеркивания

Все

Установка Underline свойство добавляет соответствующее mlreportgen.dom.Underline форматировать объект в Style свойство. Установка Underline свойство для пустого значения удаляет объект.

Чтобы задать и цвет, и тип подчеркивания, не устанавливайте Underline свойство. Вместо этого установите Style свойство для включения в mlreportgen.dom.Underline формат объекта, который задает тип и цвет подчеркивания.

Как обработать пустое пространство в тексте, заданное как одно из значений в этой таблице.

ЗначениеОписаниеПоддерживаемые выходные типы

'normal'

Для HTML и PDF это значение удаляет пространства в начале и конце текста. Несколько пространства в тексте свернуты в одно пространство.

Для Word это значение удаляет пространства в начале и конце текста.

Все

'nowrap'

Последовательности белого пространства коллапсируют в единое пустое пространство. Текст никогда не переносится в следующую линию.

HTML

'pre'

Сохраняет пустое пространство. Текст переносится только на пропуски линий. Действует как <pre> тег в HTML.

HTML и PDF

'pre-line'

Последовательности белого пространства коллапсируют в единое пустое пространство. Текст переносится при необходимости и на пропусках линий.

HTML и PDF

'pre-wrap'

Сохраняет пустое пространство. Текст переносится при необходимости и на пропусках линий.

HTML и PDF

'preserve'

То же, что и 'pre'.Все

Установка WhiteSpace свойство добавляет соответствующее mlreportgen.dom.WhiteSpace форматировать объект в Style свойство. Установка WhiteSpace свойство для пустого значения удаляет объект.

Методы

Метод

Цель

append

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

Добавьте пользовательский элемент к этому номеру.

clone

Использование AutoNumber.clone способом, подобным тому, как вы используете Paragraph.clone.

Скопируйте числовой объект.

Примеры

свернуть все

Открыть Live Script
import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

p = Paragraph('Chapter ');
p.Style = {CounterInc('chapter'),CounterReset('table'),...
  WhiteSpace('preserve')};
append(p,AutoNumber('chapter'));
append(d,p);
     
p = Paragraph('Table ');
append(p,AutoNumber('chapter'));
append(p,'.');
append(p,AutoNumber('table'));
p.Style = {CounterInc('table'),WhiteSpace('preserve')};
append(d,p);
     
p = Paragraph('Chapter ');
p.Style = {CounterInc('chapter'),CounterReset('table'),...
  WhiteSpace('preserve')};
append(p,AutoNumber('chapter'));
append(d,p);
     
p = Paragraph('Table ');
append(p, AutoNumber('chapter'));
append(p,'.');
append(p,AutoNumber('table'));
p.Style = {CounterInc('table'),WhiteSpace('preserve')};
append(d,p);
     
close(d);
rptview('test',doctype);

См. также

| | |

Темы

MATLAB Report Generator

Поддержка

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