ProgressBarModel
Interface representing the ProgressBar class.
Properties
animation AnimationModel
Specifies the animation settings for the progress bar.
Default: {}
annotations ProgressAnnotationSettingsModel
Specifies the annotations for the progress bar.
Default: [{}]
cornerRadius CornerType
Specifies the corner radius of the progress bar.
Default: Auto
enablePieProgress Boolean
Specifies whether to enable the progress bar to render as a circular pie.
Default: false
enableProgressSegments Boolean
Specifies whether to enable progress bar segments.
Default: false
enableRtl Boolean
Specifies whether to render the control in right to left direction.
Default: false
enableState Boolean
Specifies whether to persist the state of the control between page loads.
Default: false
endAngle Number
Specifies the end angle of the circular progress bar.
Default: 0
gapWidth Number
Specifies the gap width between progress bar segments.
Default: null
height String
Specifies the progress bar height.
Default: null
innerRadius String
Specifies the radius of a circular progress bar.
Default: 100%
isActive Boolean
Specifies whether the progress bar is active or not.
Default: false
isGradient Boolean
Specifies whether the progress bar is a gradient.
Default: false
isIndeterminate Boolean
Specifies whether the progress bar shows as continuous progress feedback.
Default: false
isStriped Boolean
Specifies whether the progress bar is a striped.
Default: false
labelOnTrack Boolean
Specifies whether to show the label on the track.
Default: true
labelStyle FontModel
Specifies the settings for the font.
Default: {}
locale String
Specifies the culture and localization value for this control, overriding the globally defined value.
Default: en-US
margin MarginModel
Specifies the margin size.
Default: {}
maximum Number
Specifies the maximum progress value.
Default: 0
minimum Number
Specifies the minimum progress value.
Default: 0
progressColor String
Specifies the color of the progress bar.
Default: null
progressThickness Number
Specifies the thickness of the progress bar.
Default: 0
radius String
Specifies the track radius of a circular progress bar.
Default: 100$
rangeColors RangeColorModel[]
Specifies the different colors to use in the progress bar ranges.
Default: [{}]
role ModeType
Specifies the role of a linear progress bar.
Default: null
secondaryProgress Number
Specifies the value of the secondary progress bar.
Default: null
secondaryProgressColor Number
Specifies the color of the secondary progress bar. By default, it takes the primary progress bar color with half of the opacity.
Default: ""
secondaryProgressThickness Number
Specifies the thickness of the secondary progress bar. By default, it takes the primary progress bar thickness.
Default: null
segmentColor String[]
Specifies a list of colors for each progress bar segment.
Default: ""
segmentCount Number
Specifies the number of progress bar segments.
Default: 1
showProgressValue Boolean
Specifies whether to show the label on the progress bar.
Default: false
startAngle Number
Specifies the start angle of the circular progress bar.
Default: 0
theme ProgressBarTheme
Specifies the progress bar theme.
Default: Bootstrap5
tooltip TooltipSettingsModel
Specifies settings to customize the tooltip.
Default: {}
trackColor String[]
Specifies the progress bar track color.
Default: null
trackThickness Number
Specifies the progress bar track thickness.
Default: 0
type ProgressBarType
Specifies the type of progress bar.
Default: ProgressBarType
value Number
Specifies the current value of the progress bar.
Default: null
width String
Specifies the width of the progress bar in pixels or in a percentage.
Default: null
Events
animationComplete EmitType<ProgressValueEventArgs>
Event callback that is raised when an animation is completed.
created EmitType<CreatedEventArgs>
Event callback that is raised when the control has been created.
destroyed EmitType<Object>
Event callback that is raised when the control has been destroyed.
load EmitType<ProgressLoadedEventArgs>
Event callback that is raised when the progress bar starts to load.
loaded EmitType<ProgressLoadedEventArgs>
Event callback that is raised after load and before created.
mouseClick EmitType<ProgressMouseEventArgs>
Event callback that is raised when the mouse is clicked.
mouseDown EmitType<ProgressMouseEventArgs>
Event callback that is raised when the mouse button is down.
mouseLeave EmitType<ProgressMouseEventArgs>
Event callback that is raised when the mouse leaves the element.
mouseMove EmitType<ProgressMouseEventArgs>
Event callback that is raised when the mouse is moved.
mouseUp EmitType<ProgressMouseEventArgs>
Event callback that is raised when the mouse button goes up.
progressCompleted EmitType<ProgressValueEventArgs>
Event callback that is raised when the progress is completed.
textRender EmitType<ProgressTextRenderEventArgs>
Event callback that is raised when text is rendered.
tooltipRender EmitType<ProgressTooltipRenderEventArgs>
Event callback that is raised when the tooltip is rendered.
valueChanged EmitType<ProgressValueEventArgs>
Event callback that is raised when the progress bar value is changed.