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 (истинный цвет) значение в форме #RRGGBB.

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

Пример: 'blue'

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

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

Типы данных: логический

Цвет текста в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html), или шестнадцатеричный RGB (истинный цвет) значение в форме #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 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

Типы данных: логический

Текстовое перечеркивание в виде одного из этих значений:

  • 'none' — Никакое перечеркивание

  • 'single' — Одна строка

  • 'double' — Двойная линия (для Word сообщает только),

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

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

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

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

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и 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'

То же самое как 'пред'.Все

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

Методы

Метод

Цель

append

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

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

clone

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

Скопируйте объект номера.

Примеры

свернуть все

Скрипт Open 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

Поддержка

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