getState

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

object

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

Example

// возвращает текущее состояние Rich Text Editor
const state = $$("editor").getState();
 
// переключает виджет в режим "document" 
state.layoutMode = "document";

Related samples

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

{
    activeStyles: {/* используемое форматирование текста */},
    fullscreen: false,
    layoutMode: "classic",
    menubar: false, 
    paintMode: { 
        enabled: true, 
        continuous: true 
    },
    toolbar: true,
    selectedImage: null
}

Properties

• activeStyles (object) - хранит стили, которые используются под текущей позицией курсора. Дефолтное значение - {}

• selectedImage (null, object) - объект выделенной картинки, по умолчанию null. Содержит следующие поля:

  • id (number, string) - id выделенной картинки
  • node (object) - объект выделенной картинки

• editImage (null, object) - хранит настройки картинок, пока открыт редактор. Дефолтное значение - null. Объект редактирования картинки может содержать следующие опции:

  • id - id картинки
  • width - ширина картинки
  • height - высота картинки
  • src - путь к картинке
  • alt - альтернативный текст для картинки, если она не отображается

• paintMode (object) - объект с текущим состоянием режима "формат по образцу". Содержит следующие поля:

  • enabled (boolean) - включает/выключает режим "формат по образцу"
  • continuous (boolean) - определяет, включена ли функция многократного применения режима "формат по образцу"
    Возможные значения свойства paintMode:
    • { enabled: true, continuous: false } - включен обычный режим "формат по образцу"
    • { enabled: false, continuous: true } - функция многократного применения включена, режим "формат по образцу" выключен
    • { enabled: true, continuous: true } - функция многократного применения и режим "формат по образцу" включены
    • { enabled: false, continuous: false } - режим "формат по образцу" выключен

Methods

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

const state = $$("editor").getState();
state.$observe("layoutMode", v => webix.message(`Layout mode: ${v}`));
state.layoutMode = "document";

Наверх