api.rows

Пакеты

api.defaultColumns - Стандартные встроенные колонки.

Members

customHeaders :Object

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

documentColumnHeaders :Array.<String>

Список заголовков колонок

documentRows :Array.<DocumentRowsGroup>

Строки документа по группам с итогами

documentTotals :Array.<Total>

Список итогов документа

documentTotals :Array.<OrderTotal>

Дополнительные итоги со скидками

Type Definitions

Column

Колонка.

Properties:

Name	Type	Argument	Description
name	ColumnName		Заголовок колонки
rawValue	ColumnValue		Функция получения сырого, не форматированного значения
value	ColumnValue		Функция получения форматированного значения
check	ColumnCheck	optional	Функция проверки отображения колонки
total	Object	optional	Методы для подсчета и форматирования итогов Properties Name Type Description count ColumnTotalCount Функция подсчета итогов для колонки format ColumnTotalFormat Функция форматирования итогов

ColumnCheck(currentRow, rowIndex, rows) → Boolean

Функция проверки отображения колонки.

Parameters:

Name	Type	Description
currentRow	Row	Текущая строка документа
rowIndex	Number	Индекс номер строки
rows	Array.<Row>	Все строки документа

Return:

Boolean - Признак необходимости отображения хэдера

ColumnName(currentRow, rowIndex, rows) → *

Функция получения имени колонки.

Parameters:

Name	Type	Description
currentRow	Row	Текущая строка документа
rowIndex	Number	Индекс номер строки
rows	Array.<Row>	Все строки документа

Return:

* - Заголовок колонки

ColumnTotalCount(columnTotals, rawValue, type) → *

Функция подсчета итогов для колонки.

Parameters:

Name	Type	Description
columnTotals	*	Сумма предыдущих посчитанных итогов для данной группы товаров
rawValue	*	Очередное значение
type	"group" | "doc"	Тип считаемого итога, для групп или для всего документа

Return:

* - Итоговая сумма (не форматированная)

ColumnTotalFormat(columnTotals, type) → String|Number

Функция форматирования итогов.

Parameters:

Name	Type	Description
columnTotals	*	Сумма итогов для данной группы товаров
type	"group" | "doc"	Тип считаемого итога, для групп или для всего документа

Return:

String | Number - Форматированные итоги

ColumnValue(currentRow, rowIndex, rows) → *

Функция получения значения колонки.

Parameters:

Name	Type	Description
currentRow	Row	Текущая строка документа
rowIndex	Number	Индекс номер строки
rows	Array.<Row>	Все строки документа

Return:

* - Значение хэдера

DocumentRow

Готовая строка документа

Properties:

Name	Type	Description
main	Array.<String>	Массив с форматированными значениями колонок
additional	Array.<Array>	Массив сопоставленных строк с форматированными значениями колонок

DocumentRowsGroup

Группа строк для группы товаров

Properties:

Name	Type	Description
groupName	String	Наименование группы товаров
appendix	String	Добавляемая к имени группы строка с числом позиций
rows	Array.<DocumentRow>	Массив объектов с форматированными значениями колонок
totals	Total	Подытоги для группы товаров

OrderTotal

Дополнительные итоги со скидками для документа

Properties:

Name	Type	Description
name	String	Имя итоговой строки
type	"blue" | "bold" | "normal"	Тип строки (влияет на форматирование)
visible	Boolean	Проверка на необходимость отображения итоговой строки
value	String	Значение итога

Total

Итоги

Properties:

Name	Type	Description
raw	Array.<(String|Null)>	Список с неформатированными значениями итогов
formatted	Array.<String>	Список с форматированными значениями итогов