mlreportgen.dom.Number class

Пакет: mlreportgen.dom

Номер для включения в документ в качестве форматированного текста

Описание

Используйте объект mlreportgen.dom.Number класс для преобразования числа в форматированный текст, который можно включить в документ.

Преобразование использует первую из следующих спецификаций формата, которые оно находит:

Спецификация в mlreportgen.dom.NumberFormat объект в Style свойство Number объект
Спецификация в NumberFormat объект в Style свойство элемента, такого как абзац, список или таблица, который содержит Number объект
Спецификация по умолчанию, заданная как mlreportgen.dom.setDefaultNumberFormat

Если преобразование не находит спецификацию формата, в преобразовании используется максимальное количество цифр, необходимое для точного представления числа.

The mlreportgen.dom.Number класс является handle класс.

Атрибуты класса

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

numberObj = mlreportgen.dom.Number() создает пустой Number объект. Используйте Value свойство для задания числа для преобразования в форматированный текст.

пример

numberObj = mlreportgen.dom.Number(value) создает Number объект со Value значение свойства установлено в value.

numberObj = mlreportgen.dom.Number(value,stylename) создает Number объект со Value значение свойства установлено в value и StyleName значение свойства установлено в stylename.

Свойства

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

`Value` - Число для преобразования в форматированный текст
0 (по умолчанию) | скаляром

Число для преобразования в форматированный текст, заданное как скаляр. Комплексные номера не поддерживаются.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`StyleName` - Имя определяемого стилем таблицы стилей для преобразуемого числа
`[]` (по умолчанию) | символьный вектор | строковый скаляр

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

Стиль, заданный как StyleName свойство должно быть определено в таблице стилей документа или части документа, к которой Number объект добавлен. Заданный стиль определяет внешний вид текстового представления номера в выход документе. Форматы, заданные Style форматы переопределения свойств, заданные таблицей стилей.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Style` - Форматы, определяющие стиль преобразованного числа
массив ячеек объектов формата DOM

Форматы, определяющие стиль этого числа при преобразовании в текст, заданные как массив ячеек объектов формата DOM. Использование mlreportgen.dom.NumberFormat объект для задания точности преобразуемого числа. Форматы переопределяют соответствующие форматы, заданные стилем таблицы стилей, заданным в StyleName свойство.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`CustomAttributes` - Пользовательские атрибуты
`[]` | массивов ячеек `mlreportgen.dom.CustomAttibute` объекты

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

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

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` - Проигнорировано
объект элемента документа

Это свойство игнорируется.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

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

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

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

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

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Методы

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

Общедоступные методы

`clone`	`numObjCopy = clone(numObj)` копирует указанные `Number` объект. Используйте `clone` метод `Number` объект так же, как вы используете `clone` метод `mlreportgen.dom.Paragraph` объект.
`toString`	Преобразуйте число в форматированный текст

Примеры

свернуть все

Форматирование числа в отчете

Открыть Live Script

Представьте число как Number объект. Использование NumberFormat объект для задания четырех цифр точности после десятичной точки.

import mlreportgen.dom.*
  
rpt = Document("Report with NumberFormat","pdf");

n = Number(pi);
n.Style = [n.Style {NumberFormat("%0.4f")}];
append(rpt,n);
  
close(rpt);
rptview(rpt);

См. также

mlreportgen.dom.getDefaultNumberFormat | mlreportgen.dom.NumberFormat | mlreportgen.dom.setDefaultNumberFormat

Темы

Введенный в R2021a

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

mlreportgen.dom.Number class

Описание

Атрибуты класса

Создание

Описание

Свойства

`Value` - Число для преобразования в форматированный текст
0 (по умолчанию) | скаляром

Атрибуты:

`StyleName` - Имя определяемого стилем таблицы стилей для преобразуемого числа
`[]` (по умолчанию) | символьный вектор | строковый скаляр

Атрибуты:

`Style` - Форматы, определяющие стиль преобразованного числа
массив ячеек объектов формата DOM

Атрибуты:

`CustomAttributes` - Пользовательские атрибуты
`[]` | массивов ячеек `mlreportgen.dom.CustomAttibute` объекты

Атрибуты:

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

Атрибуты:

`Children` - Проигнорировано
объект элемента документа

Атрибуты:

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

Атрибуты:

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

Атрибуты:

Методы

Общедоступные методы

Примеры

Форматирование числа в отчете

См. также

Темы

MATLAB Report Generator

Поддержка

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

mlreportgen.dom.Number class

Описание

Атрибуты класса

Создание

Описание

Свойства

Value - Число для преобразования в форматированный текст 0 (по умолчанию) | скаляром

Атрибуты:

StyleName - Имя определяемого стилем таблицы стилей для преобразуемого числа [] (по умолчанию) | символьный вектор | строковый скаляр

Атрибуты:

Style - Форматы, определяющие стиль преобразованного числа массив ячеек объектов формата DOM

Атрибуты:

CustomAttributes - Пользовательские атрибуты [] | массивов ячеек mlreportgen.dom.CustomAttibute объекты

Атрибуты:

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

Атрибуты:

Children - Проигнорировано объект элемента документа

Атрибуты:

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

Атрибуты:

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

Атрибуты:

Методы

Общедоступные методы

Примеры

Форматирование числа в отчете

См. также

Темы

MATLAB Report Generator

Поддержка

`Value` - Число для преобразования в форматированный текст
0 (по умолчанию) | скаляром

`StyleName` - Имя определяемого стилем таблицы стилей для преобразуемого числа
`[]` (по умолчанию) | символьный вектор | строковый скаляр

`Style` - Форматы, определяющие стиль преобразованного числа
массив ячеек объектов формата DOM

`CustomAttributes` - Пользовательские атрибуты
`[]` | массивов ячеек `mlreportgen.dom.CustomAttibute` объекты

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

`Children` - Проигнорировано
объект элемента документа

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

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