Свойства расширенных сеток

Mashup Builder > Виджеты > Унаследованные виджеты > Расширенные сетки (унаследованные) > Свойства расширенных сеток

Свойства расширенной сетки и расширенной сетки дерева, доступные в режиме конструирования Mashup Builder, могут быть разными в зависимости от способа конфигурирования сетки: с помощью Mashup Builder (статическая конфигурация) или с помощью сервиса (динамическая конфигурация). В следующей таблице перечислены все свойства, доступные при конфигурировании сетки с помощью Mashup Builder.

Свойства, доступные для конфигурирования только из Mashup Builder, а не через динамическую конфигурацию, помечены в таблице * звездочкой (*).

Имя свойства

Описание

Базовый тип

Значение по умолчанию

Доступно для связывания (Д/Н)?

Применимо к сетке или к сетке дерева?

Id*

Уникальный идентификатор для внутреннего использования ThingWorx.

INTEGER

Gridadvanced-<id> или

Treegridadvanced--<id>

Оба

Type*

Тип виджета.

Н/Д

Grid-Advanced или Tree-Grid-Advanced

Оба

DisplayName*

Определяемое пользователем имя для идентификации сетки при отображении.

STRING

gridadvanced-n или treegridadvanced-n

Оба

Description*

Определяемое пользователем описание.

STRING

Н/Д

Оба

Data*

Источник данных, которые загружаются при запуске сетки.

Если сетка привязана к источнику данных, отображается закрашенная стрелка

. Если источник данных отсутствует, отображается незакрашенная стрелка

INFOTABLE

Н/Д

Оба

ChildData*

Источник дочерних данных, которые динамически загружаются при развертывании узлов.

Если сетка привязана к дочернему источнику данных, отображается закрашенная стрелка:

Если нет дочернего источника данных, отображается незакрашенная стрелка:

INFOTABLE

Н/Д

Только сетка дерева

ParentIDFieldName

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

Для строки верхнего уровня, не имеющей родителя, значением должна быть прямая коса черта (/).

STRING

parentId

Только сетка дерева

IDFieldName

Столбец основного ключа для сетки. Значения в этом столбце являются уникальными идентификаторами для каждой строки данных. Это свойство является необязательным для расширенной сетки, но требуется для сетки дерева.

Если поле не указано или если указанное поле не существует, сетка создает ее собственный внутренний ИД строки.

Индексы идентификаторов строк должны начинаться со значения индекса, равного 1. При обнаружении строки с идентификатором, равным нулю (0), на консоли JavaScript отображается сообщение об ошибке, и эта строка не отображается в сетке.

STRING

Оба

IDPathSeparator

Включает конфигурирование символа разделителя путей.

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

STRING

Только сетка дерева

HasChildrenFieldName

Указывает имя столбца, показывающего, существуют ли для строки доступные дочерние данные.

Чтобы показать, что у строки нет дочерних элементов, введите одно из следующих значений: "0", 0, "false", false, пустая строка или undefined.

Любое другое значение означает, что для строки существуют дочерние элементы.

STRING

hasChildren

Только сетка дерева

Configuration*

Если сетка привязана к сервису конфигурации, отображается закрашенная стрелка

Если сервис конфигурации отсутствует, отображается незакрашенная стрелка

Опция Добавить доступна для свойства Configuration, которое используется для входа JSON на открывшейся странице. Кнопка Добавить превращается в кнопку Править, если ввести данные JSON, нажать кнопку Готово и вернуться на панель свойств.

STRING

Н/Д

Оба

IsEditable

Определяет, можно ли править значения в ячейках сетки при отображении сетки во время выполнения. При включении этого свойства события EditCellStarted и EditCellComplete отображаются на панели Свойства.

Чтобы править значения в конкретном столбце, необходимо также настроить столбец как редактируемый. См раздел "Опции правки ячеек" в Конфигурирование столбцов из контекстного меню.

BOOLEAN

False

Оба

EnableEditButtons

Активирует на панели инструментов сетки кнопки Править, Сохранить и Отмена для сохранения изменений вручную.

Если требуется, чтобы изменения сохранялись автоматически, включите описанное выше свойство IsEditable. Если нужно сохранять изменения вручную, задайте свойство EnableEditButtons.

Дополнительные сведения см. в разделе Правка ячеек в расширенных сетках.

При задании этого свойства на панели Свойства отображаются следующие свойства виджета:

• Свойства конфигурации EnableAddDeleteButtons и EditButtonsLocation.

• События EditStarted, EditCompleted и EditCancelled.

BOOLEAN

False

Оба

EnableAddDeleteButtons

Если для этого свойства задано значение true, кнопки Добавить и Удалить, позволяющие добавлять или удалять строки, появляются на информационной панели сетки.

Щелкните Править во время выполнения, чтобы увидеть кнопки Добавить или Удалить на панели инструментов.

BOOLEAN

False

Только расширенная сетка

EditedTable

Доступное для связывания свойство, указывающее расположение выходных данных с обновленными значениями при редактировании ячеек во время выполнения. Для сохранения обновленных значений это свойство должно быть привязано к сервису обновления таблицы данных. Например: привяжите сервис AddOrUpdateDataTableEntries к вещи "Таблица данных".

Перед использованием свойства EditedTable необходимо задать свойство IsEditable. Кроме того, отдельные столбцы должны быть сконфигурированы как редактируемые. См раздел "Опции правки ячеек" в Конфигурирование столбцов из контекстного меню

INFOTABLE

Н/Д

Оба

EnableKeyboardNavigation

Позволяет перемещаться по виджету с помощью клавиатуры.

Если для этого свойства задано значение False, навигация с помощью клавиатуры невозможна.

BOOLEAN

True

Оба

DeletedTable

Это свойство определяет выходное расположение для строк, которые удаляются из сетки во время выполнения.

Для сохранения обновленных значений это свойство должно быть привязано к сервису обновления таблицы данных. Например: привяжите это свойство к сервису AddOrUpdateDataTableEntries в вещи "Таблица данных".

INFOTABLE

Н/Д

Только расширенная сетка

DisplayOnlyMode

Задает сетку в режиме только для отображения.

BOOLEAN

False

Оба

DefaultSelectedRows

Определяет, какие номера строк подсвечиваются по умолчанию при отображении сетки. Значения могут содержать разделенные запятыми числа и диапазоны.

Например: 1,2,4-5

Это свойство также может быть определено с помощью привязанного сервиса. Если сервис привязан, отображается

Если сервиса нет, отображается

Это свойство не действует, если для свойства RowSelection задано значение none. Чтобы выбрать несколько строк, свойство RowSelection должно иметь значение multi.

В сетке дерева выбор строки по умолчанию зависит от того, какие строки находятся в представлении. Если свойство ExpandLoadedRows задано, все предварительно загруженные строки развертываются и по умолчанию выбор начинается с верхнего уровня и отсчитывается вниз, включая как родительские, так и дочерние строки. Если предварительно загруженные строки не развернуты, выбор по умолчанию начинается с верхнего уровня и охватывает только родительские строки.

STRING

Н/Д

Оба

SelectedRows*

Определяет, используя INFOTABLE, какие строки подсвечиваются по умолчанию при отображении сетки.

При выборе строк в сетке дерева только столбец идентификаторов строки является обязательным, но можно включать другие столбцы.

В расширенной сетке выбор строк обрабатывается путем привязывания выходных данных параметра SelectedRows в сервисе к входному свойству SelectedRows в сетке.

Это свойство доступно для привязки в выходном или входном направлении, так что одна сущность может управлять выбором строк в другой. Например, одна таблица может управлять выбором строк в другой таблице или для выбора строк в таблице может использоваться 3D-изображение.

Для управляющей сущности привяжите сервис как выходные данные INFOTABLE

Для управляемой сущности привяжите сервис как входные данные INFOTABLE:

INFOTABLE

Н/Д

Оба

IncludeRowExpansionParents*

Определяет, будут ли родительские строки, не включенные в предварительно загруженные данные на стороне клиента, включаться при выборе или развертывании дочерних строк. Если задано значение true, родительские строки будут вызываться вместе с дочерними, чтобы можно было воссоздать иерархию.

В зависимости от глубины и размера данных использование этого свойства может по разному влиять на производительность сетки. См. раздел Рекомендации по производительности для виджета "Сетка дерева".

BOOLEAN

False

Только сетка дерева

ExpandRows*

Идентификаторы всех строк верхнего уровня или дочерних строк в сетке, которые должны быть развернуты. При выборе строк для развертывания обязательным является только столбец Row ID.

INFOTABLE

Н/Д

Только сетка дерева

ExpandLoadedRows*

Автоматически развертывает все предварительно загруженные данные при запуске сетки.

Должно быть доступно несколько уровней предварительно загруженных данных. Если это свойство задано, оно влияет на способ подсветки строк при определении DefaultSelectedRows. Это свойство должно быть выключено, чтобы использовать свойство PreserveRowExpansion.

BOOLEAN

False

Только сетка дерева

ExpandRowOnDoubleClick

Развертывает строку с потомками, если дважды щелкнуть строку или щелкнуть значок узла.

В сервисе конфигурации JSON для этого свойства задано имя treeSettings.expandRowOnDoubleClick.

BOOLEAN

False

Только сетка дерева

PreserveRowExpansion

Сохраняет выбор расширения строк при обновлении сетки. При использовании этого свойства убедитесь, что для свойства maxLevels в вашем сервисе загрузки данных в дереве задано значение, превышающее уровень, до которого нужно развернуть. Дополнительные сведения о сервисе данных см. в разделе Работа с данными сетки дерева

Если задано свойство ExpandLoadedRows, оно переопределяет это свойство и развертывает все предварительно загруженные строки. Если требуется сохранить конкретное развертывание строк, отключите свойство ExpandLoadedRows, когда включаете опцию PreserveRowExpansion. Чтобы сохранить значения развертывания строк, необходимо задать свойство CookiePersistence.

BOOLEAN

False

Только сетка дерева

RowSelection

Определяет, какой выбор строк доступен для конфигурирования. Опции: none, single и multi.

Если выбрана опция none, другие свойства выбора строк не действуют.

Если включить свойство IsEditable или EnableEditButtons, свойство RowSelection не действует в сетке. Можно выбирать строки, когда сетка не находится в режиме правки.

STRING

Нет

Только сетка

AutoScroll

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

BOOLEAN

False

Оба

CookiePersistence*

Активирует сохранение на стороне клиента некоторых настроек столбцов (порядок, размер, видимость и порядок сортировки).

BOOLEAN

True

Оба

EnableContextMenu*

Включает или выключает отображение контекстного меню сетки во время выполнения, что позволяет конечному пользователю показывать или скрывать конкретные столбцы. В сочетании с CookiePersistence действует следующим образом:

• Если включены оба свойства, пользователь может отображать и скрывать столбцы и этот выбор сохраняется.

• Если значение EnableContextMenu не задано, а CookiePersistence задано, пользователь не сможет показывать или скрывать столбцы, но предыдущий выбор сохраняется.

• Если значение EnableContextMenu задано, а значение CookiePersistence не задано, можно показывать и скрывать столбцы, но только для текущего запроса.

В сервисе конфигурации JSON можно задать свойство как параметр верхнего уровня следующим образом:

var config = {“enableContextMenu”: false,...}

BOOLEAN

True

Оба

EnableSorting

Это свойство должно быть включено, чтобы действовали любой тип сортировки столбцов, включая переключение между сортировкой по возрастанию и по убыванию с помощью заголовков, свойство MultiColumnSortOrder или привязка сервиса сортировки. Если эта опция задана, на панели Свойства становятся доступными следующие свойства:

• QueryFilter - запрос доступного для связывания фильтра для использования с сервисом данных.

• Filter - доступное для связывания свойство события, инициирующее сервис данных запроса.

BOOLEAN

False

Оба

MultiColumnSortOrder

Задает порядок сортировки столбцов по умолчанию. Синтаксис: имя столбца:порядок сортировки, имя столбца:порядок сортировки

Например: office:asc,title:des

Для этого необходимо задать значение EnableSorting для MultiColumnSortOrder.

STRING

Н/Д

Оба

EnableGridSearch

Размещает на сетке панель инструментов с полем глобального поиска. Если эта опция задана, на панели Свойства становятся доступными следующие свойства:

• QueryFilter - запрос доступного для связывания фильтра для использования с сервисом данных.

• Filter - доступное для связывания свойство события, инициирующее сервис данных запроса.

BOOLEAN

False

Оба

GridSearchLocation

Определяет, где должно быть помещено поле поиска. Эта опция становится доступной, только когда задано свойство EnableGridSearch.

STRING

Н/Д

Оба

QueryFilter*

Доступное для связывания свойство запроса, используемое для привязки сервиса запросов в качестве входного параметра запроса для управления сортировкой, поиском и фильтрацией данных. Это свойство становится доступным, если включены свойства EnableSorting или EnableGridSearch. Его можно задать на панели свойств или в контекстном меню самой сетки.

Если в вашем мэшапе используется виджет "Фильтр данных", выходное свойство QueryFilter может быть привязано к входному свойству запроса в виджете "Расширенная сетка" или "Сетка дерева". Сетка объединяет все параметры запроса для создания единого фильтра выходных данных, привязанного к указанному сервису. Если фильтр запроса привязан в обоих направлениях подобно этому, появляются закрашенные стрелки:

Если виджет "Фильтр данных" не существует и привязка создана только в направлении вывода, будет закрашена одна стрелка, а другая будет не закрашена:

QUERY

Н/Д

Оба

EnableGridReset

Размещает панель инструментов с кнопкой сброса сетки. Щелкните Сброс, чтобы очистить все пользовательские настройки сетки, сохраненные в файлах cookie, и вернуть сетку в конфигурацию по умолчанию.

BOOLEAN

False

Оба

EnableFilterEventOnConfigChange*

Включает или выключает инициирование события при обновлении конфигурации из сервиса.

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

BOOLEAN

True

Оба

EnableFooter

Включает раздел нижнего колонтитула в сетке. Если для этого свойства задано значение true, задаются дополнительные свойства с именами FooterData и TableFooterStyle.

Данные в разделе нижнего колонтитула можно привязать, используя свойство FooterData.

Дополнительные сведения см. в разделе Раздел нижнего колонтитула в расширенных сетках

BOOLEAN

False

Оба

FooterData

Содержит данные, которые появляются в нижнем колонтитуле сетки.

INFOTABLE

Н/Д

Оба

GridResetButtonLocation

Определяет, где должна быть помещена кнопка сброса сетки.

STRING

Н/Д

Оба

RowFormat

Открывает диалоговое окно, в котором можно определить дополнительные правила на основе строк, чтобы применить динамическое Форматирование состояния. Эти зависящие от строк правила могут переопределяться форматированием состояния ячеек, доступным в опции Настроить столбцы сетки в контекстном меню сетки.

STATE FORMATTING

Форматирование по состоянию

Оба

TableWrapperStyle

Определяет стили фона сетки. Эта опция добавляет цвет контура вокруг всей таблицы и задает цвет фона. Поддерживаемые атрибуты: цвет линии, вес и тип, цвет фона и альтернативный цвет фона.

STYLEDEFINITION

DefaultTableWrapperStyle

Оба

TableHeaderStyle

Определяет стили заголовков сетки.

STYLEDEFINITION

DefaultTableHeaderStyle

Оба

FocusStyle

Определяет стиль строки, находящейся в фокусе в сетке.

STYLEDEFINITION

DefaultFocusStyle

Оба

RowBackgroundStyle

Определяет стиль фона строки. Это действие добавляет цвет фона, цвет шрифта и стиль толщины. Но оно не добавляет стиль линии в каждую строку.

STYLEDEFINITION

DefaultRowBackgroundStyle

Оба

RowAlternateBackgroundStyle

Определяет стиль фона второй строки для альтернативных строк. Это свойство добавляет цвет шрифта и стиль толщины, но не добавляет стиль линии.

STYLEDEFINITION

DefaultRowAlternateBackgroundStyle

Оба

RowHoverStyle

Определяет стиль строки при наведении указателя на строку. Добавляет к каждой ячейке цвет фона и шрифт. Цвет, толщина и тип линии применяются только к строке, на которую помещен указатель.

STYLEDEFINITION

DefaultRowHoverStyle

Оба

RowSelectedStyle

Определяет стиль строки, когда она выбрана. Добавляет к каждой ячейке цвет фона и шрифт. Цвет, толщина и тип линии применяются только к выбранной строке.

STYLEDEFINITION

DefaultRowSelectedStyle

Оба

RowBorderStyle

Определяет стили границ строки. Это свойство добавляет цвет линии, толщину и тип для горизонтальных сторон ячейки.

STYLEDEFINITION

DefaultRowBorderStyle

Оба

CellBorderStyle

Определяет стили границ ячейки. Это свойство добавляет цвет линии, толщину и тип для вертикальных сторон ячейки.

STYLEDEFINITION

DefaultCellBorderStyle

Оба

ToolbarStyle

Определяет стили для панелей инструментов.

STYLEDEFINITION

DefaultToolbarStyle

Оба

TableFooterStyle

Определяет стиль раздела нижнего колонтитула в сетке. В том числе цвет фона, стиль границы и стиль шрифта.

STYLE DEFINITION

DefaultGridAdvancedFooterStyle

Оба

TooltipStyle

Определяет стили всплывающих подсказок.

STYLEDEFINITION

DefaultTooltipStyle

Оба

SortAscendingStyle

Определяет стиль значка сортировки по возрастанию.

STYLEDEFINITION

DefaultSortAscendingStyle

Оба

SortDescendingStyle

Определяет стиль значка сортировки по убыванию.

STYLEDEFINITION

DefaultSortDescendingStyle

Оба

CellValidationErrorStyle

Определяет стиль ячейки при возникновении ошибки проверки.

STYLE DEFINITION

DefaultCellValidationErrorStyle

Оба

CellValidationErrorTooltipStyle

Определяет стиль всплывающей подсказки ячейки при возникновении ошибки проверки.

STYLE DEFINITION

DefaultCellValidationErrorTooltipStyle

Оба

RowIconStyle

Определяет стиль значка папки для узлов дерева.

STYLEDEFINITION

DefaultRowIconStyle

Только сетка дерева

RowExpansionIconStyle

Определяет стиль значка развертывания для узлов дерева.

STYLEDEFINITION

DefaultRowExpansionIconStyle

Только сетка дерева

RowCollapseIconStyle

Определяет стиль значка свертывания для узлов дерева.

STYLEDEFINITION

DefaultRowCollapseIconStyle

Только сетка дерева

HeaderOverflow

Предоставляет опции для обработки текста ячейки заголовка при переполнении. Опции:

• fitted - текст подгоняется по ширине столбца и затем переносится, даже в середине слова.

• wrapped - текст переносится на дополнительные строки по пробелам или тире.

• clipped - текст обрезается в конце ячейки заголовка.

• ellipsis - текст обрезается с добавлением многоточия (...), обозначающего, что есть еще текст.

• tooltip - текст обрезается с добавлением многоточия (...), а полный текст отображается во всплывающей подсказке.

STRING

Всплывающая подсказка

Оба

DataOverflow

Предоставляет опции для текста ячейки данных при переполнении. Доступны те же самые опции, что и в свойстве HeaderOverflow .

STRING

Обрезанная строка

Оба

MaxHeaderHeight

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

NUMBER

100

Оба

MinRowHeight

Настройка минимальной высоты строки сетки в пикселях.

Предположим, что не используется рендерер изображений для столбца, который показывает изображения, превышающие минимальную высоту строки по умолчанию, равную 30 пикселям. Примером может служить определение состояния, которое применяет стили, содержащие изображения. В этом случае убедитесь, что значение высоты строки увеличивается, чтобы вместить изображение.

NUMBER

Оба

MaxRowCacheSize

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

NUMBER

5000

Только сетка дерева

DoubleClicked*

Доступное для связывания свойство события, которое инициируется, если дважды щелкнуть сетку.

EVENT

Н/Д

Оба

Filter*

EVENT

Н/Д

Оба

EditCellStarted

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

Это событие можно использовать для изменения состояния других виджетов в мэшапе при правке.

EVENT

Н/Д

Оба

EditCellCompleted

Доступное для связывания свойство события, которое может быть инициировано, когда вы правите ячейку, а затем нажимаете клавишу ENTER, TAB или щелкаете за пределами измененной ячейки. Нажмите клавишу ESC, чтобы оставить значение неизмененным. При обновлении сетки отображаются измененные значения.

Для этого события имеются два способа использования:

• Можно привязать его к сервису обновления таблицы данных, чтобы сохранять отредактированные значения в таблице данных EditedTable.

• Можно привязать его к сервису, который включает виджет кнопки "Сохранить" в мэшапе. Кнопка "Сохранить", в свою очередь, может быть привязана к сервису обновления таблицы данных, чтобы обновленные значения из таблицы данных EditedTable сохранялись.

EVENT

Н/Д

Оба

EditStarted

Это событие инициируется при нажатии кнопки Править на панели инструментов сетки.

EVENT

Н/Д

Оба

EditCompleted

Это событие инициируется при нажатии кнопки Сохранить на панели инструментов сетки.

EVENT

Н/Д

Оба

EditCancelled

Это событие инициируется при нажатии кнопки Отмена на панели инструментов сетки.

EVENT

Н/Д

Оба

Z-index*

Упорядочение для многоуровневых виджетов. Виджет, у которого Z-индекс меньше, располагается позади другого виджета сетки, у которого Z-индекс больше.

NUMBER

Оба

Visible*

Если задано, сетка отображается во время выполнения. Это свойство может быть определено в сервисе, привязанном к сетке. Если к сетке привязан видимый сервис, отображается закрашенная стрелка:

Если нет видимого сервиса, отображается незакрашенная стрелка:

BOOLEAN

True

Оба

SelectedRowsChanged*

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

Чтобы использовать это свойство события, выполните следующие шаги:

• Задайте для свойства RowSelection значение single или multi.

• Привяжите свойство SelectedRows к другой сущности (виджету или сервису).

• Привяжите событие SeletedRowsChanged к другой сущности таким образом, чтобы оно инициировалось при изменении SelectedRows.

EVENT

Н/Д

Оба

* Если сервис конфигурации привязан к сетке, на панели Свойства Mashup Builder отображаются только наиболее часто используемые свойства. Все другие свойства скрываются в представлении, поскольку эти параметры передаются из сервиса JSON.

Стили сетки имеют приоритет в приведенном ниже порядке, стиль TableWrapperStyle имеет самый низкий приоритет, а стиль RowHoverStyle переопределяет все остальные.

1. TableWrapperStyle

2. RowBackground/RowAlternateBackgroundStyle

3. CellBorder/RowBorderStyle

4. FixedRowFormatter/State Definition

5. RowSelectedStyle

6. RowHoverStyle

Было ли это полезно?