Как работать со справочником по JS API

Справочник по JavaScript API модуля Web-клиент — ресурс, содержащий описание классов, функций и других членов предоставляемого Web-клиентом клиентского API, используемого при разработке клиентских расширений и скриптов.

Справочник по JS API размещен по адресу: https://docsvision.com/docs/webclient/версия-Web-клиента/JsDocApi/, например, https://docsvision.com/docs/webclient/6.1/JsDocApi/.

Главная страница справочника по JS API
Рисунок 1. Главная страница справочника по JS API
Окно справочника содержит:

  • Строку поиска,

  • Флаги Показывать protected-члены (включает показ защищенных членов JS API) и Показывать унаследованные члены (включает показ унаследованных членов JS API),

  • Меню для перехода к описанию элементов JS API,

  • Легенду с описанием условных обозначений.

Как работать с описаниями сущностей

Чтобы получить описание для определённого класса, метода и т.п., нужно воспользоваться поиском или перейти к описанию из правого меню. К примеру, чтобы получить описание для класса элемента управления Сотрудник, нужно выполнить поиск по слову Employee (название класса элемента управления Сотрудник), или открыть из правого блока элемент App  BackOffice  Controls  Employee  Employee  Синий кубик.

Значок Синий кубик слева от названия ссылки указывает, что данный раздел посвящен описанию класса. Условные обозначения всех типов сущностей приведены в легенде.
Страница с описанием класса Employee
Рисунок 2. Страница с описанием класса Employee
На странице с описанием класса приведены:

  • Общая информация о классе,

  • Родительский класс,

  • Конструкторы,

  • Методы,

  • Свойства и др.

В зависимости от типа описываемого члена JS API список может изменяться.

Некоторые члены JS API могут быть отмечены предупреждением:

Это внутренний нестабильный API, который может измениться в следующих версиях Web-клиент.

Использовать такой класс, интерфейс или метод следует с осторожностью, т.к. его сигнатура не стабильна и может измениться в следующих версиях Web-клиента.

Над названием сущности указан модуль Web-клиента (на изображении — @docsvision/webclient/BackOffice/Employee), содержащий данную сущность.

Чтобы перейти к описанию метода, полей и пр., кликните по ссылке с названием данного члена API.

Описание поля класса содержит:

  • Название поля,

  • Тип поля,

  • Примечание.

Описание метода содержит:

  • Название метода,

  • Сигнатуру, примечание,

  • Список параметров метода с типами,

  • Тип возвращаемого значения.

Получение описания класса элемента управления

  1. Определите название класса элемента управления.

    Название класса ЭУ обычно совпадает с названием его типа, которое указано в свойстве Название ЭУ в программе Конструктор Web-разметок.
    Тип элемента управления в программе Конструктор Web-разметок
    Рисунок 3. Тип элемента управления в программе Конструктор Web-разметок

  2. Перейдите к описанию класса в справочнике:

    • Воспользуйтесь прямой ссылкой из описания элемента управления, которое приведено в данной документации.

    • Воспользуйтесь поиском по справочнику или правым меню.

      Публичные свойства и события элемента управления программно связаны с его классом и содержатся в свойстве params класса.

      Чтобы получить описание для класса публичных свойств ЭУ:

      1. Найдите на странице секцию Properties.

      2. Найдите описание свойства params.

      3. Щелкните по ссылке с типом свойства. Будет открыто описание типа свойства params.

        Описание типа свойства params аналогично описанию других типов.

      Чтобы получить описание для класса значения ЭУ:

      1. Перейдите к описанию класса публичных свойств ЭУ.

      2. Найдите на странице секцию Properties.

      3. Найдите описание свойства value.

      4. Щелкните по ссылке с типом свойства. Будет открыто описание типа свойства value.

        Описание типа свойства value аналогично описанию других типов.

      Чтобы получить описание для класса события ЭУ:

      1. Перейдите к описанию класса публичных свойств ЭУ.

      2. Найдите на странице секцию Properties.

      3. Найдите описание требуемого события — на уровне объектной модели ЭУ его событие является свойством ЭУ.

      4. Щелкните по ссылке с типом события. Будет открыто описание класса.

      К примеру, тип события click элемента управления Кнопка, которое возникает при нажатии, — BasicApiEvent. Тип аргумента, передаваемого с событием, указан в угловых скобках.

      Событие типа BasicApiEvent (реализует интерфейс IBasicEvent) является непрерываемым, т. е. остановить обработку данного события другими обработчиками нельзя. Если тип события CancelableApiEvent (реализует интерфейс ICancelableEvent), то данное событие является прерываемым (подробнее в разделе Прерывание выполнения операции).