Class Circle

Defines the interface for OutSystemsUI Progress Patterns

Hierarchy-Diagram

UML class diagram of Circle
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

Methods

finishBuild equalsToID animateInitial animateOnValueChange updatedProgressValue resetProgressValue setProgressValue _addResizeOberser _checkResizeObserver _progressToOffset _setCssVariables _updateCircleProps _updateProgressValue addInitialAnimation setA11YProperties setCallbacks setElementProgressValue setHtmlElements unsetCallbacks unsetHtmlElements updateProgressColor updateShape updateThickness updateTrailColor build changeProperty dispose

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId

Properties

_progressElem _progressType _circleCircumference _circletSize _resizeObserver _strokeDasharray _strokeDashoffset

Constructors

constructor

Methods

Protected finishBuild

equalsToID

Protected animateInitial

Protected animateOnValueChange

Protected updatedProgressValue

Protected resetProgressValue

Protected setProgressValue

Private _addResizeOberser

Private _checkResizeObserver

Private _progressToOffset

Private _setCssVariables

Private _updateCircleProps

Private _updateProgressValue

Protected addInitialAnimation

Protected setA11YProperties

Protected setCallbacks

Protected setElementProgressValue

Protected setHtmlElements

Protected unsetCallbacks

Protected unsetHtmlElements

Protected updateProgressColor

Protected updateShape

Protected updateThickness

Protected updateTrailColor

build

changeProperty

  • Update property value from a given property name at OnParametersChange

    Memberof

    OSFramework.Patterns.Progress.Circle.Circle

    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

dispose

Accessors

Protected _enableAccessibility

  • get _enableAccessibility(): boolean
  • Protected

    Getter that allows to obtain the accessibility is enabled.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns boolean

selfElement

  • get selfElement(): HTMLElement

  • Getter that allows to obtain the self element.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns HTMLElement

isBuilt

  • get isBuilt(): boolean

  • Getter that tells if the pattern is already built.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns boolean

configs

  • get configs(): C

  • Current configurations/state of the pattern.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns C

uniqueId

  • get uniqueId(): string

  • Unique id of the pattern. Internal use only.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns string

widgetId

  • get widgetId(): string

  • Id of the pattern known by the developer. External use only.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns string

Properties

Protected _progressElem

_progressElem: HTMLElement

Protected _progressType

_progressType: ProgressTypes

Private _circleCircumference

_circleCircumference: number

Private _circletSize

_circletSize: number = 0

Private _resizeObserver

_resizeObserver: ResizeObserver

Private _strokeDasharray

_strokeDasharray: number

Private _strokeDashoffset

_strokeDashoffset: number

Constructors

constructor

Settings

Member Visibility

Theme