getState

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

object getState();

Returns

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

Example

// возвращает текущее состояние редактора
const state = $$("editor").getState();

Related samples

Details

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

{
  gridStep: 20,
  zoom: 20,
  selected: {
    id: 100
  }
}

Если выбранный объект - ссылка, то в объект selected добавляется поле link:

{
  selected: {
    id: 25,
    link: true
  },
  //...
}

Свойства

  • gridStep (number) - задаёт шаг (в пикселях) для перетаскивания фигур в рабочей области. 10 по умолчанию
  • zoom (number) - определяет текущее значение зума. 1 по умолчанию
  • selected (object) - хранит объект с ID и доп. информацией (в случае ссылок) выбранного элемента (блока/фигуры или ссылки).

Методы

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