Class AbstractNoUiSlider<C>`Abstract`

Defines the interface for OutSystemsUI Patterns

Type Parameters

C extends AbstractNoUiSliderConfig

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractRangeSlider<NoUiSlider, C>
- AbstractNoUiSlider
  - OSUINoUiSliderInterval
  - OSUINoUiSliderSingle

Implements

INoUiSlider

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Private` _isInterval

_isInterval: boolean

`Private` _rangeSliderProviderElem

_rangeSliderProviderElem: HTMLElement

`Protected` eventProviderValueChanged

eventProviderValueChanged: Generic

`Protected` noUiSliderOpts

noUiSliderOpts: Options

`Protected` platformEventValueChange

platformEventValueChange: OSOnValueChangeEvent

`Protected` throttleTimeValue

throttleTimeValue: number = 200

`Protected` throttleTimer

throttleTimer: any = undefined

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractRangeSlider.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

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

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractRangeSlider.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

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

Memberof
AbstractPattern

Returns void
Inherited from AbstractRangeSlider.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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractRangeSlider.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

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
Implementation of INoUiSlider.equalsToID

Inherited from AbstractRangeSlider.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected` `Abstract` setA11YProperties

setA11YProperties(): void
Returns void
Inherited from AbstractRangeSlider.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:267

`Protected` `Abstract` setCallbacks

setCallbacks(): void
Returns void
Inherited from AbstractRangeSlider.setCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:268

`Protected` redraw

redraw(): void
Protected
Method that will be responsible to redraw pattern when needed

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractRangeSlider.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

checkAddedProviderEvents

checkAddedProviderEvents(): void
Method to check for pending events to be added

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractRangeSlider.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:181

checkPendingProviderEvents

checkPendingProviderEvents(): void
Method to check for saved events to be added after a destroy/init cycle

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractRangeSlider.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:195

setProviderEvent

setProviderEvent(eventName: string, callback: Generic, uniqueId: string, saveEvent??: boolean): void
Method to add a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- Optional saveEvent: boolean = true
Returns void
Implementation of INoUiSlider.setProviderEvent

Inherited from AbstractRangeSlider.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:262

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
Implementation of INoUiSlider.unsetProviderEvent

Inherited from AbstractRangeSlider.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:295

updateProviderEvents

updateProviderEvents(providerInfo: ProviderInfo): void
Method to update the provider events API instance and save/pending events

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Implementation of INoUiSlider.updateProviderEvents

Inherited from AbstractRangeSlider.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Private` _setIsDisabled

_setIsDisabled(isDisabled: boolean): void
Parameters
- isDisabled: boolean
Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:33

`Private` _setOnValueChangeEvent

_setOnValueChangeEvent(changeEvent: NoUISliderEvents): void
Parameters
- changeEvent: NoUISliderEvents
Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:38

`Private` _setSize

_setSize(): void
Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:43

`Private` _updateRangeValues

_updateRangeValues(): void
Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:60

`Private` createProviderInstance

createProviderInstance(): void
Private
Method that will create the provider

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:76

`Protected` setHtmlElements

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

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Overrides AbstractRangeSlider.setHtmlElements
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:110

`Protected` setInitialCSSClasses

setInitialCSSClasses(): void
Protected
Method to set the initial CSS Classes

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:124

`Private` setInitialStates

setInitialStates(): void
Private
Method to set initial visual states from the configs

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:160

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Overrides AbstractRangeSlider.unsetCallbacks
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:172

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the HTML elements.

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Overrides AbstractRangeSlider.unsetHtmlElements
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:183

build

build(): void
Builds the Pattern

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.build

Overrides AbstractRangeSlider.build
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:192

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of INoUiSlider.changeProperty

Overrides AbstractRangeSlider.changeProperty
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:204

disable

disable(): void
Method to set the RangeSlider instance to disabled

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.disable

Overrides AbstractRangeSlider.disable
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:248

dispose

dispose(): void
Method to remove and destroy RangeSlider instance

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.dispose

Overrides AbstractRangeSlider.dispose
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:257

enable

enable(): void
Method to set the RangeSlider instance to enabled

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.enable

Overrides AbstractRangeSlider.enable
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:273

getValue

getValue(): number | number[]
Method to get current RangeSlider value

Returns
{(number | number[])}

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns number | number[]
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:283

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Sets the callbacks to be used to invoke the platform code.

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of INoUiSlider.registerCallback

Overrides AbstractRangeSlider.registerCallback
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:294

setProviderConfigs

setProviderConfigs(newConfigs: Options): void
Method used to set all the extended NoUiSlider properties across the different types of instances

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Parameters
- newConfigs: Options
Returns void
Implementation of INoUiSlider.setProviderConfigs

Overrides AbstractRangeSlider.setProviderConfigs
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:313

setRangeIntervalChangeOnDragEnd

setRangeIntervalChangeOnDragEnd(): void
Method to change the Range Slider trigger to on DragEnd

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Overrides AbstractRangeSlider.setRangeIntervalChangeOnDragEnd
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:325

`Protected` `Abstract` prepareConfigs

prepareConfigs(): void
Returns void
Overrides AbstractRangeSlider.prepareConfigs
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:333

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of INoUiSlider.selfElement

Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of INoUiSlider.isBuilt

Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of INoUiSlider.uniqueId

Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of INoUiSlider.widgetId

Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Implementation of INoUiSlider.providerInfo

Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:345

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Implementation of INoUiSlider.provider

Inherited from OSFramework.OSUI.Patterns.RangeSlider.AbstractRangeSlider.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:374

Constructors

constructor

new AbstractNoUiSlider<C>(uniqueId: string, configs: C): AbstractNoUiSlider<C>
Type Parameters
- C extends AbstractNoUiSliderConfig<C>
Parameters
- uniqueId: string
- configs: C
Returns AbstractNoUiSlider<C>
Overrides AbstractRangeSlider.constructor
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:25

Class AbstractNoUiSlider<C>Abstract

Type Parameters

C extends AbstractNoUiSliderConfig

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

Private _isInterval

Private _rangeSliderProviderElem

Protected eventProviderValueChanged

Protected noUiSliderOpts

Protected platformEventValueChange

Protected throttleTimeValue

Protected throttleTimer

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected Abstract setA11YProperties

Returns void

Protected Abstract setCallbacks

Returns void

Protected redraw

Memberof

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

setProviderEvent

Returns

Memberof

Parameters

eventName: string

callback: Generic

uniqueId: string

Optional saveEvent: boolean = true

Returns void

unsetProviderEvent

Returns

Memberof

Parameters

eventId: string

Returns void

updateProviderEvents

Memberof

Parameters

providerInfo: ProviderInfo

Returns void

Private _setIsDisabled

Parameters

isDisabled: boolean

Class AbstractNoUiSlider<C>`Abstract`

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Private` _isInterval

`Private` _rangeSliderProviderElem

`Protected` eventProviderValueChanged

`Protected` noUiSliderOpts

`Protected` platformEventValueChange

`Protected` throttleTimeValue

`Protected` throttleTimer

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` redraw

`Optional` saveEvent: boolean = true

`Private` _setIsDisabled

`Private` _setOnValueChangeEvent

`Private` _setSize

`Private` _updateRangeValues

`Private` createProviderInstance

`Protected` setHtmlElements

`Protected` setInitialCSSClasses

`Private` setInitialStates

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` `Abstract` prepareConfigs

`Protected` _enableAccessibility