Перейти к основному содержимому

template

Описание​

Функция template позволяет применять шаблон к ячейкам заголовка и тела таблицы.

Использование​

Для ячеек тела:

pivot.template({value, method, row, column}) => string;

Для ячеек заголовка:

pivot.template({value, field, method, cell, column}) =>  string;

Параметры​

Для ячеек тела функция принимает следующие параметры:

  • value (any) - (обязательный) необработанное значение ячейки
  • method (string) - (обязательный) метод или предикат, используемый для столбца
  • row - (обязательный) объект с данными строки:
    • id (number) - (обязательный) идентификатор строки
    • values (array) - (обязательный) массив с данными строки
    • open (boolean)- (необязательный) состояние ветки
    • $level (boolean)- (необязательный) индекс ветки
  • column - (обязательный) объект с данными столбца:
    • id (number) - (обязательный) идентификатор столбца
    • cell (any) - (необязательный) шаблон с содержимым ячейки (см. Добавление шаблонов через хелпер template)
    • template - (необязательный) шаблон, определённый через свойство tableShape
    • fields (array) - (необязательный) определяет поля в иерархическом столбце в режиме дерева. Отражает поля, отображаемые в этом столбце на разных уровнях
    • field - (необязательный) строка, являющаяся идентификатором поля
    • method (string) - (необязательный) метод, если он определён для поля в данном столбце
    • methods (array) - (необязательный) определяет методы, применяемые к полям в иерархическом столбце в режиме дерева
    • format (string or object) - (обязательный) формат даты или числовой формат (см. Применение форматов к полям)
    • isNumeric (boolean) - (необязательный) определяет, содержит ли столбец числовые значения
    • isTotal (boolean) - (необязательный) определяет, является ли столбец итоговым
    • area (string) - (необязательный) область, в которой отрисовывается столбец: "rows", "columns", "values"
    • header- (необязательный) массив ячеек заголовка со следующими свойствами для каждой ячейки:
      • text (string) - (необязательный) текст ячейки, отформатированное значение или значение, обработанное шаблоном предиката
      • rowspan (number) - (необязательный) количество строк, которые должен охватывать заголовок
      • colspan (number) - (необязательный) количество столбцов, которые должен охватывать заголовок
      • value (any) - (обязательный) необработанное значение, если ячейка принадлежит области "columns"
      • field (string) - (обязательный) поле, значение которого отображается, если ячейка принадлежит области "columns"
      • method (string) - (обязательный) предикат поля, если ячейка принадлежит области "columns" и предикат определён
      • format (string or object) - формат даты или числовой формат (см. Применение форматов к полям)

Для ячеек заголовка параметры функции следующие:

  • value (any) - (обязательный) необработанное значение ячейки
  • method (string) - (необязательный) предикат, используемый для столбца
  • field (string) - (необязательный) поле, значение которого отображается в ячейке
  • cell - (обязательный) объект с данными ячейки:
    • text (string) - (необязательный) текст ячейки, отформатированное значение или значение, обработанное шаблоном предиката
    • rowspan (number) - (необязательный) количество строк, которые должен охватывать заголовок
    • colspan (number) - (необязательный) количество столбцов, которые должен охватывать заголовок
    • value (any) - (обязательный) необработанное значение, если ячейка принадлежит области "columns"
    • field (string) - (обязательный) поле, значение которого отображается, если ячейка принадлежит области "columns"
    • method (string) - (обязательный) предикат поля, если ячейка принадлежит области "columns" и предикат определён
    • format (string or object) - (обязательный) формат даты или числовой формат (см. Применение форматов к полям)
  • column - (обязательный) объект с данными столбца (аналогичен объекту для ячейки тела)

Пример​

Фрагмент ниже показывает, как определять шаблоны с помощью хелпера pivot.template. Хелпер применяется непосредственно перед отрисовкой таблицы — путём перехвата события render-table с помощью метода api.intercept().

Фрагмент демонстрирует, как добавлять иконки к:

  • ячейкам тела на основе их поля (id, user_score) (шаблон добавляет иконки флага и звезды)
  • подписям заголовков на основе имени поля (например, если поле — "id", рядом со значением заголовка добавляется иконка глобуса)
  • заголовкам столбцов на основе значения (добавляются цветные индикаторы-стрелки)

Связанные статьи:

Need more help?Contact Support