mlreportgen.dom. Класс AutoNumber

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

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

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

Описание

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

Конструкция

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

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

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

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

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

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

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

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

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

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

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

Свойства

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

Цвет фона, заданный как также:

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

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

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

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

Цвет текста, заданный как также:

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

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

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

Имя семейства шрифтов.

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

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

Если необходимо задать замены на этот шрифт, не устанавливайте это свойство. Вместо этого создайте и добавьте объект 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' Не используйте перечеркивание.

  • единственный Используйте одну строку для перечеркивания.

  • 'double' Используйте двойную строку для перечеркивания для документов Word.

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

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

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

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

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

Например, чтобы облегчить идентифицировать, где проблема произошла во время генерации документов, можно задать собственное значение тега.

Можно задать один из следующих типов подчеркиваний.

Ограничьте значениеОписаниеПоддерживаемые Выходные типы

'dash'

Пунктирное подчеркивание

Word

'dashedHeavy'

Строка с тяжелыми тире

Word

'dashLong'

Строка с длинными тире

Word

'dashLongHeavy'

Строка с тяжелыми длинными тире

Word

'dashDotDotHeavy'

Строка с тяжелыми тире с двумя точками между тире

Word

'dashDotHeavy'

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

Word

'dotted'

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

Word

'dottedHeavy'

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

Word

'dotDash'

Точечный штриховой пунктир

Word

'dotDotDash'

Точечный точечный штриховой пунктир

Word

'dashDotHeavy'

Тяжелый точечный штриховой пунктир

Word

'double'

Двойная строка

Word

'none'

Не используйте подчеркивание

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

'single'

Одна строка

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

'thick'

Толстая строка

Word

'wave'

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

Word

'waveyDouble'

Удвойте волнистую строку

Word

'waveyHeavy'

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

Word

'words'

Подчеркните непробелы только

Word

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

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

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

Чтобы задать, как обработать пробел, используйте одно из этих значений.

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

'normal' (значение по умолчанию)

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

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

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

'nowrap'

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

HTML

'preserve'

Пробелы консервов и переводы строки. Законы как <pre> помечают в HTML.

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

'pre'

Пробел консервов. Текст переносится только на разрывах строки. Законы как <pre> помечают в HTML.

HTML и PDF

'pre-line'

Последовательности пробела выходят из строя в один пробел. Текст переносится.

HTML и PDF

'pre-wrap'

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

HTML и PDF

Установка свойства WhiteSpace добавляет соответствующий объект формата WhiteSpace в свойство Style. Удаление установки свойства WhiteSpace удаляет объект 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
Поддержка
Для просмотра документации необходимо авторизоваться на сайте