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 public property in the UML class diagram public property
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

Properties

isProviderBased contentElem gradientLength progressElem progressType _blockParent _circleCircumference _circleSize _gradientElem _needsResizeObserver _resizeObserver _strokeDasharray _strokeDashoffset linearGradientCoords radialGradientCoords

Methods

finishBuild triggerPlatformEventCallback triggerPlatformInitializedEventCallback unsetGlobalCallbacks equalsToID registerCallback animateInitial animateOnValueChange updatedProgressValue resetProgressValue setProgressValue _addResizeOberser _checkResizeObserver _progressToOffset _removeResizeOberver _setCssVariables _setGradientCoords _updateCircleProps _updateProgressValue addInitialAnimation setA11YProperties setCallbacks setElementProgressValue setHtmlElements unsetCallbacks unsetHtmlElements updateProgressColor updateShape updateThickness updateTrailColor build changeProperty createSVGGradient dispose progressApplyGradient

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId

Constructors

constructor

Properties

Protected isProviderBased

isProviderBased: boolean = false

Protected contentElem

contentElem: HTMLElement

Protected gradientLength

gradientLength: number

Protected progressElem

progressElem: HTMLElement

Protected progressType

progressType: ProgressTypes

Private _blockParent

_blockParent: HTMLElement

Private _circleCircumference

_circleCircumference: number

Private _circleSize

_circleSize: number = 0

Private _gradientElem

_gradientElem: SVGDefsElement

Private _needsResizeObserver

_needsResizeObserver: boolean = true

Private _resizeObserver

_resizeObserver: ResizeObserver

Private _strokeDasharray

_strokeDasharray: number

Private _strokeDashoffset

_strokeDashoffset: number

linearGradientCoords

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

Type declaration

  • 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;
} = ...

Type declaration

Methods

Protected finishBuild

Protected triggerPlatformEventCallback

Protected triggerPlatformInitializedEventCallback

Protected unsetGlobalCallbacks

equalsToID

registerCallback

Protected animateInitial

Protected animateOnValueChange

Protected updatedProgressValue

Protected resetProgressValue

Protected setProgressValue

Private _addResizeOberser

Private _checkResizeObserver

Private _progressToOffset

Private _removeResizeOberver

Private _setCssVariables

Private _setGradientCoords

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

createSVGGradient

  • Method to create the SVG Gradient

    Memberof

    Circle

    Parameters

    • gradientId: string
    • gradientName: string
    • gradientCoords: unknown
    • gradientLenght: number
    • colors: GradientColor

    Returns void

dispose

progressApplyGradient

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

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

Constructors

constructor

Settings

Member Visibility

Theme