Interface IFlatpickr

Defines the interface for Datepicker Pattern Based on Flatpickr provider

Hierarchy-Diagram

Legend

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

IDatePicker
IProviderPattern<Flatpickr>
- IFlatpickr

Implemented by

AbstractFlatpickr

Methods

build

build(): void
Build object, instantiating dependencies, and manipulating DOM when necessary

Memberof
OSFramework.Interface.IBuilder

Returns void
Inherited from IProviderPattern.build
- Defined in OSFramework/OSUI/Interface/IBuilder.ts:15

dispose

dispose(): void
Dispose object and free up its used resources

Memberof
OSFramework.Interface.IDisposable

Returns void
Inherited from IProviderPattern.dispose
- Defined in OSFramework/OSUI/Interface/IDisposable.ts:15

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method signature to change the properties/configs of the pattern.

Memberof
OSFramework.Interface.IPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Inherited from IProviderPattern.changeProperty
- Defined in OSFramework/OSUI/Interface/IPattern.ts:52

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Enables to register simple callbacks for the platform. Internal use.

Memberof
OSFramework.Interface.IPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Inherited from IProviderPattern.registerCallback
- Defined in OSFramework/OSUI/Interface/IPattern.ts:61

updateProviderEvents

updateProviderEvents(providerInfo: ProviderInfo): void
Method to update the provider events API instance and save/pending events

Memberof
OSFramework.Interface.IProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Inherited from IProviderPattern.updateProviderEvents
- Defined in OSFramework/OSUI/Interface/IProviderPattern.ts:42

equalsToID

equalsToID(id: string): boolean
Validates if object matched with the given id

Returns
{boolean}

Memberof
OSFramework.Interface.ISearchById
Parameters
- id: string
Returns boolean
Inherited from IProviderPattern.equalsToID
- Defined in OSFramework/OSUI/Interface/ISearchById.ts:17

clear

clear(): void
Returns void
Inherited from IDatePicker.clear
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:7

close

close(): void
Returns void
Inherited from IDatePicker.close
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:8

disableDays

disableDays(disableDays: string[]): void
Parameters
- disableDays: string[]
Returns void
Inherited from IDatePicker.disableDays
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:9

disableWeekDays

disableWeekDays(disableDays: number[]): void
Parameters
- disableDays: number[]
Returns void
Inherited from IDatePicker.disableWeekDays
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:10

onRender

onRender(): void
Returns void
Inherited from IDatePicker.onRender
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:11

open

open(): void
Returns void
Inherited from IDatePicker.open
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:12

setLanguage

setLanguage(value: string): void
Parameters
- value: string
Returns void
Inherited from IDatePicker.setLanguage
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:13

setProviderConfigs

setProviderConfigs(providerConfigs: any): void
Method to enable extensibility to provider supported configs

Memberof
OSFramework.Interface.IProviderPattern
Parameters
- providerConfigs: any
Returns void
Inherited from IProviderPattern.setProviderConfigs
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:14

setProviderEvent

setProviderEvent(eventName: string, callback: Generic, uniqueId: string): void
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
Returns void
Inherited from IDatePicker.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:15

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Parameters
- eventId: string
Returns void
Inherited from IDatePicker.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:16

updateInitialDate

updateInitialDate(date1: string, date2?: string): void
Parameters
- date1: string
- Optional date2: string
Returns void
Inherited from IDatePicker.updateInitialDate
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:17

updatePrompt

updatePrompt(promptMessage: string): void
Parameters
- promptMessage: string
Returns void
Inherited from IDatePicker.updatePrompt
- Defined in OSFramework/OSUI/Pattern/DatePicker/IDatePicker.ts:18

Properties

isBuilt

isBuilt: boolean

Indicates if the instance of the pattern is built.

Memberof

OSFramework.Interface.IPattern

selfElement

selfElement: HTMLElement

Pattern HTML element

Memberof

OSFramework.Interface.IPattern

uniqueId

uniqueId: string

Internal Id of the instance of the pattern.

Memberof

OSFramework.Interface.IPattern

widgetId

widgetId: string

External Id of the instance of the pattern

Memberof

OSFramework.Interface.IPattern

provider

provider: flatpickr

Attribute that keeps the instance of the provider of the pattern.

Memberof

OSFramework.Interface.IProviderPattern

providerInfo

providerInfo: ProviderInfo

Attribute that keeps the information about the provider version

Memberof

OSFramework.Interface.IProviderPattern

Interface IFlatpickr

Hierarchy-Diagram

Legend

Hierarchy

Implemented by

Index

Methods

Properties

Methods

build

Memberof

Returns void

dispose

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

registerCallback

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

updateProviderEvents

Memberof

Parameters

providerInfo: ProviderInfo

Returns void

equalsToID

Returns

Memberof

Parameters

id: string

Returns boolean

clear

Returns void

close

Returns void

disableDays

Parameters

disableDays: string[]

Returns void

disableWeekDays

Parameters

disableDays: number[]

Returns void

onRender

Returns void

open

Returns void

setLanguage

Parameters

value: string

Returns void

setProviderConfigs

Memberof

Parameters

providerConfigs: any

Returns void

setProviderEvent

Parameters

eventName: string

callback: Generic

uniqueId: string

Returns void

unsetProviderEvent

Parameters

eventId: string

Returns void

updateInitialDate

Parameters

date1: string

Optional date2: string

Returns void

updatePrompt

Parameters

`Optional` date2: string