api.headers

Применяемые для расчета хэдеров типы, переменные и методы

Пакеты

api.defaultHeaders - Стандартные встроенные хэдеры

Members

customHeaders :Object

Объект с кастомными хэдэрами (подключаемый (require) файл, поле "customHeadersFile" метафайла). Ключи - имена хэдеров, значения - объекты типа Header

documentAttributes :Array.<HeaderNameAndValue>

Список атрибутов (дополнительные атрибуты и хэдеры с типом "attribute")

documentHeaders :Array.<HeaderNameAndValue>

Список реквизитов (Информация по документу и хэдеры с типом "header")

Type Definitions

Header

Хэдер
Properties:
Name Type Argument Default Description
name String | Number Имя хэдера
value HeaderValue Функция получения значения
check HeaderCheck optional  Функция проверки отображения хэдера
type "header" | "attribute" optional  "header" Тип хэдера: реквизит или атрибут

HeaderCheck() → Boolean

Функция проверки отображения хэдера

Parameters:
Type Description
headerIndex Индекс текущего хэдера
data Данные документа
Return:
Boolean - Признак необходимости отображения хэдера

HeaderName() → String

Функция получения наименования хэдера

Parameters:
Type Description
headerIndex Индекс текущего хэдера
data Данные документа
Return:
String - Имя хэдера

HeaderNameAndValue

Вычисленный хэдер
Properties:
Name Type Description
name String Имя хэдера
value String Значение хэдера

HeaderValue() → *

Функция получения значения хэдера

Parameters:
Type Description
headerIndex Индекс текущего хэдера
data Данные документа
Return:
* - Значение хэдера