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

BX.UI.StageFlow

Это расширение служит для отрисовки последовательности стадий в верхней карточке элемента.

Модель используется:

Класс для работы с последовательностью стадий:

BX.UI.StageFlow.Chart

Все цвета задаются в виде HEX (6 символов).

Методы

Метод Описание С версии
constructor(params: {}, stages: []) Конструктор.

params - параметры, имеют следующую структуру:

  • backgroundColor - цвет фона неактивной стадии;
  • currentStage - идентификатор текущей стадии;
  • isActive - булевый флаг того, может ли пользователь взаимодействовать с графиком;
  • onStageChange - колбэк, который вызывается при смене стадии;
  • labels - список подписей, имеет структуру:
    • finalStageName - название финальной стадии;
    • finalStagePopupTitle - заголовок попапа выбора финальной стадии;
    • finalStagePopupFail - заголовок попапа выбора финальной неуспешной стадии;
    • finalStageSelectorTitle - подпись у селектора выбора конкретной финальной стадии.
  • stages - массив с данными о стадиях. Каждый элемент массива должен иметь структуру:
    • id - идентификатор стадии;
    • name - название стадии;
    • isSuccess - булевый флаг того, что стадия успешна;
    • isFail - булевый флаг того, что стадия неуспешна;
    • color - цвет стадии.
setCurrentStageId(stageId: number): Chart Метод изменяет идентификатор текущей стадии и перерисовывает все стадии.
  • stageId - идентификатор стадии
getFinalStage(): ?Stage Возвращает объект финальной псевдо-стадии.
getStages(): Map Возвращает все стадии.
getFirstFailStage(): ?Stage Возвращает объект первой неуспешной стадии.
getFailStages(): Array Возвращает массив со всеми неуспешными стадиями.
getSuccessStage(): ?Stage Возвращает успешную стадию.
getStageById(id: number): ?Stag Возвращает стадию по её идентификатору id.
render(): Element Отрисовывает график стадии и возвращает DOM-элемент.
onStageMouseHover(stage: Stage) Метод вызывается при наведении мыши на стадию stage.
onStageMouseLeave(stage: Stage) Метод вызывается после перемещения курсора мыши со стадии stage.
onStageClick(stage: Stage) Метод вызывается при клике на стадию.
onFinalStageClick() Метод вызывается при клике на финальную псевдо-стадию.
addBackLightUpToStage(stageId: number|string = null, color: string = null) Метод заливает цветом color все стадии вплоть до стадии stageId включительно.
  • stageId- идентификатор стадии. Если не передан, то будет использована текущая стадия;
  • color- цвет. Если не передан, то будет взят цвет текущей стадии.
getSemanticSelectorPopup(): Popup Метод возвращает объект попапа BX.Main.Popup для выбора семантики финала.
getFinalStageSemanticSelector(isSuccess: boolean = null): Element Метод возвращает селектор выбора семантики стадии .
  • isSuccess- если true, то в селекторе будет выбрана успешная семантика, иначе - неуспешная.
getFinalStageSelectorPopup(isSuccess: boolean = false): Popup Метод возвращает объект попапа BX.Main.Popup для выбора финальной стадии.
onSemanticSelectorClick() Метод вызывается при клике на селектор выбора семантики финала.
getSelectedFinalStage(): ?Stage Метод возвращает выбранную в попапе финальную стадию.
getFailStageName(): ?string Метод возвращает название выбранной неуспешной стадии.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх