DocumentDataSource¶

Источник данных представления для документов InfinniPlatform.

Description¶

Для работы с документами, хранящимися в InfinniPlatform, следует использовать источник данных DocumentDataSource. Для определения источника данных достаточно указать идентификатор документа, с которым будет осуществляться работа.

Extends¶

RestDataSource

Syntax¶

new DocumentDataSource(parameters)

Parameters¶

Name	Type	Description
parameters	`Object`	Объект с параметрами представления. Один из параметров обязательный: parameters.view - родительское представление источника данных

Properties¶

Нет

Specific Properties¶

Для работы с данными свойствами используйте методы getProperty и setProperty. Обратите внимание, что для работы с данными свойствами необходимо указывать точку в названии.

Name	Default	Description
documentId	–	Идентификатор документа
pageNumber	0	Номер страницы
pageSize	15	Размер страницы
select	–	Правило отображения документов
order	–	Правило сортировки документов
needTotalCount	false	Необходимость подсчета общего количества документов
totalCount ¹	–	Общее число документов ( заполняется, когда needTotalCount == true )
additionalResult ¹	–	Дополнительные результаты запроса на получение данных

¹ поле только для чтения

Изменение параметров filter, filterParams, pageSize, search, order приводит к обнулению pageNumber.

Methods¶

Name	Description
getDocumentId	Возвращает идентификатор документа
setDocumentId	Устанавливает идентификатор документа
setIdFilter	Устанавливает фильтр элементов по идентификатору
getPageNumber	Возвращает номер страницы
setPageNumber	Устанавливает номер страницы
getPageSize	Возвращает размер страницы
setPageSize	Устанавливает размер страницы
getSelect	Возвращает правило отображения документов
setSelect	Устанавливает правило отображения документов
getOrder	Возвращает правило сортировки документов
setOrder	Устанавливает правило сортировки документов
getNeedTotalCount	Возвращает значение, определяющее необходимость подсчета общего количества документов
setNeedTotalCount	Устанавливает значение, определяющее необходимость подсчета общего количества документов
getTotalCount	Возвращает общее количество документов, хранящихся в InfinniPlatform и соответсвующих запросу

Events¶

Нет

DocumentDataSource.metadata¶

Метаданные источника данных представления для документов InfinniPlatform.

Properties¶

Name	Type	Default	Description
DocumentId	`String`	–	Идентификатор документа
PageNumber	`Integer`	0	Номер страницы
PageSize	`Integer`	15	Размер страницы
Select	`String`	–	Правило отображения документов
Order	`String`	–	Правило сортировки документов
NeedTotalCount	`Boolean`	–	Необходимость подсчета количества

Examples¶

{
    "DocumentDataSource": {
        "Name": "documentDataSource1",
        "DocumentId": "MyDocument",
        "PageNumber": 3,
        "PageSize": 50,
        "Select": "include(LastName, FirstName, Address, Birthday)",
        "Order": "asc(LastName, FirstName)"
    }
}

{
    "DocumentDataSource": {
        "Name": "documentDataSource2",
        "DocumentId": "MyDocument",
        "NeedTotalCount": true
    }
}