Документация для разработчиков
Темная тема

BX.UI.StageFlow.Stage

Описание и методы

Класс-модель для работы со стадией в рамках последовательности.

BX.UI.StageFlow.Stage
Метод Описание С версии
constructor(data: {}) Конструктор. Не используется в явном виде, для создания рекомендуется пользоваться методом create().

data - имеет следующую структуру:

  • id - идентификатор стадии;
  • name - название стадии;
  • color - цвет стадии;
  • backgroundColor - цвет фона;
  • isFilled - флаг того, должна ли стадия быть заполнена основным цветом;
  • events - список с обработчиками событий:
    • onMouseEnter
    • onMouseLeave
    • onClick
  • isSuccess - флаг того, что стадия является успешной;
  • isFail - флаг того, что стадия является неуспешной;
  • fillingColor - цвет для заливки.
create(data: {}): Stage Метод создает новую стадию. Объект data имеет такую же структуру, как для конструктора.

Этот метод проверяет наличие некоторых обязательных параметров в data, и если их нет, метод вернет null.

render(): Element Метод отрисует стадию и вернет DOM-элемент.
addBackLight(color) Метод добавляет подсветку с цветом color.
removeBackLight() Метод убирает подсветку.

Геттеры и Сеттеры

  • getId(): number
  • getName(): string
  • setName(name: string): Stage
  • isSuccess(): boolean
  • isFail(): boolean
  • isFinal(): boolean
  • getColor(): string
  • setColor(color: string): Stage


© «Битрикс», 2001-2023, «1С-Битрикс», 2023
Наверх