getState

возвращает объект реактивного состояния Pivot

object

объект состояния

Example

// возвращаем текущее состояние
const state = $$("pivot").getState();
 
// переключаем виджет в режим "chart"  
state.mode = "chart";

Related samples

Возвращаемый объект содержит следующие свойства и методы:

{
  chart: {
    scale: "linear",
    type: "bar"
  },
  config: true,
  datatable: {
    footer: true,
    maxY: true
  },
  fields: [
    {name: "oil", value: "oil", type: "number"},
    // другия поля
  ],
  mode: "tree",
  readonly: false,
  structure: { ...structure config }
}

Свойства

• chart - определяет настройки для чарта в режиме chart. Внутри объекта вы можете описывать любые настройки объекта конфигурации Chart. Также есть следующие настройки:
  • type (string) - тип чарта
  • scale (string) - шкала чарта
  • legend (object) - легенда чарта
  • scaleColor (string) - цвета шкалы. HEX код или название цвета ("#999999", или "grey")
  • lines (boolean) - если false, линии осей не отображаются. true по умолчанию.
• config (boolean) - определяет, открыта ли форма
• datatable - определяет настройки для таблицы в режимах table и tree. Внутри объекта вы можете описывать любые настройки объекта конфигурации Datatable. Также есть следующие настройки:
  • footer (boolean, string) - определяет, отображать ли сумму значений столбцов. Возможные значения:
    • true
    • false (по умолчанию)
    • "sumOnly" - показывать сумму только для столбцов "sum".
  • minX (boolean) - подсвечивает минимальное значение ряда
  • maxX (boolean) - подсвечивает максимальное значение ряда
  • minY (boolean) - подсвечивает минимальное значение столбца
  • maxY (boolean) - подсвечивает максимальное значение столбца
  • cleanRows (boolean) - удаляет повторяющиеся значения в первом столбце (в режиме table).
• mode (string) - определяет текущий режим. Возможные значения:
  • "tree" - режим дерева (по умолчанию)
  • "table" - режим таблицы
  • "chart" - режим чарта.
• readonly (boolean) - если true, пользователь не сможет настраивать Pivot через форму. false по умолчанию.
• structure (object) - настройки для Pivot. Объект содержит следующие поля:
  • rows (array) - массив рядов таблицы
  • columns (array) - массив столбцов таблицы. Эквивалентно полю groupBy в режиме "chart"
  • values (array) - массив с настройками значений. Каждый объект содержит следующие поля:
    • name (string) - название поля
    • operation (string, array) - название операции. Встроенной ("sum", "min", "max", "avg", "wavg", "count", "any") или кастомная. Свойство принимает строку или массив строк
    • format (function) - форматирующая функция
    • color (string) - цвет для секций чартов.
  • filters (array) - массив полей для фильтрации.
  • groupBy (string) - название поля, по которому происходит группирование. Используется в режиме чарта. Эквивалентно полю columns в режимах "table" и "tree".

Методы

• $observe (function) - отслеживает изменения в текущем состоянии Pivot. Принимает два параметра:
  • prop (string) - реактивное свойство, которое изменяется
  • handler (function) - функция для выполнения, когда изменения произошли. Принимает только один аргумент:
    • value (any) - текущее значение реактивного свойства. Тип значения (строка, массив, и т.д.) зависит от реактивного свойства.
• batch (function)- позволяет изменять несколько свойств сразу. Принимает один параметр:
  • props (object) - объект, который содержит пары "имя свойства: значение".

Наверх