Class Circle

Defines the interface for OutSystemsUI Progress Patterns

Hierarchy (View Summary)

AbstractProgress<ProgressCircleConfig>
- Circle

Constructors

constructor

new Circle(
uniqueId: string,
configs: JSON,
): OSFramework.OSUI.Patterns.Progress.Circle.Circle
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.constructor
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:38

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`contentElem

contentElem: HTMLElement

`Protected`gradientLength

gradientLength: number

`Protected`progressElem

progressElem: HTMLElement

`Protected`progressType

progressType: ProgressTypes

linearGradientCoords

linearGradientCoords: { x1: number; x2: number; y1: number; y2: number } = ...

radialGradientCoords

radialGradientCoords: {
fr: OSFramework.OSUI.Patterns.Progress.Circle.Enum.DefaultValues;
r: OSFramework.OSUI.Patterns.Progress.Circle.Enum.DefaultValues;
} = ...

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Progress.AbstractProgress._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Progress.AbstractProgress.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Progress.AbstractProgress.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

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

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Progress.AbstractProgress.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Progress.AbstractProgress.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Progress.AbstractProgress.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractProgress.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected`triggerPlatformEventCallback

triggerPlatformEventCallback(
platFormCallback: OSGeneric,
...args: unknown[],
): void
Protected
Triggers a generic platform event.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractProgress.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Returns void

Memberof
AbstractPattern
Inherited from AbstractProgress.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected`unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractProgress.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractProgress.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Abstract`registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register a given callback event handler.
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractProgress.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

`Protected`animateInitial

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

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Inherited from AbstractProgress.animateInitial
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:57

`Protected`animateOnValueChange

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

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Inherited from AbstractProgress.animateOnValueChange
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:71

`Protected`updatedProgressValue

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

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Inherited from AbstractProgress.updatedProgressValue
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:116

`Protected`resetProgressValue

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

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Inherited from AbstractProgress.resetProgressValue
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:183

`Protected`setProgressValue

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Inherited from AbstractProgress.setProgressValue
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:193

`Protected`addInitialAnimation

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

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.addInitialAnimation
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:231

`Protected`setA11YProperties

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

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:252

`Protected`setCallbacks

setCallbacks(): void
Protected
Method to set the callbacks

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:263

`Protected`setElementProgressValue

setElementProgressValue(value: number): void
Protected
Method used to set the progrees value
Parameters
- value: number
Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.setElementProgressValue
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:273

`Protected`setHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:290

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset the callbacks

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:309

`Protected`unsetHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:319

`Protected`updateProgressColor

updateProgressColor(): void
Protected
Update progress value

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:331

`Protected`updateShape

updateShape(): void
Protected
Update shape type

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:345

`Protected`updateThickness

updateThickness(): void
Protected
Update shape thickness

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:361

`Protected`updateTrailColor

updateTrailColor(): void
Protected
Update shape color

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:377

build

build(): void
Method to build the ProgressCircle

Returns void

Memberof
Circle
Overrides AbstractProgress.build
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:390

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Update property value from a given property name at OnParametersChange
Parameters
- propertyName: string
  the name of the property that will be changed
- propertyValue: unknown
  the new value that should be assigned to the given property name
Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.changeProperty
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:413

createSVGGradient

createSVGGradient(
    gradientId: string,
    gradientName: string,
    gradientCoords: unknown,
    gradientLenght: number,
    colors: GradientColor,
): void
Method to create the SVG Gradient
Parameters
- gradientId: string
- gradientName: string
- gradientCoords: unknown
- gradientLenght: number
- colors: GradientColor
Returns void

Memberof
Circle
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:457

dispose

dispose(): void
Destroy the ProgressCircle

Returns void

Memberof
OSFramework.Patterns.Progress.Circle.Circle
Overrides AbstractProgress.dispose
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:503

progressApplyGradient

progressApplyGradient(gradientType: string, colors: GradientColor): void
Method to apply a SVG Gradient
Parameters
- gradientType: string
- colors: GradientColor
Returns void

Memberof
Circle
Overrides AbstractProgress.progressApplyGradient
- Defined in OSFramework/OSUI/Pattern/Progress/Circle/ProgressCircle.ts:523

Class Circle

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Progress.Circle.Circle

Properties

ProtectedisProviderBased

ProtectedcontentElem

ProtectedgradientLength

ProtectedprogressElem

ProtectedprogressType

linearGradientCoords

radialGradientCoords

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

AbstractregisterCallback

Parameters

Returns void

Memberof

ProtectedanimateInitial

Returns void

Memberof

ProtectedanimateOnValueChange

Returns void

Memberof

ProtectedupdatedProgressValue

Returns void

Memberof

ProtectedresetProgressValue

Returns void

Memberof

ProtectedsetProgressValue

Parameters

Returns void

Memberof

ProtectedaddInitialAnimation

Returns void

Memberof

ProtectedsetA11YProperties

`Protected`isProviderBased

`Protected`contentElem

`Protected`gradientLength

`Protected`progressElem

`Protected`progressType

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Abstract`registerCallback

`Protected`animateInitial

`Protected`animateOnValueChange

`Protected`updatedProgressValue

`Protected`resetProgressValue

`Protected`setProgressValue

`Protected`addInitialAnimation

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setElementProgressValue

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`updateProgressColor

`Protected`updateShape

`Protected`updateThickness

`Protected`updateTrailColor