Exponenta Banner
exponenta event banner

mlreportgen.dom.Paragraph class

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

Отформатированный блок текста (абзац)

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

Описание

Используйте mlreportgen.dom.Paragraph объект задать абзац. Можно добавить элементы документа, такие как изображение, к абзацу.

Конструкция

paragraphObj = Paragraph(text) создает абзац, содержащий mlreportgen.dom.Text объект с текстом, заданным text.

paragraphObj = Paragraph(text,styleName) создает абзац, указывающий, что это разрабатывает. Стиль задан styleName должен быть задан в шаблоне, используемом в элементе документа, к которому добавлен этот абзац.

paragraphObj = Paragraph(docElementObj) создает абзац, содержащий элемент документа, указанный docElementObj (например, изображение).

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

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

Текст абзаца, заданный как вектор символов.

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

Объект DOM, чтобы включать в абзац. Можно задать эти Объекты DOM:

  • mlreportgen.dom.ExternalLink

  • mlreportgen.dom.Image

  • mlreportgen.dom.InternalLink

  • mlreportgen.dom.Text

  • mlreportgen.dom.LinkTarget

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

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

Абзац, представленный mlreportgen.dom.Paragraph объект.

Свойства

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

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

  • Имя цвета. Имя должно быть названием цвета 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.Image) объект, что абзац содержит.

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

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

Задайте значение в форме valueUnits, где Units сокращение от модулей. Используйте одно из этих сокращений от модулей.

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

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

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

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

'center'

Сосредоточьте абзац

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

'distribute'

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

Word

'justify'

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

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

'KashidaHigh'

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

Word

'KashidaLow'

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

Word

'KashidaMedium'

Используйте среднюю длину Kashida

Word

'left'

Выровняйте абзац по левому краю

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

'right'

Выровняйте абзац по правому краю

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

'ThaiDistribute'

Тайское выравнивание языка

Word

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

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

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

Пробел между левой внешней границей этого абзаца и левой внутренней границей его контейнера. Это эквивалентно левому свойству добавления отступа абзаца Word Microsoft®.

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

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

Значение имеет форму valueUnits, где Units сокращение от модулей. Используйте одно из этих сокращений от модулей:

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

Установка OutlineLevel свойство заставляет этот абзац быть включенным в автоматически сгенерированные основы, такие как оглавление. Значение задает уровень абзаца в оглавлении. Например, чтобы заставить абзац появиться как Heading 1 (Word) или h1 (HTML), набор OutlineLevel к 1.

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

Это списки свойств только для чтения родительский элемент этого элемента документа.

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

  • 'none' — Не используйте перечеркивание.

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

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

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

Массив ячеек объектов формата DOM, который задает форматы для этого стиля абзаца.

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

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

DOM генерирует уникальный для сеанса тег, когда он создает элемент документа. Структурируйте тег как 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

Добавьте текст, изображения, ссылки, цели ссылки или пользовательские элементы к абзацу.

clone

Скопируйте абзац.

Примеры

свернуть все

Скрипт Open Live Script

Добавьте абзац с текстом и другого с внешней ссылкой. 

import mlreportgen.dom.*
doc = Document('mydoc','html');

p1 = Paragraph('This will be bold text');
p1.Bold = true;
link = ExternalLink('https://www.mathworks.com/', 'MathWorks');
p2 = Paragraph(link);
p2.BackgroundColor = 'yellow';
append(doc,p1);
append(doc,p2);

close(doc);
rptview('mydoc','html');

Смотрите также

| |

Темы

Документация MATLAB Report Generator
Поддержка