Class NoUiSliderSingleConfig

Class that represents the custom configurations received by the RangeSlider.

Export

Abstract

Hierarchy-Diagram

UML class diagram of NoUiSliderSingleConfig

Legend

class

abstract class

public property

protected property

private property

public method

protected method

Hierarchy

AbstractNoUiSliderConfig
- NoUiSliderSingleConfig

Properties

ExtendedClass

ExtendedClass: string

InitialValueFrom

InitialValueFrom: number

InitialValueTo

InitialValueTo: number

IsDisabled

IsDisabled: boolean

IsInterval

IsInterval: boolean

MaxValue

MaxValue: number

MinValue

MinValue: number

Orientation

Orientation: any

ShowFloatingLabel

ShowFloatingLabel: boolean

ShowTickMarks

ShowTickMarks: boolean

Size

Size: string

StartingValueFrom

StartingValueFrom: number

StartingValueTo

StartingValueTo: number

Step

Step: number

TickMarksInterval

TickMarksInterval: number

`Protected` providerExtendedOptions

providerExtendedOptions: Options

rangeSliderMode

rangeSliderMode: OSFramework.OSUI.Patterns.RangeSlider.Enum.Mode

Methods

`Protected` validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
Inherited from AbstractNoUiSliderConfig.validateBoolean
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:31

`Protected` validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date

Returns
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
Inherited from AbstractNoUiSliderConfig.validateDate
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:44

`Protected` validateInRange

validateInRange(value: unknown, defaultValue: unknown, ...args: unknown[]): unknown
Protected
Method that helps to validate if a given value is within a range of values.

Returns
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: unknown
- defaultValue: unknown
- Rest ...args: unknown[]
Returns unknown
Inherited from AbstractNoUiSliderConfig.validateInRange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:58

`Protected` validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.

Returns
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: number
- defaultValue: number
Returns number
Inherited from AbstractNoUiSliderConfig.validateNumber
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:80

`Protected` validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.

Returns
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractNoUiSliderConfig.validateString
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:93

`Protected` validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time

Returns
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractNoUiSliderConfig.validateTime
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:106

validateCanChange

validateCanChange(_isBuilt: boolean, _key: string): boolean
Method that validates if a given property can be changed.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- _isBuilt: boolean
- _key: string
Returns boolean
Inherited from AbstractNoUiSliderConfig.validateCanChange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:119

`Protected` mergeConfigs

mergeConfigs(commonConfigs: any, specificConfigs: any, extendedConfigs?: any): any
Protected
Method to merge Common, Specific and External configs

Returns
{ProviderConfigs}

Memberof
OSFramework.Patterns.AbstractProviderConfiguration
Parameters
- commonConfigs: any
- specificConfigs: any
- Optional extendedConfigs: any
Returns any
Inherited from AbstractNoUiSliderConfig.mergeConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderConfiguration.ts:23

validateDefault

validateDefault(key: string, value: unknown): unknown
Method that will check if a given property (key) value is the type expected!

Returns
value

Memberof
OSFramework.Patterns.RangeSlider.AbstractRangeSliderConfig
Parameters
- key: string
  
  property name
- value: unknown
  
  value to be check
Returns unknown
Inherited from AbstractNoUiSliderConfig.validateDefault
- Defined in OSFramework/OSUI/Pattern/RangeSlider/AbstractRangeSliderConfig.ts:32

getPipsConfig

getPipsConfig(): Pips
Method to get the configs for the Pips option (ShowTickMarks)

Returns
{unknown}

Memberof
Providers.OSUI.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns Pips
Inherited from AbstractNoUiSliderConfig.getPipsConfig
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:27

getRangeConfig

getRangeConfig(): Range
Method to get the configs for the Range option (Min/Max values)

Returns
{unknown}

Memberof
Providers.OSUI.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns Range
Inherited from AbstractNoUiSliderConfig.getRangeConfig
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:97

getTooltipFormat

getTooltipFormat(): any
Method to get the configs for the Tooltip option (ShowFloatingLabel)

Returns
{string[]}

Memberof
Providers.OSUI.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns any
Inherited from AbstractNoUiSliderConfig.getTooltipFormat
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:110

setExtensibilityConfigs

setExtensibilityConfigs(newConfigs: Options): void
Method to validate and save the external provider configs

Memberof
Providers.OSUI.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig
Parameters
- newConfigs: Options
Returns void
Inherited from AbstractNoUiSliderConfig.setExtensibilityConfigs
- Defined in Providers/OSUI/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:129

getProviderConfig

getProviderConfig(): Options
Method to set provider configs for the Single Slider mode

Returns
{NoUiSliderOptions}

Memberof
Providers.OSUI.RangeSlider.NoUISlider.SliderSingle.NoUiSliderSingleConfig

Returns Options
Overrides AbstractNoUiSliderConfig.getProviderConfig
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderSingle/NoUiSliderSingleConfig.ts:16

Constructors

constructor

new NoUiSliderSingleConfig(config: JSON): NoUiSliderSingleConfig
Parameters
- config: JSON
Returns NoUiSliderSingleConfig
Overrides AbstractNoUiSliderConfig.constructor
- Defined in Providers/OSUI/RangeSlider/NoUISlider/SliderSingle/NoUiSliderSingleConfig.ts:4

Class NoUiSliderSingleConfig

Export

Abstract

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Constructors

Properties

ExtendedClass

InitialValueFrom

InitialValueTo

IsDisabled

IsInterval

MaxValue

MinValue

Orientation

ShowFloatingLabel

ShowTickMarks

Size

StartingValueFrom

StartingValueTo

Step

TickMarksInterval

Protected providerExtendedOptions

rangeSliderMode

Methods

Protected validateBoolean

Returns

Memberof

Parameters

value: boolean

defaultValue: boolean

Returns boolean

Protected validateDate

Returns

Memberof

Parameters

value: string | Date

defaultValue: string

Returns string | Date

Protected validateInRange

Returns

Memberof

Parameters

value: unknown

defaultValue: unknown

Rest ...args: unknown[]

Returns unknown

Protected validateNumber

Returns

Memberof

Parameters

value: number

defaultValue: number

Returns number

Protected validateString

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

Protected validateTime

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

validateCanChange

Returns

Memberof

Parameters

_isBuilt: boolean

_key: string

Returns boolean

Protected mergeConfigs

`Protected` providerExtendedOptions

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime

`Protected` mergeConfigs

`Optional` extendedConfigs: any