ProgressBar

ProgressBar

Creates a progress bar that tracks a value compared to a potential total.

Constructor

# new ProgressBar(parent, x, y, progress, max)

Constructor
Parameters:
Name Type Description
parent HTMLElement The element to add this progress bar to.
x number The x position of the progress bar. Default 0.
y number The y position of the progress bar. Default 0.
progress number The current progress value of the progress bar. Default 0.
max number The maximum potential value of the progress bar. Default 100.
Source:
Example 
const panel = new Panel(document.body, 20, 20, 200, 200);
const pb = new ProgressBar(panel, 20, 20, 0, 100);
let progress = 0;
setInterval(() => {
  pb.progress = progress;
  progress += 0.1;
}, 100);

Extends

Classes

ProgressBar

Members

# enabled

Sets and gets whether or not this component is enabled. Non-enabled components will be faded out and not respond to events.
Overrides:
Source:

# height

Sets and gets the height of this component.
Overrides:
Source:

# max

Gets and sets the maximum value of the progress bar.
Source:

# progress

Gets and sets the progress value of the progress bar.
Source:

# width

Sets and gets the width of this component.
Overrides:
Source:

# x

Sets and gets the x position of this component.
Overrides:
Source:

# y

Sets and gets the y position of this component.
Overrides:
Source:

Methods

# getEnabled()

Gets whether the component is enabled.
Overrides:
Source:
Returns:
Whether or not the component is enabled.

# getHeight()

Gets the height of the component.
Overrides:
Source:
Returns:
The height of the component.

# getMax()

Source:
Returns:
the maximum value of the progress bar.

# getProgress()

Source:
Returns:
the current progress of the progressbar.

# getWidth()

Gets the width of the component.
Overrides:
Source:
Returns:
The width of the component.

# getX()

Gets the x position of the component.
Overrides:
Source:
Returns:
The x position of the component.

# getY()

Gets the y position of the component.
Overrides:
Source:
Returns:
The y position of the component.

# move(x, y)

Moves the component to a specified position.
Parameters:
Name Type Description
x number The new x position of the component.
y number The new y position of the component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# rotate(rad)

Rotates the component.
Parameters:
Name Type Description
rad number The number of radians to rotate the component by.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# rotateDeg(deg)

Rotates the component.
Parameters:
Name Type Description
deg number The number of degrees to rotate the component by.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setEnabled(enabled)

Sets the enabled state of this component.
Parameters:
Name Type Description
enabled boolean Whether or not the component will be enabled.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setHeight(height)

Sets the height of this component.
Parameters:
Name Type Description
height number The height of this component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setMax(max)

Sets the maximum value of this progress bar.
Parameters:
Name Type Description
max number The maximum value.
Source:
Returns:
This instance, suitable for chaining.

# setProgress(max)

Sets the current progress value of this progress bar.
Parameters:
Name Type Description
max number The current progress value.
Source:
Returns:
This instance, suitable for chaining.

# setSize(w, h)

Sizes the component.
Parameters:
Name Type Description
w number The new width of the component.
h number The new height of the component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setWidth(width)

Sets the width of this component.
Parameters:
Name Type Description
width number The width of this component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setX(x)

Sets the x position of this component.
Parameters:
Name Type Description
x number The x position of this component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setY(y)

Sets the y position of this component.
Parameters:
Name Type Description
y number The y position of this component.
Overrides:
Source:
Returns:
this instance, suitable for chaining.