Class FlatpickrSingleDateConfig

Class that represents the custom configurations received by the Datepicker Single mode.

Export

Hierarchy-Diagram

UML class diagram of FlatpickrSingleDateConfig

Legend

class

abstract class

public property

protected property

private property

public method

protected method

private method

Hierarchy

AbstractFlatpickrConfig
- FlatpickrSingleDateConfig

Properties

ExtendedClass

ExtendedClass: string

DateFormat

DateFormat: string

FirstWeekDay

FirstWeekDay: number

MaxDate

MaxDate: string

MinDate

MinDate: string

ShowTodayButton

ShowTodayButton: boolean

ShowWeekNumbers

ShowWeekNumbers: boolean

TimeFormat

TimeFormat: string

`Protected` providerExtendedOptions

providerExtendedOptions: FlatpickrOptions

AllowInput

AllowInput: boolean = false

CalendarMode

CalendarMode: OSFramework.OSUI.Patterns.DatePicker.Enum.Mode

Disable

Disable: any[] = []

DisableMobile

DisableMobile: boolean = false

OnChange

OnChange: Generic

OnClose

OnClose: Generic

InitialDate

InitialDate: string | Date

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

setExtensibilityConfigs

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickrConfig
Parameters
- newConfigs: FlatpickrOptions
Returns void
Inherited from AbstractFlatpickrConfig.setExtensibilityConfigs
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickrConfig.ts:225

getProviderConfig

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

Returns
[FlatpickrOptions]

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.FlatpickrSingleDateConfig

Returns FlatpickrOptions
Overrides AbstractFlatpickrConfig.getProviderConfig
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDateConfig.ts:28

Accessors

Lang

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickrConfig

Returns string
Inherited from AbstractFlatpickrConfig.Lang
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickrConfig.ts:236

ServerDateFormat

get ServerDateFormat(): string
Get the ServerDate Format

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickrConfig

Returns string
Inherited from AbstractFlatpickrConfig.ServerDateFormat
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickrConfig.ts:257

DisabledDays

set DisabledDays(value: string[]): void
Set DisableDays

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickrConfig
Parameters
- value: string[]
Returns void
Inherited from AbstractFlatpickrConfig.DisabledDays
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickrConfig.ts:271

DisabledWeekDays

set DisabledWeekDays(value: number[]): void
Set DisableWeekDays

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickrConfig
Parameters
- value: number[]
Returns void
Inherited from AbstractFlatpickrConfig.DisabledWeekDays
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickrConfig.ts:280

Constructors

constructor

new FlatpickrSingleDateConfig(config: JSON): FlatpickrSingleDateConfig
Parameters
- config: JSON
Returns FlatpickrSingleDateConfig
Overrides AbstractFlatpickrConfig.constructor
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDateConfig.ts:16

Class FlatpickrSingleDateConfig

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Accessors

Constructors

Properties

ExtendedClass

DateFormat

FirstWeekDay

MaxDate

MinDate

ShowTodayButton

ShowWeekNumbers

TimeFormat

Protected providerExtendedOptions

AllowInput

CalendarMode

Disable

DisableMobile

OnChange

OnClose

InitialDate

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

`Protected` providerExtendedOptions

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime

`Protected` mergeConfigs

`Optional` extendedConfigs: any