Class AbstractNoUiSliderConfig`Abstract`

Class that represents the custom configurations received by the RangeSlider.

Export

Abstract

Hierarchy-Diagram

Legend

class

abstract class

public property

protected property

private property

public method

protected method

italic abstract property/method

Hierarchy

AbstractRangeSliderConfig
- AbstractNoUiSliderConfig
  - NoUiSliderIntervalConfig
  - 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: Orientation

ShowFloatingLabel

ShowFloatingLabel: boolean

ShowTickMarks

ShowTickMarks: boolean

Size

Size: string

StartingValueFrom

StartingValueFrom: number

StartingValueTo

StartingValueTo: number

Step

Step: number

TickMarksInterval

TickMarksInterval: number

`Private` _providerOptions

_providerOptions: Options

`Protected` _providerExtendedOptions

_providerExtendedOptions: Options

rangeSliderMode

rangeSliderMode: OSFramework.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 AbstractRangeSliderConfig.validateBoolean
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateDate
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateInRange
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateNumber
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateString
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateTime
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateCanChange
- Defined in OSFramework/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 AbstractRangeSliderConfig.mergeConfigs
- Defined in OSFramework/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 AbstractRangeSliderConfig.validateDefault
- Defined in OSFramework/Pattern/RangeSlider/AbstractRangeSliderConfig.ts:32

getPipsConfig

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

Returns
{unknown}

Memberof
Providers.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns Pips
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:26

getProviderConfig

getProviderConfig(): Options
Method to set the common configs for the provider

Returns
{NoUiSliderOptions}

Memberof
Providers.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns Options
Overrides AbstractRangeSliderConfig.getProviderConfig
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:75

getRangeConfig

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

Returns
{unknown}

Memberof
Providers.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns Range
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:96

getTooltipFormat

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

Returns
{string[]}

Memberof
Providers.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig

Returns any
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:109

setExtensibilityConfigs

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

Memberof
Providers.RangeSlider.NoUiSlider.AbstractNoUiSliderConfig
Parameters
- newConfigs: Options
Returns void
- Defined in Providers/RangeSlider/NoUISlider/AbstractNoUiSliderConfig.ts:128

Constructors

constructor

new AbstractNoUiSliderConfig(config: JSON): AbstractNoUiSliderConfig
Parameters
- config: JSON
Returns AbstractNoUiSliderConfig
Inherited from AbstractRangeSliderConfig.constructor
- Defined in OSFramework/Pattern/RangeSlider/AbstractRangeSliderConfig.ts:20

Class AbstractNoUiSliderConfigAbstract

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

Private _providerOptions

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

Class AbstractNoUiSliderConfig`Abstract`

`Private` _providerOptions

`Protected` _providerExtendedOptions

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime

`Protected` mergeConfigs

`Optional` extendedConfigs: any