BaseDataSource.metadata

Метаданные базового типа источников данных представления.

Properties

Name	Type	Default	Description
Name	String	–	Наименование источника данных
SuspendUpdate	String	–	Причина запрета на обновление списка элементов. Для снятия запрета необходимо воспользоваться методом resumeUpdate().
Filter	String1	–	Правило фильтрации документов
FilterParams	Object	–	Объект со значениями параметров. Параметр может быть задан как DataBinding.
Search	String	–	Строка полнотекстового поиска
IdProperty	String	‘_id’	Свойство с идентификатором элемента
FillCreatedItem	Boolean	true	Логическое значение, указывающее, нужно ли предзаполнение новых элементов на сервере
IsLazy	Boolean	true	Логическое значение, определяющее, будет ли прогрузка данных в источнике “ленивой” или нет
ResolvePriority	Integer	0	Приоритет прогрузки источника данных. Чем выше приоритет, тем раньше источник будет прогружен
ValidationErrors	Script	–	Функция проверки элемента на ошибки
CustomProperties	Object	–	Вспомогательные параметры. Могут пригодиться, например, для настройки взаимодействия DataNavigation и RestDataSource. Объект является ассоциативным массивом, в котором key - это название свойства, а value - значение.
OnErrorValidator	Script	–	Обработчик события о том, что проверка на ошибки завершена
OnSelectedItemChanged	Script	–	Обработчик события о том, что выделенный элемент изменился
OnPropertyChanged	Script	–	Обработчик события о том, что одно из свойств источника изменилось
OnItemDeleted	Script	–	Обработчик события о том, что элемент удален
OnItemsUpdated	Script	–	Обработчик события о том, что список элементов обновлен
OnProviderError	Script	–	Обработчик события о том, что поставщик данных вернул ошибку

¹ Шаблонизируемая величина. Заполняется значениями из FilterParams.

Exampes

Создать экземпляр BaseDataSource нельзя (это абстрактный класс), однако можно создать ObjectDataSource, который наследуется от BaseDataSource.

{
    "ObjectDataSource": {
        "Name": "DocumentTypes",
        "IdProperty": "guid",
        "IsLazy": false,
        "ValidationErrors": "{ return { IsValid: (args.Name != null), Items: [{Message: 'Name is required'}] }; }",
        "OnPropertyChanged": "{ alert('Property ' + args.property + ' is changed!'); }"
    }
}

Допустим возникла зависимость между источниками данных, и для корректной работы MainDataSource необходим загруженный TerminologyDataSource. Для решения этой проблемы достаточно указать ResolvePriority для TerminologyDataSource выше, чем для MainDataSource.

{
    "DataSources": [
        {
            "DocumentDataSource": {
                "Name": "MainDataSource",
                "ConfigId": "configuration",
                "DocumentId": "patients",
                "SuspendUpdate": "SomeReason",
                "Filter": "gt(Birthday,<%startDate%>)",
                "FilterParams": {
                    "startDate": "date('1985-01-01')"
                }
            }
        },
        {
            "DocumentDataSource": {
                "Name": "TerminologyDataSource",
                "ConfigId": "configuration",
                "DocumentId": "diseases",
                "Search": "Иванов Иван Иванович",
                "ResolvePriority": 1
            }
        }
    ]
}

Реализация фильтра.

{
  "DataSources": [
    {
      "ObjectDataSource": {
        "Name": "ObjectDataSource",
        "Items": [
          {"_id": 1, "Name": "Mobile small", "currency": 1100, "Display": "480x320"},
          {"_id": 2, "Name": "Mobile middle", "currency": 1200, "Display": "640x320"},
          {"_id": 3, "Name": "Mobile large", "currency": 1300, "Display": "771x375"},
          {"_id": 4, "Name": "Tablet", "currency": 1400, "Display": "960x480"},
          {"_id": 5, "Name": "Desktop small", "currency": 1500, "Display": "1024x768"},
          {"_id": 6, "Name": "Desktop middle", "currency": 1600, "Display": "1600x900"},
          {"_id": 7, "Name": "Desktop", "currency": 2000, "Display": "1920x1080"}
        ],
        "Filter": "and(contains(Name, <%filterName%>),contains(currency, <%filterPrice%>),contains(Display, <%filterDisplay%>))",
        "FilterParams": {
          "filterName": {
            "Source": "ObjectDataSource2",
            "Property": "$.FilterName"
          },
          "filterPrice": {
            "Source": "ObjectDataSource2",
            "Property": "$.FilterPrice"
          },
          "filterDisplay": {
            "Source": "ObjectDataSource2",
            "Property": "$.FilterDisplay"
          }
        }
      }
    },
    {
      "ObjectDataSource": {
        "Name": "ObjectDataSource2",
        "Items": [
          {"_id": 1, "FilterName": "", "FilterPrice": "", "FilterDisplay": ""}
        ]
      }
    }
  ]
}

Пример заморозки DataSource из метаданных

{
  "DataSources": [
    {
      "ObjectDataSource": {
        "Name": "ObjectDataSource",
        "SuspendUpdate": "SomeReason",
        "Items": []
      }
    }
  ]
}

Пример настройки RestDataSource для работы с DataNavigation

{
  "RestDataSource": {
    "Name": "MainDataSource",
    "CustomProperties": {
      "pageNumber": 0,
      "pageSize": 20
    },
    "GettingParams": {
      "Origin": "http://localhost:9900",
      "Method": "post",
      "Params": {
        "skip": {
          "Source": "MainDataSource",
          "Property": ".pageNumber",
          "Converter": {
            "ToElement": "{return args.source.getProperty('.pageSize') * args.value;}"
          },
          "DefaultValue": 0
        },
        "take": {
          "Source": "MainDataSource",
          "Property": ".pageSize",
          "DefaultValue": 20
        }
      },
      "Path": "/documents/PublicationInfo?skip=<%skip%>&take=<%take%>&count=true",
      "Data": {}
    },
    "UpdatingItemsConverter": "{args.source.setProperty('.totalCount', args.value.Result.Count); return args.value.Result.Items;}"
  }
}