RMP_ProgressBar

Methods

getType() → {string}

Returns the type of the widget (RMP_ProgressBar).

Returns: string

setConfig(arrConf)

Changes the configuration of the progress bar. The new configuration is reflected dynamically in the web interface.

Parameters:

Name	Type	Description
arrConf	Array.	Step configuration as an array

Example

id_bar.setConfig([
      {"reference":1,"title":"Task1","screen":[1]},
      {"reference":2,"title":"Task2","state":"active","number":"2","screen":[2,4]},
      {"reference":3,"title":"Task3"}
]);

setNumber(reference, number)

Changes the number of the given step.

Parameters:

Name	Type	Description
reference	number	Reference of the step
number	number	New number of the step

Throws: if reference or number is not a number

setState(reference, state)

Changes the state of the given step.

Parameters:

Name	Type	Description
reference	number	Reference of the step
state	string	New state of the step: 'previous', 'active', 'hidden', or 'next'

Throws: if reference is not a number or state is not 'previous', 'active', 'hidden' or 'next'

setTitle(reference, title)

Changes the title of the given step.

Parameters:

Name	Type	Description
reference	number	Reference of the step
title	string	New title of the step

Throws: if reference is not a number, or if title is not a string

Type Definitions

RMP_ProgressBarStep

Progress bar step.

Properties:

Name	Type	Attributes	Default	Description
reference	number			Reference of the step
title	string			Title of the step
subtitle	string			Subtitle of the step
number	string			Indicator inside the circle of the step. You can ignore it, or use the auto value to have an automatic, incremental number.
state	string		"next"	State of the step: 'previous', 'active', 'hidden', or 'next'
screen	string			List of references of the manual task