класс mlreportgen.dom.CharEntity

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

Создать ссылку на сущность символа

Описание

Создание ссылки на символьный объект.

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

charEntityObj = CharEntity() создает ссылку на объект nonbreaking space (). При добавлении этой ссылки к документу вставляется незакрытое пространство.

charEntityObj = CharEntity(name) создает ссылку на объект символа, указанный name.

charEntityObj = CharEntity(name,n) создает n ссылки на символьный объект, указанный name, то есть символьный вектор n специальные символы.

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

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

`name` - Имя объекта символа
символьный вектор

Имя сущности должно быть указано в https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references.

`n` - Количество используемых символьных сущностей
целое число

Число используемых символьных сущностей, указанное как целое число.

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

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

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

`charEntityObj` - Ссылка на сущность символа
`mlreportgen.dom.CharEntity` объект

Ссылка на объект символа, представленный символом mlreportgen.dom.CharEntity объект.

Свойства

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

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

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

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

Пример: 'blue'

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

`Bold` - Вариант использования полужирного шрифта для номера
логическое значение

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

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

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

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

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

Пример: 'blue'

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

`Content` - Текст, содержащийся в этом элементе документа
символьный вектор

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

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

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

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

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

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

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

Пример: 'Courier New'

`FontSize` - Размер шрифта
символьный вектор

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

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

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

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

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

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

`Italic` - Вариант использования курсива для номера
логическое значение

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

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

`Name` - Имя объекта символа
символьный вектор

Имя является символьной сущностью, указанной в https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references.

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

`Repeat` - Количество повторений символьной сущности
числовое значение

Число повторений символьного объекта, указанного как числовое значение.

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

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

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

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

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

`Style` - Форматирование номера
массив объектов формата

Массив объектов форматирования, указывающий формат номера.

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

Стиль, заданный 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` Использовать `CharEntity.append` аналогично тому, как вы используете `ExternalLink.append`.	Добавление пользовательского элемента к этой символьной сущности.
`clone` Использовать `CharEntity.clone` аналогично тому, как вы используете `Paragraph.clone`.	Клонировать эту сущность символа.

Метод

Цель

append

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

Добавление пользовательского элемента к этой символьной сущности.

clone

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

Клонировать эту сущность символа.

Примеры

свернуть все

Добавить знак британского фунта

Открыть сценарий в реальном времени

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

p = Paragraph(CharEntity('pound'));
append(d,p);
append(p,'3');

close(d);
rptview('test',doctype);

Добавить два неразрывных пространства

Открыть сценарий в реальном времени

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

p = Paragraph('Some text');
append(d,p);
ce = CharEntity('nbsp',5);
append(p,ce);
append(p,'more text after five blank spaces');

close(d);
rptview('test',doctype);

См. также

mlreportgen.dom.Paragraph | mlreportgen.dom.Text

Темы

Подходы к форматированию отчетов

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

класс mlreportgen.dom.CharEntity

Описание

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

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

`name` - Имя объекта символа
символьный вектор

`n` - Количество используемых символьных сущностей
целое число

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

`charEntityObj` - Ссылка на сущность символа
`mlreportgen.dom.CharEntity` объект

Свойства

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

`Bold` - Вариант использования полужирного шрифта для номера
логическое значение

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

`Content` - Текст, содержащийся в этом элементе документа
символьный вектор

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

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

`FontSize` - Размер шрифта
символьный вектор

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

`Italic` - Вариант использования курсива для номера
логическое значение

`Name` - Имя объекта символа
символьный вектор

`Repeat` - Количество повторений символьной сущности
числовое значение

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

`Style` - Форматирование номера
массив объектов формата

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

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

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

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

Методы

Примеры

Добавить знак британского фунта

Добавить два неразрывных пространства

См. также

Темы

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

Поддержка

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

класс mlreportgen.dom.CharEntity

Описание

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

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

name - Имя объекта символа символьный вектор

n - Количество используемых символьных сущностей целое число

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

charEntityObj - Ссылка на сущность символа mlreportgen.dom.CharEntity объект

Свойства

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

Bold - Вариант использования полужирного шрифта для номера логическое значение

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

Content - Текст, содержащийся в этом элементе документа символьный вектор

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

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

FontSize - Размер шрифта символьный вектор

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

Italic - Вариант использования курсива для номера логическое значение

Name - Имя объекта символа символьный вектор

Repeat - Количество повторений символьной сущности числовое значение

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

Style - Форматирование номера массив объектов формата

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

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

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

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

Методы

Примеры

Добавить знак британского фунта

Добавить два неразрывных пространства

См. также

Темы

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

Поддержка

`name` - Имя объекта символа
символьный вектор

`n` - Количество используемых символьных сущностей
целое число

`charEntityObj` - Ссылка на сущность символа
`mlreportgen.dom.CharEntity` объект

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

`Bold` - Вариант использования полужирного шрифта для номера
логическое значение

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

`Content` - Текст, содержащийся в этом элементе документа
символьный вектор

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

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

`FontSize` - Размер шрифта
символьный вектор

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

`Italic` - Вариант использования курсива для номера
логическое значение

`Name` - Имя объекта символа
символьный вектор

`Repeat` - Количество повторений символьной сущности
числовое значение

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

`Style` - Форматирование номера
массив объектов формата

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

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

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

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