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

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

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

`Protected` `Abstract` setA11YProperties

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

`Protected` `Abstract` setCallbacks

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

`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/Pattern/AbstractProviderPattern.ts:92

`Protected` triggerPlatformEventInitialized

triggerPlatformEventInitialized(platFormCallback: OSGeneric): void
Trigger platform's InstanceIntializedHandler client Action

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
Returns void
Inherited from AbstractRangeSlider.triggerPlatformEventInitialized
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:111

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/Pattern/AbstractProviderPattern.ts:137

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/Pattern/AbstractProviderPattern.ts:151

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/Pattern/AbstractProviderPattern.ts:181

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/Pattern/AbstractProviderPattern.ts:214

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/Pattern/AbstractProviderPattern.ts:241

`Private` _setIsDisabled

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

`Private` _setOnValueChangeEvent

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

`Private` _setSize

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

`Private` _updateRangeValues

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

`Private` createProviderInstance

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

`Protected` setHtmlElements

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

`Protected` setInitialCSSClasses

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

`Private` setInitialStates

setInitialStates(): void
Private
Method to set the library options from the config

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the HTML elements.

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

build

build(): void
Builds the Pattern

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.build

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

changeProperty

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

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

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

disable

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.disable

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

dispose

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.dispose

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

enable

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Implementation of INoUiSlider.enable

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

getValue

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

Returns
{(number | number[])}

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

registerCallback

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

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

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

setProviderConfigs

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

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

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

setRangeIntervalChangeOnDragEnd

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

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

`Protected` `Abstract` prepareConfigs

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

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.Patterns.RangeSlider.AbstractRangeSlider._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
Implementation of INoUiSlider.selfElement

Inherited from OSFramework.Patterns.RangeSlider.AbstractRangeSlider.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
Implementation of INoUiSlider.isBuilt

Inherited from OSFramework.Patterns.RangeSlider.AbstractRangeSlider.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 OSFramework.Patterns.RangeSlider.AbstractRangeSlider.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
Implementation of INoUiSlider.uniqueId

Inherited from OSFramework.Patterns.RangeSlider.AbstractRangeSlider.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
Implementation of INoUiSlider.widgetId

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Implementation of INoUiSlider.providerInfo

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

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Implementation of INoUiSlider.provider

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

Properties

`Protected` _provider

_provider: noUiSlider

`Protected` _providerInfo

_providerInfo: ProviderInfo

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Private` _isInterval

_isInterval: boolean

`Private` _rangeSliderProviderElem

_rangeSliderProviderElem: HTMLElement

`Protected` eventProviderValueChanged

eventProviderValueChanged: Generic

`Protected` noUiSliderOpts

noUiSliderOpts: Options

`Protected` platformEventInitialize

platformEventInitialize: OSGeneric

`Protected` platformEventValueChange

platformEventValueChange: OSOnValueChangeEvent

`Protected` throttleTimeValue

throttleTimeValue: number = 200

`Protected` throttleTimer

throttleTimer: any = undefined

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/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:26

Class AbstractNoUiSlider<C>Abstract

Type Parameters

C extends AbstractNoUiSliderConfig

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

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

Protected triggerPlatformEventInitialized

Memberof

Parameters

platFormCallback: OSGeneric

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

Returns void

Private _setOnValueChangeEvent

Parameters

changeEvent: NoUISliderEvents

Returns void

Private _setSize

Returns void

Private _updateRangeValues

Returns void

Private createProviderInstance

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected setInitialCSSClasses

Memberof

Class AbstractNoUiSlider<C>`Abstract`

`Protected` finishBuild

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` redraw

`Protected` triggerPlatformEventInitialized

`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