Documentation

BX.UI.StageFlow.Stage

Description and methods

Class model for handling individual stages within [link=11307886]a sequence[/link].

BX.UI.StageFlow.Stage
Method Description Available from version
constructor(data: {}) Constructor. Not used directly. It's recommended to use the method create() for creation.

data - has the structure as follows:

  • id - stage ID;
  • name - stage name;
  • color - stage color;
  • backgroundColor - background color;
  • isFilled - flag, specifying if stage is to be filled by the main color;
  • events - list with event handlers:
    • onMouseEnter
    • onMouseLeave
    • onClick
  • isSuccess - flag specifying that stage is successful;
  • isFail - flag, specifying that stage is unsuccessful;
  • fillingColor - color for filling.
create(data: {}): Stage Method creates a new stage. Object data has the same structure, as for the constructor.

This method checks availability of some required parameters in data, and if they are unavailable, returns null.

render(): Element Renders stage and returns a DOM element.
addBackLight(color) Adds a backlight with color.
removeBackLight() Removes backlight.

Getters and setters

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


© «Bitrix24», 2001-2024