Class FlatpickrTimeConfig

Class that represents the custom configurations received by the Timepicker.

Export

Hierarchy-Diagram

UML class diagram of FlatpickrTimeConfig

Legend

class

abstract class

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractTimePickerConfig
- FlatpickrTimeConfig

Properties

ExtendedClass

ExtendedClass: string

FirstWeekDay

FirstWeekDay: number

InitialTime

InitialTime: string

Is24Hours

Is24Hours: boolean

MaxTime

MaxTime: string

MinTime

MinTime: string

TimeFormat

TimeFormat: string

`Private` _lang

_lang: string

`Private` _providerOptions

_providerOptions: FlatpickrOptions

`Protected` providerExtendedOptions

providerExtendedOptions: FlatpickrOptions

AllowInput

AllowInput: boolean = false

DisableMobile

DisableMobile: boolean = false

OnChangeEventCallback

OnChangeEventCallback: Generic

OnCloseEventCallback

OnCloseEventCallback: Generic

OnOpenEventCallback

OnOpenEventCallback: Generic

ServerDateFormat

ServerDateFormat: string

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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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 AbstractTimePickerConfig.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.TimePicker.AbstractTimePickerConfig
Parameters
- key: string
  
  property name
- value: unknown
  
  value to be check
Returns unknown
Inherited from AbstractTimePickerConfig.validateDefault
- Defined in OSFramework/OSUI/Pattern/TimePicker/AbstractTimePickerConfig.ts:23

`Private` _checkAltFormat

_checkAltFormat(): string
Returns string
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTimeConfig.ts:42

`Protected` _checkLocale

_checkLocale(): CustomLocale
Method used to check the language and also map it into Flatpickr expected format

Returns
FlatpickrLocale

Memberof
Providers.OSUI.TimePicker.Flatpickr.FlatpickrTimeConfig

Returns CustomLocale
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTimeConfig.ts:59

getProviderConfig

getProviderConfig(): FlatpickrOptions
Method used to set all the config properties for the Time mode type

Returns
FlatpickrOptions

Memberof
Providers.OSUI.TimePicker.Flatpickr.FlatpickrTimeConfig

Returns FlatpickrOptions
Overrides AbstractTimePickerConfig.getProviderConfig
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTimeConfig.ts:81

setExtensibilityConfigs

setExtensibilityConfigs(newConfigs: FlatpickrOptions): void
Method to set and save the extensibility provider configs

Memberof
Providers.OSUI.TimePicker.Flatpickr.FlatpickrTimeConfig
Parameters
- newConfigs: FlatpickrOptions
Returns void
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTimeConfig.ts:113

Constructors

constructor

new FlatpickrTimeConfig(config: JSON): FlatpickrTimeConfig
Parameters
- config: JSON
Returns FlatpickrTimeConfig
Overrides AbstractTimePickerConfig.constructor
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTimeConfig.ts:34

Accessors

Lang

get Lang(): string
Getter that allows to obtain the TimePicker Locale language

Memberof
Providers.OSUI.TimePicker.Flatpickr.FlatpickrTimeConfig

Returns string
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTimeConfig.ts:124

Class FlatpickrTimeConfig

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Constructors

Accessors

Properties

ExtendedClass

FirstWeekDay

InitialTime

Is24Hours

MaxTime

MinTime

TimeFormat

Private _lang

Private _providerOptions

Protected providerExtendedOptions

AllowInput

DisableMobile

OnChangeEventCallback

OnCloseEventCallback

OnOpenEventCallback

ServerDateFormat

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

Returns

`Private` _lang

`Private` _providerOptions

`Protected` providerExtendedOptions

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime

`Protected` mergeConfigs

`Optional` extendedConfigs: any

`Private` _checkAltFormat

`Protected` _checkLocale