mlreportgen.dom.Heading class

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

Заголовок абзаца с использованием переменного уровня

Описание

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

Совет

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

Конструкция

headingObj = Heading(level) создает пустой заголовок на заданном уровне.

headingObj = Heading(level,text) создает указанный заголовок уровня, содержащий указанный текст.

headingObj = Heading(level,text,styleName) создает заданный заголовок уровня, содержащий заданный текст и с использованием заданного стиля.

headingObj = Heading(level,domObj) создает указанный заголовок уровня, содержащий указанный объект DOM.

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

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

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

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

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

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

Объект DOM для включения в заголовок, заданный как любой из следующих типов объектов DOM:

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • Text

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

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

Заголовок пункта, представленный mlreportgen.dom.Heading объект.

Свойства

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

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

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

Пример: 'blue'

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

Использовать ли полужирный цвет для текста, заданный как число или логическое 1 (true) или 0 (false). Чтобы сделать текст жирным, установите Bold на true или 1.

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

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

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

Пример: 'blue'

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

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

Сумма отступа для первой линии этого абзаца, заданная как вектор символов или строковый скаляр, который состоит из числа, за которым следует сокращение для единицы измерения. Для примера '0.5in' задает половину дюйма. Допустимые сокращения:

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

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

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

Пример: '0.5in'

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

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

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

Пример: 'Courier New'

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

  • px - пиксели

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

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

'center'

Центрируйте абзац

Все

'distribute'

Распределите все символы одинаково

Word

'justify'

Выровняйте левую часть абзаца в левой части страницы или таблицы и правую часть абзаца в правой части страницы или таблицы.

Все

'KashidaHigh'

Используйте самую широкую длину Кашиды.

Кашида - тип обоснования, используемый для некоторых скоропортящихся скриптов, таких как арабский и персидский.

Word

'KashidaLow'

Используйте самую низкую длину Кашиды

Word

'KashidaMedium'

Используйте среднюю длину Кашиды

Word

'left'

Выровнять абзац влево

Все

'right'

Выравнивание права абзаца

Все

'ThaiDistribute'

Обоснование тайского языка

Word

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

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

Использовать ли курсив для текста, заданный как числовой или логический 1 (true) или 0 (false). Чтобы сделать текст курсивным, установите Italic на true или 1.

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

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

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

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

  • in - дюймы

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

  • pc - picas

  • pt - точки

Уровень контура абзаца, заданный как целое число. Установка OutlineLevel свойство приводит к тому, что этот абзац включается в автоматически сгенерированные контуры, такие как таблицы содержимого. Значение задает уровень абзаца в контуре. Для примера, чтобы абзац появился на верхнем уровне в контуре, установите OutlineLevel свойство к 1.

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

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

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

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

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

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

Массив mlreportgen.dom.DOCXSection объекты, задающие формат текста.

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

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

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

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

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

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

clone

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

Копировать заголовок.

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