Список элементов
Определение и использование
Повторно используемый компонент "Список элементов" представляет собой вложенный мэшап, позволяющий отображать список элементов из набора данных в представлении сетки. Кроме того, пользователю доступны поиск, сортировка и фильтрация списка, а также выполнение действий со всем списком или с конкретными элементами списка.
Можно сконфигурировать повторно используемый компонент "Список элементов" следующими способами.
• Определить вещь модели, обеспечивающую входные данные для списка
• Включить или выключить поиск и фильтрацию
• Задать опции начальной фильтрации и сортировки
• Задать максимальное число строк в сетке
• Задать тип выбора для списка
• Сконфигурировать действия, доступные на встроенной панели действий; дополнительные сведения см. на панели действий
Можно выполнять фильтрацию или поиск в списке элементов, используя выпадающее меню "Фильтр" или поле поиска. Однако если выпадающее меню "Фильтр" и поле поиска не включены в файле конфигурации JSON, фильтрация и поиск будут недоступны. Можно щелкнуть наименование атрибута, чтобы отсортировать список по атрибуту. Чтобы изменить порядок сортировки на обратный, щелкните наименование атрибута еще раз.
Повторно используемый компонент "Список элементов" содержит также встроенный повторно используемый компонент "Панель действий". При конфигурировании панели действий можно включить дополнительные возможности, такие как выполнение действия с одним или несколькими элементами списка. Дополнительные сведения см. в разделе
Панель действий. По умолчанию панель действий в списке элементов содержит действие
Экспорт, предназначенное для экспорта всех значений атрибутов, соответствующих критериям фильтра, в файл CSV.
Список элементов также включает в себя кнопку Восстановить значения по умолчанию. С помощью кнопки Восстановить значения по умолчанию можно восстановить настройки по умолчанию для фильтрации, поиска и операций на уровне сетки, включая сортировку, перестановку, а также отображение и скрытие столбцов.
На приведенном ниже изображении показан формат повторно используемого компонента "Список элементов".
Существует четыре предопределенных конфигурации, доступные для повторно используемого компонента "Список элементов": "Список задач", "Список изменяемых элементов", "Список вложений" и "Список задач". Дополнительные сведения о конкретной предопределенной конфигурации см. на ее странице разделов.
Свойства привязки
Для компонента "Список элементов" существует четыре свойства, доступные для привязки:
• input - объект JSON, представляющий собой идентификатор входного параметра, для которого необходимо получить данные из серверной системы. Эта информация должна быть указана в формате CCO (Common Communication Object). Ключи, включенные в этот объект JSON, зависят данных, которые список элементов должен получить в качестве входных данных. Например, для списка вложений требуются входные данные, отличные от входных данных для списка изменяемых элементов.
• tailoringName - строка, представляющая собой имя экземпляра компонента. Оно тесно связано с процессом настройки. tailoringName - используется для получения сохраненной информации о настройке для каждого компонента.
• totalItemsNumber - целое число, обозначающее общее число элементов списка, соответствующих критериям поиска и фильтрации.
• selectedItems - объект JSON, содержащий список выбранных элементов в сетке. Ниже приведен пример:
{
"timeStamp":"2019-08-25 18:53:33.476",
"data":[
{
"itemListsData":[
{
"items":[
{
"workItem":{
"value":"OR:wt.workflow.work.WorkItem:143921"
}
},
{
"workItem":{
"value":"OR:wt.workflow.work.WorkItem:143928"
}
}
],
"objectType":"PTC.Workflow.WorkItem"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"version":"1.0.0",
"statusMessage":"OK",
"status":"200"
}
Поля конфигурации
В следующих таблицах показаны поля JSON, используемые для конфигурирования этого компонента.
Имя свойства | Описание | Тип | Значение по умолчанию | Обязательное или необязательное |
maxNumberOfRowsInGrid | Максимальное число строк, отображаемых в области сетки. Рекомендуется ввести значение, не превышающее 10 000. | Целое число | 50 | Необязательное |
modelThingName | Наименование вещи модели, получающей эти данные. | Строка | PTC.ItemListModelThing. | Обязательное |
label | Заголовок списка элементов. | Строка | [[PTC.ItemList]] | Необязательное |
selectionType | Определяет, сколько объектов в сетке можно выбрать за один раз. Доступные опции: none, single или multi. | Строка | multi | Необязательное |
waitForInput | Определяет, нужно ли во время выполнения ожидать передачи значения во входной параметр мэшапа списка элементов, прежде чем инициировать загрузку элементов, заполняющих сетку. Доступные опции: true, false. | Логический | false | Необязательное |
filterFieldID | ИД поля в серверной системе, по которому нужно выполнить фильтрацию. Если это поле пустое, опции фильтрации не применяются. | MultiValueSelector | Н/Д | Необязательное |
filterLabelOverride | Метка для фильтра, которая переопределяет отображаемое значение, возвращенное из модели. | Строка | Н/Д | Необязательное |
defaultSelectedFilterValue | Начальные выбранные значения (одно или несколько), по которым будет выполняться фильтрация. Если это поле пустое, фильтрация по умолчанию не задана. | Строка | Н/Д | Необязательное |
defaultSortField | Начальный столбец, по которому нужно выполнить сортировку. Если это поле пустое, список элементов будет отсортирован по первому столбцу. | MultiValueSelector | Н/Д | Необязательное |
defaultSortDirection | Направление сортировки по умолчанию, если это применимо. Доступные опции: asc, что означает сортировку по возрастанию, и dsc, что означает сортировку по убыванию. Если это поле оставлено пустым, используется направление сортировки по возрастанию. | Строка | asc | Необязательное |
enableSearch | Определяет, должно ли присутствовать поле поиска. Опции: true, false. | Логический | true | Необязательное |
findHintText | Текст подсказки, отображаемый в поле поиска. | Строка | "[[PTC.ItemListFindHintText]]" | Необязательное |
attributes | Атрибуты, которые должны отображаться в сетке. Дополнительные сведения см. в документации MultiValueSelector. См. дополнительные подсвойства: | MultiValueSelector | Н/Д | Обязательное |
fieldTitleOverride | Альтернативное отображаемое наименование атрибута, которое переопределяет имя поля, полученное из модели. | Строка | Н/Д | Необязательное |
showExportAction | Включает или выключает действие "Экспорт". Опции: true, false. | Логический | true | Необязательное |
actionBarConfiguration | Конфигурация встроенной панели действий. Дополнительные сведения см. в разделе Панель действий. | JSON | Н/Д | Необязательное |
modelConfigurations | Точка входа в построителе приложений для передачи в модель дополнительных значений, которые нужно использовать для дальнейшей настройки компонента. | JSON | Н/Д | Необязательное |
Пример конфигурации
{
"modelConfigurations":{
},
"filterFieldId":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"defaultSortField":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"actionBarConfiguration":{
"maxItemsToShow":{
"value":2
},
"modelThingName":{
"entityName":"PTC.ActionBarModel.Thing"
},
"actions":{
"selectedValues":{
"data":[
{
"itemListsData":[
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
}
},
"modelThingName":{
"entityName":"PTC.ItemListModelThing"
},
"label":{
"value":"[[PTC.ItemListLabel]]"
},
"showExportAction":{
"value":true
},
"selectionType":{
"selectedKey":"multi"
},
"waitForInput":{
"value":false
},
"filterLabelOverride":{
"value":""
},
"defaultSortDirection":{
"selectedKey":"asc"
},
"attributes":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"",
"additionalData":{
"fieldTitleOverride":{
"value":""
}
}
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"defaultSelectedFilterValue":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"enableSearch":{
"value":true
},
"maxNumberOfRowsInGrid":{
"value":50
}
}
