Class OSUINoUiSliderInterval

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractNoUiSlider<NoUiSliderIntervalConfig>
- OSUINoUiSliderInterval

Constructors

constructor

new OSUINoUiSliderInterval(
uniqueId: string,
configs: JSON,
): OSUINoUiSliderInterval
Parameters
- uniqueId: string
- configs: JSON
Returns OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.constructor
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:7

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Protected`eventProviderValueChanged

eventProviderValueChanged: Generic

`Protected`noUiSliderOpts

noUiSliderOpts: Options

`Protected`platformEventValueChange

platformEventValueChange: OSOnValueChangeEvent

`Protected`throttleTimeValue

throttleTimeValue: number = 200

`Protected`throttleTimer

throttleTimer: any = undefined

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractNoUiSlider._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Returns HTMLElement

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

isBuilt

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

Returns boolean

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

configs

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

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractNoUiSlider.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Returns string

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

widgetId

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

Returns string

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Returns ProviderInfo

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

provider

get provider(): P
Provider getter

Returns P

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

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractNoUiSlider.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected`triggerPlatformEventCallback

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

Memberof
AbstractProviderPattern
Inherited from AbstractNoUiSlider.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
Inherited from AbstractNoUiSlider.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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractNoUiSlider.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractNoUiSlider.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

checkAddedProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractNoUiSlider.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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractNoUiSlider.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
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- OptionalsaveEvent: boolean = true
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractNoUiSlider.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:262

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility
Parameters
- eventId: string
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractNoUiSlider.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
Parameters
- providerInfo: ProviderInfo
Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractNoUiSlider.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Protected`setHtmlElements

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.setHtmlElements
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:110

`Protected`setInitialCSSClasses

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.setInitialCSSClasses
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:124

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.unsetCallbacks
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:172

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the HTML elements.

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.unsetHtmlElements
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:183

disable

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.disable
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:248

dispose

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.dispose
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:257

enable

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.enable
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:273

getValue

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

Returns number | number[]
{(number | number[])}

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.getValue
- 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.
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.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
Parameters
- newConfigs: Options
Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.setProviderConfigs
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:313

setRangeIntervalChangeOnDragEnd

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.AbstractNoUiSlider
Inherited from AbstractNoUiSlider.setRangeIntervalChangeOnDragEnd
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSlider.ts:325

`Protected`prepareConfigs

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.prepareConfigs
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:39

`Protected`redraw

redraw(): void
Protected
Redraw the pattern

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.redraw
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:53

`Protected`setA11YProperties

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.setA11YProperties
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:69

`Protected`setCallbacks

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

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.setCallbacks
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:82

build

build(): void
Builds the Pattern

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.build
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:91

changeProperty

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

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
Overrides AbstractNoUiSlider.changeProperty
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:110

resetValue

resetValue(): void
Method to set current RangeSliderInterval value

Returns void

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:135

setValue

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

Memberof
Providers.OSUI.RangeSlider.NoUISlider.IntervalSlider.OSUINoUiSliderInterval
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderInterval/NoUiSliderInterval.ts:148

Class OSUINoUiSliderInterval

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSUINoUiSliderInterval

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

ProtectedeventProviderValueChanged

ProtectednoUiSliderOpts

ProtectedplatformEventValueChange

ProtectedthrottleTimeValue

ProtectedthrottleTimer

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

providerInfo

Returns ProviderInfo

Memberof

provider

Returns P

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

checkAddedProviderEvents

Returns void

Memberof

checkPendingProviderEvents

Returns void

Memberof

setProviderEvent

Parameters

Returns void

Memberof

unsetProviderEvent

Parameters

Returns void

Memberof

updateProviderEvents

Parameters

Returns void

Memberof

`Protected`isProviderBased

`Protected`providerEventsManagerInstance

`Protected`eventProviderValueChanged

`Protected`noUiSliderOpts

`Protected`platformEventValueChange

`Protected`throttleTimeValue

`Protected`throttleTimer

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setHtmlElements

`Protected`setInitialCSSClasses

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`prepareConfigs

`Protected`redraw

`Protected`setA11YProperties

`Protected`setCallbacks