Exponenta Banner
exponenta event banner

класс mlreportgen.dom.AutoNumber

Пакет: 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 - пикас

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

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

Примеры

свернуть все

Открыть сценарий в реальном времени
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

Поддержка