DataGrid

Таблица.

Syntax

new DataGrid([parent])

Parameters

Name Type Description
parent Element Родительский элемент

Methods

Name Description
getColumns Возвращает коллекцию колонок таблицы.
getShowSelectors Возвращает значение, определяющее показывать ли колонку с CheckBox/Radio для выбора элементов.
setShowSelectors Устанавливает значение, определяющее показывать ли колонку с CheckBox/Radio для выбора элементов.
getCheckAllVisible Возвращает значение, определяющее виден ли элемент “Выбрать все” в шапке таблицы.
setCheckAllVisible Устанавливает значение, определяющее виден ли элемент “Выбрать все” в шапке таблицы.
getCheckAll Возвращает состояние элемента “Выбрать все” из шапки таблицы.
getVerticalAlignment Возвращает вертикальное выравнивание элемент.
setVerticalAlignment Устанавливает вертикальное выравнивание элемента.

Events

Name Description
onCheckAllChanged Устанавливает обработчик события о том, что состоняие элемента “Выбрать все” в шапке таблицы изменилось.
onRowClick Устанавливает обработчик события на клик по элементам DataGrid.
onRowDoubleClick Устанавливает обработчик события на двойной клик по элементам DataGrid.

DataGrid.metadata

Метаданные типа DataGrid.

Properties

Name Type Default Description
Columns Array.<DataGridColumn> Список колонок таблицы.
ShowSelectors Boolean true Определяет показывать ли колонку с CheckBox/Radio для выбора элементов.
Scroll Boolean true Расстягивает DataGrid на все свободное пространство по вертикали.
CheckAllVisible Boolean false Определяет виден ли элемент “Выбрать все” в шапке таблицы.
OnCheckAllChanged Script Устанавливает обработчик изменения состоняие элемента “Выбрать все” в шапке таблицы.
VerticalAlignment String (⇔) Вертикальное выравнивание таблицы. Возможны значения: Top, Center, Bottom, Stretch.
RowBackground Color (⇔) Цвет фона строки
RowForeground Color (⇔) Цвет текста строки
RowTextStyle TextStyle (⇔) Стиль текста строки
RowStyle String (⇔) Имя кастомного стиля, применяемого к строке
onRowClick Script Устанавливает обработчик события на клик по элементам DataGrid.
onRowDoubleClick Script Устанавливает обработчик события на двойной клик по элементам DataGrid.

(⇔) Свойство может быть задано, как DataBinding.

Examples

{
  "DataGrid": {
    "Columns": [
      {
        "Header": "Name",
        "CellProperty": "Name",
        "Sortable": true,
        "SortedDefault": "asc",
        "SortFunction": "{ console.log(args.sortDirection) }"
      },
      {
        "Header": "Family",
        "CellProperty": "Family"
      },
      {
        "Header": "Kingdom",
        "CellProperty": "Kingdom"
      }
    ],
    "VerticalAlignment": "Stretch",
    "Items": {
      "Source": "peopleDataSource"
    },
    "OnRowClick": "{ console.log(args.source) }",
    "OnRowDoubleClick": "{ console.log(args.source) }",
    "RowBackground": {
      "Source": "RowStyleDataSource",
      "Property": "#",
      "Mode": "ToElement",
      "Converter": {
        "ToElement": "{ return args.value.Age > 100 ? 'Accent1' : 'Accent2'; }"
      }
    }
  }
}