Exponenta Banner
exponenta event banner

mlreportgen.dom.Heading1 класс

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

Создать Heading1 абзац

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

Описание

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

Строительство

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

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

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

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

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

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

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

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

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

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • Text

Свойства

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

Цвет фона, заданный как вектор символов или скаляр строки, состоящий из имени цвета 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 свойство в пустое значение удаляет объект.

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

Цвет текста, заданный как вектор символов или скаляр строки, состоящий из имени цвета 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 - пикас

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

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

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

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

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

Пример: '12pt'

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

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

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

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

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

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

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

clone

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

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

Примеры

свернуть все

Открыть сценарий

В этом примере показано, как добавить три уровня заголовков, каждый из которых отформатирован в соответствии с уровнем. В этом примере в документ вставляются три объекта заголовка: Heading1, a 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);

См. также

| | | | | |

Темы

Представлен в R2016a

Документация по генератору отчетов MATLAB

Поддержка