Class Bar

Defines the interface for OutSystemsUI Progress Patterns

Hierarchy-Diagram

UML class diagram of Bar

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for a protected property in the UML class diagram

protected property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

icon for a private method in the UML class diagram

private method

italic abstract property/method

Hierarchy

AbstractProgress<ProgressBarConfig>
- Bar

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractProgress.finishBuild
- Defined in OSFramework/Pattern/AbstractPattern.ts:50

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Inherited from AbstractProgress.equalsToID
- Defined in OSFramework/Pattern/AbstractPattern.ts:115

`Protected` animateInitial

animateInitial(): void
Protected
Method to add the initial animation to progress

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Inherited from AbstractProgress.animateInitial
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:55

`Protected` animateOnValueChange

animateOnValueChange(): void
Protected
Method to add the animation to progress on value change

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Inherited from AbstractProgress.animateOnValueChange
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:69

`Protected` updatedProgressValue

updatedProgressValue(): void
Protected
Method to validate the value limits and apply the A11Y on progress, based on progress value

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Inherited from AbstractProgress.updatedProgressValue
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:113

`Protected` resetProgressValue

resetProgressValue(): void
Protected
Method used to reset the progress value

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Inherited from AbstractProgress.resetProgressValue
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:162

`Protected` setProgressValue

setProgressValue(value: number): void
Protected
Method used to set the progress value

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Parameters
- value: number
Returns void
Inherited from AbstractProgress.setProgressValue
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:172

`Private` _setCssVariables

_setCssVariables(): void
Returns void
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:13

`Private` _updateProgressColor

_updateProgressColor(value: string): void
Parameters
- value: string
Returns void
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:40

`Private` _updateShape

_updateShape(value: string): void
Parameters
- value: string
Returns void
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:51

`Private` _updateThickness

_updateThickness(value: number): void
Parameters
- value: number
Returns void
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:62

`Private` _updateTrailColor

_updateTrailColor(value: string): void
Parameters
- value: string
Returns void
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:73

`Protected` addInitialAnimation

addInitialAnimation(): void
Protected
Add the initial animation to the pattern if it's applicable

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.addInitialAnimation
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:89

`Protected` setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.setA11YProperties
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:105

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set callbacks

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.setCallbacks
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:115

`Protected` setElementProgressValue

setElementProgressValue(value: number): void
Protected
Add the animation on progress before applying progress value based on value change

Memberof
OSFramework.Patterns.Progress.Bar.Bar
Parameters
- value: number
Returns void
Overrides AbstractProgress.setElementProgressValue
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:125

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set HTML elements reference

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.setHtmlElements
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:141

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset callbacks

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.unsetCallbacks
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:152

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset HTML elements reference

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.unsetHtmlElements
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:162

build

build(): void
Build object, instantiating dependencies, and manipulating DOM when necessary

Memberof
OSFramework.Interface.IBuilder

Returns void
Overrides AbstractProgress.build
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:166

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Changes the value of the properties in the configurations and if changes are to a common property, applies the changes.

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Overrides AbstractProgress.changeProperty
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:185

dispose

dispose(): void
Destroy ProgressBar

Memberof
OSFramework.Patterns.Progress.Bar.Bar

Returns void
Overrides AbstractProgress.dispose
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:216

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from Progress.AbstractProgress._enableAccessibility
- Defined in OSFramework/Pattern/AbstractPattern.ts:128

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Inherited from Progress.AbstractProgress.selfElement
- Defined in OSFramework/Pattern/AbstractPattern.ts:139

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from Progress.AbstractProgress.isBuilt
- Defined in OSFramework/Pattern/AbstractPattern.ts:150

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from Progress.AbstractProgress.configs
- Defined in OSFramework/Pattern/AbstractPattern.ts:161

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Inherited from Progress.AbstractProgress.uniqueId
- Defined in OSFramework/Pattern/AbstractPattern.ts:172

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Inherited from Progress.AbstractProgress.widgetId
- Defined in OSFramework/Pattern/AbstractPattern.ts:183

Properties

`Protected` _progressElem

_progressElem: HTMLElement

`Protected` _progressType

_progressType: ProgressTypes

Constructors

constructor

new Bar(uniqueId: string, configs: any): Bar
Parameters
- uniqueId: string
- configs: any
Returns Bar
Overrides AbstractProgress.constructor
- Defined in OSFramework/Pattern/Progress/Bar/ProgressBar.ts:7