class Types/collection:RecordSet

Рекордсет - список записей, имеющих общий формат полей.

Примечание

Основные аспекты рекордсета (дополнительно к аспектам Types/collection:ObservableList):

манипуляции с форматом полей. За реализацию аспекта отвечает примесь Types/entity:FormattableMixin;
манипуляции с сырыми данными посредством адаптера. За реализацию аспекта отвечает примесь Types/entity:FormattableMixin.

Элементами рекордсета могут быть только записи, причем формат полей всех записей должен совпадать.

Пример 1. Создадим рекордсет, в котором в качестве сырых данных используется JSON (адаптер для данных в таком формате используется по умолчанию):

import {RecordSet} from 'Types/collection';
const characters = new RecordSet({
    rawData: [{
        id: 1,
        firstName: 'Tom',
        lastName: 'Sawyer'
    }, {
        id: 2,
        firstName: 'Huckleberry',
        lastName: 'Finn'
    }]
});
characters.at(0).get('firstName'); // 'Tom'
characters.at(1).get('firstName'); // 'Huckleberry'

Пример 2. Создадим рекордсет, в котором в качестве сырых данных используется объект в формате СБИС (адаптер для данных в таком формате нужно указывать явно):

import {RecordSet} from 'Types/collection';
const characters = new RecordSet({
    rawData: {
        d: [
          [1, 'Иванов'],
          [2, 'Петров'],
          [3, 'Сидоров'],
          [4, 'Молодцов']
       ],
       s: [{
           n: 'id',
           t: 'Число целое'
       }, {
           n: 'name',
           t: 'Строка'
       }]
    },
    adapter: 'adapter.sbis'
});
characters.at(0).get('name'); // 'Иванов'
characters.at(1).get('name'); // 'Петров'

Соответствие названий полей в формате сырых данных БЛ СБИС и в формате Types смотрите здесь.

Пример 3. Создадим рекордсет, в котором в качестве сырых данных используется ответ БЛ СБИС (адаптер для данных в таком формате укажем явно):

import {RecordSet} from 'Types/collection';
import {SbisService} from 'Types/source';
const ds = new SbisService({endpoint: 'Employee'});
ds.call('list', {department: 'designers'}).then((response) => {
    const designers = new RecordSet({
        rawData: response.getRawData(),
        adapter: response.getAdapter()
    });
    console.log(designers.getCount());
});

Опции

adapter protected: Адаптер, обеспечивающий доступ к необработанным данным определенного формата. По умолчанию поддерживаются необработанные данные в формате Types/entity:adapter.Json.; FormattableMixin
format protected: Формат полей. Это может быть либо полный формат (в этом случае он должен быть определен как массив или экземпляр класса Types/_collection/format/Format), либо как частичный формат (в этом случае он должен быть определен как простой объект).; FormattableMixin
keyProperty protected: Название свойства записи, содержащего первичный ключ.
metaData protected: Метаданные
metaFormat protected: Формат всех полей метаданных.
model protected: Конструктор записей, порождаемых рекордсетом. По умолчанию Types/entity:Model.
rawData protected: Данные в необработанном формате, которые могут быть распознаны через определенный адаптер.; FormattableMixin
versionCallback protected: Обработчик изменения версии; VersionableMixin

Поля

defaultModel protected: Модель по умолчанию
metaData protected: Метаданные - локальная обработанная копия _$metaData
beforeRaiseOff protected: Состояние коллекции до выключения генерации событий; EventRaisingMixin
blockChangesMessage protected: Сообщение для режима блокировки изменений; EventRaisingMixin
sessionItemContentsGetter protected: Метод получения содержимого элемента коллекции (если такое поведение поддерживается); EventRaisingMixin
ACTION_ADD: Изменение коллекции: добавлены элементы; IObservable
ACTION_CHANGE: Изменение коллекции: изменены элементы; IObservable
ACTION_MOVE: Изменение коллекции: перемещены элементы; IObservable
ACTION_REMOVE: Изменение коллекции: удалены элементы; IObservable
ACTION_REPLACE: Изменение коллекции: заменены элементы; IObservable
ACTION_RESET: Изменение коллекции: значительное изменение; IObservable
indexer protected: Индексатор элементов.; List
resetChangesCount protected: Количество измененных элементов, что важно для генерации одного события с действием ACTION_RESET вместо нескольких.; ObservableList
silentChangedItems protected: Элементы, измененные во время работы события, были выключены.; ObservableList
silentChangedPropertyItems protected: Поля элементов коллекции, измененные во время работы события, которые были выключены.; ObservableList
destroyed: Экземпляр был разрушен; DestroyableMixin
cow protected: Работа с необработанными данными в режиме Copy-On-Write.; FormattableMixin
format protected: Окончательно построенный формат.; FormattableMixin
formatClone protected: Копия _format, которая используется для кэширования в getFormat(); FormattableMixin
formatUnlinked protected: Значение _$format не связано с исходным значением.; FormattableMixin
rawDataAdapter protected: Экземпляр адаптера для работы с необработанными данными.; FormattableMixin
rawDataFields protected: Список имен полей, взятых из адаптера необработанных данных.; FormattableMixin
instanceId protected: Уникальный идентификатор; InstantiableMixin
instancePrefix protected: Префикс значений идентификатора; InstantiableMixin
_mediator: Медиатор, отвечающий за связи между сущностями; ManyToManyMixin
eventBusChannel protected: Канал событий; ObservableMixin
eventsQueue protected: Очередь событий; ObservableMixin
publishedEvents protected: Декларированные события; ObservableMixin
options deprecated protected: ReadWriteMixin
getOptions protected: Метод реализован в OptionsToPropertyMixin.; SerializableMixin
instanceNumber protected: Уникальный номер инстанса; SerializableMixin
moduleName protected: Название класса-конструктора.; SerializableMixin

Методы

_addChild protected

Добавляет отношение с другой сущностью

ManyToManyMixin

_addItemsToRawData protected

Вставляет сырые данные записей в сырые данные рекордсета

_addRawDataField protected

Добавляет поле в _rawDataFields.

class Types/collection:RecordSet

Примечание

Опции

Поля

Методы

События

Тайпдефы