ProgressBar

23 Sep 20252 minutes to read

progress bar control

Properties

animation AnimationModel

Animation for the progress bar

cornerRadius string

corner type

Defaults to square

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl boolean

right to left

Defaults to false

endAngle number

endAngle for circular progress bar

Defaults to 0

gapWidth number

gapwidth of the segment

Defaults to 1

height string

height of the progress bar

Defaults to null

innerRadius string

progress radius for circular

Defaults to ‘100%’

isIndeterminate boolean

Indeterminate progress

Defaults to false

loaded EmitType<ILoadedEventArgs>

loaded event

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ’’

margin MarginModel

margin size

maximum number

maximum progress value

Defaults to 0

minimum number

minimum progress value

Defaults to 0

progress number

progress value

Defaults to null

progressColor string

progressColor

Defaults to null

progressCompleted EmitType<IProgressValueEventArgs>

progressCompleted event

radius string

track radius for circular

Defaults to ‘100%’

secondaryProgress number

secondary progress value

Defaults to null

segmentColor string[]

Segment color

Defaults to null

segmentCount number

segmentCount of the progress bar

Defaults to 1

startAngle number

startAngle for circular progress bar

Defaults to 0

theme string

theme style

Defaults to Fabric

thickness number

thickness of the circle

Defaults to 10

trackColor string

trackColor

Defaults to null

type string

type of the progress bar

Defaults to Linear

valueChanged EmitType<IProgressValueEventArgs>

valueChanged event

width string

width of the progress bar

Defaults to null

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

appendTo

Appends the control within the given HTML element

Parameter	Type	Description
selector (optional)	string | HTMLElement	Target element where control needs to be appended

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

To destroy the widget

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void