Class OSUINoUiSliderInterval

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

UML class diagram of OSUINoUiSliderInterval

Legend

class

abstract class

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractNoUiSlider<NoUiSliderIntervalConfig>
- OSUINoUiSliderInterval

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.equalsToID
- Defined in OSFramework/Pattern/AbstractPattern.ts:115

`Protected` triggerPlatformEventInitialized

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

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
Returns void
Inherited from AbstractNoUiSlider.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 AbstractNoUiSlider.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 AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.updateProviderEvents
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:241

`Private` createProviderInstance

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Inherited from AbstractNoUiSlider.createProviderInstance
- 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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.setInitialCSSClasses
- 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
Inherited from AbstractNoUiSlider.setInitialStates
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:159

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.unsetHtmlElements
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:181

disable

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

Memberof
Providers.RangeSlider.NoUISlider.AbstractNoUiSlider

Returns void
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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[]
Inherited from AbstractNoUiSlider.getValue
- 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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.setRangeIntervalChangeOnDragEnd
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:328

`Private` _valueChangeCallback

_valueChangeCallback(value?: number[]): void
Parameters
- Optional value: number[]
Returns void
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:12

`Protected` prepareConfigs

prepareConfigs(): void
Protected
Method that will set the provider configurations in order to properly create its instance

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval

Returns void
Overrides AbstractNoUiSlider.prepareConfigs
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:39

`Protected` redraw

redraw(): void
Protected
Redraw the pattern

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval

Returns void
Overrides AbstractNoUiSlider.redraw
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:53

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method to set the Accessibility attributes

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval

Returns void
Overrides AbstractNoUiSlider.setA11YProperties
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:69

`Protected` setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used with the provider.

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval

Returns void
Overrides AbstractNoUiSlider.setCallbacks
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:82

build

build(): void
Builds the Pattern

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval

Returns void
Overrides AbstractNoUiSlider.build
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:91

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method used to change given propertyName at OnParametersChange platform event

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Overrides AbstractNoUiSlider.changeProperty
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:110

resetValue

resetValue(): void
Method to set current RangeSliderInterval value

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval

Returns void
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:141

setValue

setValue(intervalStart: number, intervalEnd: number): void
Method to set current RangeSliderInterval values

Memberof
Providers.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Parameters
- intervalStart: number
- intervalEnd: number
Returns void
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:154

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractNoUiSlider._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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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 AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.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
Inherited from AbstractNoUiSlider.widgetId
- Defined in OSFramework/Pattern/AbstractPattern.ts:183

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Inherited from AbstractNoUiSlider.providerInfo
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:264

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Inherited from AbstractNoUiSlider.provider
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:293

Properties

`Protected` _provider

_provider: noUiSlider

`Protected` _providerInfo

_providerInfo: ProviderInfo

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`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 OSUINoUiSliderInterval(uniqueId: string, configs: JSON): OSUINoUiSliderInterval
Parameters
- uniqueId: string
- configs: JSON
Returns OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.constructor
- Defined in Providers/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:7

Class OSUINoUiSliderInterval

Hierarchy-Diagram

Legend

Hierarchy

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

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 createProviderInstance

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected setInitialCSSClasses

Memberof

Returns void

Private setInitialStates

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

disable

Memberof

Returns void

dispose

Memberof

Returns void

enable

Memberof

Returns void

getValue

Returns

Memberof

`Protected` finishBuild

`Protected` triggerPlatformEventInitialized

`Optional` saveEvent: boolean = true

`Private` createProviderInstance

`Protected` setHtmlElements

`Protected` setInitialCSSClasses

`Private` setInitialStates

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Private` _valueChangeCallback

`Optional` value: number[]

`Protected` prepareConfigs

`Protected` redraw

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` _enableAccessibility