CircularProgressBar Typescript API

Interface

CircularProgressBar

Progress Bar displayed as a circle.

Selector

smart-circular-progress-bar

Properties

animationAnimation

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Default valueadvanced

disabledboolean

Enables or disables the element.

Default valuefalse

formatFunctionany

A callback function defining the new format for the label of the Progress Bar.

indeterminateboolean

Sets the value of the Circular Progress bar to indeterminate state(null) and starts the animation.

Default valuefalse

invertedboolean

Sets the filling direction of the Circular Progress Bar.

Default valuefalse

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value"en

localizeFormatFunctionany

Callback, related to localization module.

maxnumber

Sets progress bars maximum possible value.

Default value100

messagesany

Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.

Default value


"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM."

}


minnumber

Sets progress bars minimum possible value.

Default value0

showProgressValueboolean

Enables/Disabled the label for the Progress Bar.

Default valuefalse

themestring

Determines the theme. Theme defines the look of the element

Default value"

unfocusableboolean

If is set to true, the element cannot be focused.

Default valuefalse

valuenumber

Sets or gets the value of the progress bar

Default value0

onchange((this: Window, ev: Event) => any) | null

This event is triggered when the value is changed.

Arguments

evEvent

Enums

Animation

None Simple Advanced