mlreportgen.dom.Heading1 class

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

Создайте Heading1 абзац

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

Описание

Создайте mlreportgen.dom.Heading1 объект абзаца.

Конструкция

headingObj = Heading1() создает пустой Heading1 объект.

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

headingObj = Heading1(text,styleName) создает заголовок с использованием заданного стиля.

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

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

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

`text` - Текст заголовка
вектор символов

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

`styleName` - Стиль для заголовка
вектор символов

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

`domObj` - Объект DOM для включения в заголовок
`mlreportgen.dom.ExternalLink` | объекта `mlreportgen.dom.Image` | объекта `mlreportgen.dom.InternalLink` | объекта `mlreportgen.dom.LinkTarget` | объекта `mlreportgen.dom.Text` объект

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

ExternalLink
Image
InternalLink
LinkTarget
Text

Свойства

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

`BackgroundColor` - Цвет фона
`[]` (по умолчанию) | символьный вектор | строковый скаляр

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

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

Пример: 'blue'

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

`Bold` - Использовать ли полужирный цвет для текста
`[]` (по умолчанию) | `true` или `1` | `false` или `0`

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

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

`Children` - Дочерние элементы элемента документа
массив объектов DOM

Дочерние элементы этого элемента документа, заданные как массив объектов DOM. Это свойство доступно только для чтения.

`Color` - Цвет текста
`[]` (по умолчанию) | символьный вектор | строковый скаляр

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

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

Пример: 'blue'

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

`CustomAttributes` - Пользовательские атрибуты этого элемента
массив `mlreportgen.dom.CustomAttribute` объекты

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

`FirstLineIndent` - Сумма отступа для первой линии абзаца
`[]` | вектор символов | строковый скаляр

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

px - пиксели (по умолчанию)
cm - сантиметров
in - дюймы
mm - миллиметры
pc - picas
pt - точки

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

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

Пример: '0.5in'

`FontFamilyName` - Имя семейства шрифтов для текста
`[]` | вектор символов | строковый скаляр

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

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

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

Пример: 'Courier New'

`FontSize` - Размер шрифта для текста
`[]` (по умолчанию) | символьный вектор | строковый скаляр

Размер шрифта для текста, заданный как вектор символов или строковый скаляр, который состоит из числа, за которым следует сокращение для единицы измерения. Для примера, '12pt' задает двенадцать точек. Допустимые сокращения:

px - пиксели (по умолчанию)
cm - сантиметров
in - дюймы
mm - миллиметры
pc - picas
pt - точки

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

Пример: '12pt'

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

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

`Italic` - Использовать ли курсив для текста
`[]` (по умолчанию) | `true` или `1` | `false` или `0`

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

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

`OuterLeftMargin` - Левое углубление для абзаца
`[]` | вектор символов | строковый скаляр

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

px - пиксели (по умолчанию)
cm - сантиметров
in - дюймы
mm - миллиметры
pc - picas
pt - точки

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

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

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

`OutlineLevel` - Уровень контура абзаца
`[]` (по умолчанию) | целое число

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

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

`Parent` - Родительский элемент элемента документа
Объект DOM

Родительский элемент этого элемента документа, заданный как объект DOM. Это свойство доступно только для чтения.

`Strike` - Зачеркивание текста
[] (по умолчанию) | `'none'` | `'single'` | `'double'`

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

'none' - Без зачеркивания
'single' - Одна линия
'double' - Двойная линия (только для отчетов Word)

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

`Style` - Спецификация формата
массив объектов формата

Форматирование объектов, задающих формат элемента документа.

`StyleName` - Стиль для применения из таблицы стилей
вектор символов

Имя стиля для применения из таблицы стилей в виде вектора символов.

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

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

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

`Underline` - Тип подчеркивания
`[]` (по умолчанию) | `'single'` | `'none'` | ...

Тип подчеркивания, заданный как одно из значений в этой таблице.

Подчеркивание значения	Описание	Поддерживаемые выходные типы
`'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 формат объекта, который задает тип и цвет подчеркивания.

`WhiteSpace` - Как относиться к пустому пространству в тексте
`[]` (по умолчанию) | `'normal'` | `'nowrap'` | ...

Как обработать пустое пространство в тексте, заданное как одно из значений в этой таблице.

Значение	Описание	Поддерживаемые выходные типы
`'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` Использование `Heading1.append` подобно тому, как вы используете `Paragraph.append`.	Добавить содержимое в заголовок.
`clone` Использование `Heading1.clone` подобно тому, как вы используете `Paragraph.clone`.	Копировать заголовок.

Метод

Цель

append

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

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

clone

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

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

Примеры

свернуть все

Создание трех уровней заголовков

Открыть скрипт

В этом примере показано, как добавить три уровня заголовков, каждый из которых отформатирован в соответствии с его уровнем. Этот пример вставляет в документ три объекта заголовка: Heading1, а Heading2, и Heading3.

import mlreportgen.dom.*;
d = Document('mydoc','docx');
open(d);

title = append(d, Paragraph('Document Title'));
title.Bold = true;
title.FontSize = '28pt';

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
p2 = append(d,Paragraph('Text for this section.'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d,Paragraph('Text for this subsection'));

close(d);
rptview(d.OutputPath);

См. также

Документация

mlreportgen.dom.Heading1 class

Описание

Конструкция

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

`text` - Текст заголовка
вектор символов

`styleName` - Стиль для заголовка
вектор символов

`domObj` - Объект DOM для включения в заголовок
`mlreportgen.dom.ExternalLink` | объекта `mlreportgen.dom.Image` | объекта `mlreportgen.dom.InternalLink` | объекта `mlreportgen.dom.LinkTarget` | объекта `mlreportgen.dom.Text` объект

Свойства

`BackgroundColor` - Цвет фона
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`Bold` - Использовать ли полужирный цвет для текста
`[]` (по умолчанию) | `true` или `1` | `false` или `0`

`Children` - Дочерние элементы элемента документа
массив объектов DOM

`Color` - Цвет текста
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`CustomAttributes` - Пользовательские атрибуты этого элемента
массив `mlreportgen.dom.CustomAttribute` объекты

`FirstLineIndent` - Сумма отступа для первой линии абзаца
`[]` | вектор символов | строковый скаляр

`FontFamilyName` - Имя семейства шрифтов для текста
`[]` | вектор символов | строковый скаляр

`FontSize` - Размер шрифта для текста
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

`Italic` - Использовать ли курсив для текста
`[]` (по умолчанию) | `true` или `1` | `false` или `0`

`OuterLeftMargin` - Левое углубление для абзаца
`[]` | вектор символов | строковый скаляр

`OutlineLevel` - Уровень контура абзаца
`[]` (по умолчанию) | целое число

`Parent` - Родительский элемент элемента документа
Объект DOM

`Strike` - Зачеркивание текста
[] (по умолчанию) | `'none'` | `'single'` | `'double'`

`Style` - Спецификация формата
массив объектов формата

`StyleName` - Стиль для применения из таблицы стилей
вектор символов

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

`Underline` - Тип подчеркивания
`[]` (по умолчанию) | `'single'` | `'none'` | ...

`WhiteSpace` - Как относиться к пустому пространству в тексте
`[]` (по умолчанию) | `'normal'` | `'nowrap'` | ...

Методы

Примеры

Создание трех уровней заголовков

См. также

Темы

MATLAB Report Generator

Поддержка

Документация

mlreportgen.dom.Heading1 class

Описание

Конструкция

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

text - Текст заголовка вектор символов

styleName - Стиль для заголовка вектор символов

domObj - Объект DOM для включения в заголовок mlreportgen.dom.ExternalLink | объекта mlreportgen.dom.Image | объекта mlreportgen.dom.InternalLink | объекта mlreportgen.dom.LinkTarget | объекта mlreportgen.dom.Text объект

Свойства

BackgroundColor - Цвет фона [] (по умолчанию) | символьный вектор | строковый скаляр

Bold - Использовать ли полужирный цвет для текста [] (по умолчанию) | true или 1 | false или 0

Children - Дочерние элементы элемента документа массив объектов DOM

Color - Цвет текста [] (по умолчанию) | символьный вектор | строковый скаляр

CustomAttributes - Пользовательские атрибуты этого элемента массив mlreportgen.dom.CustomAttribute объекты

FirstLineIndent - Сумма отступа для первой линии абзаца [] | вектор символов | строковый скаляр

FontFamilyName - Имя семейства шрифтов для текста [] | вектор символов | строковый скаляр

FontSize - Размер шрифта для текста [] (по умолчанию) | символьный вектор | строковый скаляр

Id - идентификатор для этого элемента документа вектор символов | строковый скаляр

Italic - Использовать ли курсив для текста [] (по умолчанию) | true или 1 | false или 0

OuterLeftMargin - Левое углубление для абзаца [] | вектор символов | строковый скаляр

OutlineLevel - Уровень контура абзаца [] (по умолчанию) | целое число

Parent - Родительский элемент элемента документа Объект DOM

Strike - Зачеркивание текста [] (по умолчанию) | 'none' | 'single' | 'double'

Style - Спецификация формата массив объектов формата

StyleName - Стиль для применения из таблицы стилей вектор символов

Tag - тег для этого элемента документа вектор символов | строковый скаляр

Underline - Тип подчеркивания [] (по умолчанию) | 'single' | 'none' | ...

WhiteSpace - Как относиться к пустому пространству в тексте [] (по умолчанию) | 'normal' | 'nowrap' | ...

Методы

Примеры

Создание трех уровней заголовков

См. также

Темы

MATLAB Report Generator

Поддержка

`text` - Текст заголовка
вектор символов

`styleName` - Стиль для заголовка
вектор символов

`domObj` - Объект DOM для включения в заголовок
`mlreportgen.dom.ExternalLink` | объекта `mlreportgen.dom.Image` | объекта `mlreportgen.dom.InternalLink` | объекта `mlreportgen.dom.LinkTarget` | объекта `mlreportgen.dom.Text` объект

`BackgroundColor` - Цвет фона
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`Bold` - Использовать ли полужирный цвет для текста
`[]` (по умолчанию) | `true` или `1` | `false` или `0`

`Children` - Дочерние элементы элемента документа
массив объектов DOM

`Color` - Цвет текста
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`CustomAttributes` - Пользовательские атрибуты этого элемента
массив `mlreportgen.dom.CustomAttribute` объекты

`FirstLineIndent` - Сумма отступа для первой линии абзаца
`[]` | вектор символов | строковый скаляр

`FontFamilyName` - Имя семейства шрифтов для текста
`[]` | вектор символов | строковый скаляр

`FontSize` - Размер шрифта для текста
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

`Italic` - Использовать ли курсив для текста
`[]` (по умолчанию) | `true` или `1` | `false` или `0`

`OuterLeftMargin` - Левое углубление для абзаца
`[]` | вектор символов | строковый скаляр

`OutlineLevel` - Уровень контура абзаца
`[]` (по умолчанию) | целое число

`Parent` - Родительский элемент элемента документа
Объект DOM

`Strike` - Зачеркивание текста
[] (по умолчанию) | `'none'` | `'single'` | `'double'`

`Style` - Спецификация формата
массив объектов формата

`StyleName` - Стиль для применения из таблицы стилей
вектор символов

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

`Underline` - Тип подчеркивания
`[]` (по умолчанию) | `'single'` | `'none'` | ...

`WhiteSpace` - Как относиться к пустому пространству в тексте
`[]` (по умолчанию) | `'normal'` | `'nowrap'` | ...