Options
All
  • Public
  • Public/Protected
  • All
Menu

Module node_modules/@fullcalendar/common/main

Index

References

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

References

renderMicroColGroup

Renames and exports __type

Type aliases

Action

Action: { type: "NOTHING" } | { optionName: string; rawOptionValue: any; type: "SET_OPTION" } | { type: "PREV" } | { type: "NEXT" } | { dateMarker: DateMarker; type: "CHANGE_DATE" } | { dateMarker?: DateMarker; type: "CHANGE_VIEW_TYPE"; viewType: string } | { selection: DateSpan; type: "SELECT_DATES" } | { type: "UNSELECT_DATES" } | { eventInstanceId: string; type: "SELECT_EVENT" } | { type: "UNSELECT_EVENT" } | { state: EventInteractionState; type: "SET_EVENT_DRAG" } | { type: "UNSET_EVENT_DRAG" } | { state: EventInteractionState; type: "SET_EVENT_RESIZE" } | { type: "UNSET_EVENT_RESIZE" } | { sources: EventSource<any>[]; type: "ADD_EVENT_SOURCES" } | { sourceId: string; type: "REMOVE_EVENT_SOURCE" } | { type: "REMOVE_ALL_EVENT_SOURCES" } | { sourceIds?: string[]; type: "FETCH_EVENT_SOURCES" } | { fetchId: string; fetchRange: DateRange | null; rawEvents: EventInput[]; sourceId: string; type: "RECEIVE_EVENTS" } | { error: EventSourceError; fetchId: string; fetchRange: DateRange | null; sourceId: string; type: "RECEIVE_EVENT_ERROR" } | { eventStore: EventStore; type: "ADD_EVENTS" } | { eventStore: EventStore; type: "RESET_EVENTS" } | { eventStore: EventStore; type: "MERGE_EVENTS" } | { eventStore: EventStore; type: "REMOVE_EVENTS" } | { type: "REMOVE_ALL_EVENTS" }

AllDayMountArg

AllDayMountArg: MountArg<AllDayContentArg>

AllowFunc

AllowFunc: (span: DateSpanApi, movingEvent: EventApi | null) => boolean

Type declaration

BaseOptionsRefined

BaseOptionsRefined: DefaultedRefinedOptions<RefinedOptionsFromRefiners<Required<BaseOptionRefiners>>, keyof typeof BASE_OPTION_DEFAULTS>

BusinessHoursInput

BusinessHoursInput: boolean | EventInput | EventInput[]

CalendarListeners

CalendarListeners: Required<CalendarListenersLoose>

CalendarOptions

CalendarOptions: BaseOptions & CalendarListenersLoose & RawOptionsFromRefiners<Required<CalendarOptionRefiners>>

CalendarOptionsRefined

CalendarOptionsRefined: BaseOptionsRefined & CalendarListenersLoose & RefinedOptionsFromRefiners<Required<CalendarOptionRefiners>>

ChunkConfigContent

ChunkConfigContent: (contentProps: ChunkContentCallbackArgs) => VNode

Type declaration

ChunkConfigRowContent

ChunkConfigRowContent: VNode | ChunkConfigContent

ClassNamesGenerator

ClassNamesGenerator<HookProps>: ClassNamesInput | ((hookProps: HookProps) => ClassNamesInput)

Type parameters

  • HookProps

ComponentChild

ComponentChild: VNode<any> | object | string | number | boolean | null | undefined

ComponentChildren

ComponentChildren: ComponentChild[] | ComponentChild

ComponentType

ComponentType<P>: ComponentClass<P> | FunctionComponent<P>

Type parameters

  • P = {}

Constraint

Constraint: "businessHours" | string | EventStore | false

ConstraintInput

ConstraintInput: "businessHours" | string | EventInput | EventInput[]

CssDimValue

CssDimValue: string | number

CustomContentGenerator

CustomContentGenerator<HookProps>: CustomContent | ((hookProps: HookProps) => CustomContent)

Type parameters

  • HookProps

DateInput

DateInput: Date | string | number | number[]

DateMarker

DateMarker: Date

DatePointTransform

DatePointTransform: (dateSpan: DateSpan, context: CalendarContext) => any

Type declaration

DateSpanTransform

DateSpanTransform: (dateSpan: DateSpan, context: CalendarContext) => any

Type declaration

DatesSetArg

DatesSetArg: RangeApiWithTimeZone & { view: ViewApi }

DayCellMountArg

DayCellMountArg: MountArg<DayCellContentArg>

DayHeaderMountArg

DayHeaderMountArg: MountArg<DayHeaderContentArg>

Dictionary

Dictionary: Record<string, any>

DidMountHandler

DidMountHandler<TheMountArg>: (mountArg: TheMountArg) => void

Type parameters

Type declaration

    • (mountArg: TheMountArg): void
    • Parameters

      • mountArg: TheMountArg

      Returns void

DragMetaInput

DragMetaInput: RawOptionsFromRefiners<typeof DRAG_META_REFINERS> & {}

DurationInput

DurationInput: DurationObjectInput | string | number

EventDefHash

EventDefHash: {}

Type declaration

EventDropTransformers

EventDropTransformers: (mutation: EventMutation, context: CalendarContext) => Dictionary

Type declaration

EventInput

EventInput: EventUiInput & RawOptionsFromRefiners<Required<EventRefiners>> & {}

EventInputTransformer

EventInputTransformer: (input: EventInput) => EventInput

Type declaration

EventInstanceHash

EventInstanceHash: {}

Type declaration

EventMountArg

EventMountArg: MountArg<EventContentArg>

EventRefined

EventRefined: EventUiRefined & RefinedOptionsFromRefiners<Required<EventRefiners>>

EventResizeJoinTransforms

EventResizeJoinTransforms: (hit0: Hit, hit1: Hit) => false | Dictionary

Type declaration

EventSourceFunc

EventSourceFunc: (arg: { end: Date; endStr: string; start: Date; startStr: string; timeZone: string }, successCallback: (events: EventInput[]) => void, failureCallback: (error: EventSourceError) => void) => void | PromiseLike<EventInput[]>

Type declaration

    • (arg: { end: Date; endStr: string; start: Date; startStr: string; timeZone: string }, successCallback: (events: EventInput[]) => void, failureCallback: (error: EventSourceError) => void): void | PromiseLike<EventInput[]>
    • Parameters

      • arg: { end: Date; endStr: string; start: Date; startStr: string; timeZone: string }
        • end: Date
        • endStr: string
        • start: Date
        • startStr: string
        • timeZone: string
      • successCallback: (events: EventInput[]) => void
      • failureCallback: (error: EventSourceError) => void
          • (error: EventSourceError): void
          • Parameters

            • error: EventSourceError

            Returns void

      Returns void | PromiseLike<EventInput[]>

EventSourceHash

EventSourceHash: {}

Type declaration

EventSourceInput

EventSourceInput: EventSourceInputObject | EventInput[] | EventSourceFunc | string

EventSourceRefined

EventSourceRefined: EventUiRefined & RefinedOptionsFromRefiners<Required<EventSourceRefiners>>

EventUiHash

EventUiHash: {}

Type declaration

FormatterInput

FormatterInput: NativeFormatterOptions | string | FuncFormatterFunc

Identity

Identity<T>: (raw: T) => T

Type parameters

  • T = any

Type declaration

    • (raw: T): T
    • Parameters

      • raw: T

      Returns T

InteractionSettingsStore

InteractionSettingsStore: {}

Type declaration

LocaleSingularArg

LocaleSingularArg: LocaleCodeArg | LocaleInput

MountArg

MountArg<ContentArg>: ContentArg & { el: HTMLElement }

Type parameters

  • ContentArg

NowIndicatorMountArg

NowIndicatorMountArg: MountArg<NowIndicatorContentArg>

OverflowValue

OverflowValue: "auto" | "hidden" | "scroll" | "visible"

OverlapFunc

OverlapFunc: (stillEvent: EventApi, movingEvent: EventApi | null) => boolean

Type declaration

RawOptionsFromRefiners

RawOptionsFromRefiners<Refiners>: {[ Prop in keyof Refiners]: Refiners[Prop] extends (input: infer RawType) => infer RefinedType ? any extends RawType ? RefinedType : RawType : never }

Type parameters

  • Refiners: GenericRefiners

Ref

Ref<T>: RefObject<T> | RefCallback<T>

Type parameters

  • T

RefObject

RefObject<T>: { current?: T | null }

Type parameters

  • T

Type declaration

  • Optional current?: T | null

RefinedOptionsFromRefiners

RefinedOptionsFromRefiners<Refiners>: {[ Prop in keyof Refiners]: Refiners[Prop] extends (input: any) => infer RefinedType ? RefinedType : never }

Type parameters

  • Refiners: GenericRefiners

RenderHookPropsChildren

RenderHookPropsChildren: (rootElRef: Ref<any>, classNames: string[], innerElRef: Ref<any>, innerContent: ComponentChildren) => ComponentChildren

Type declaration

ScrollGridImpl

ScrollGridImpl: {}

Type declaration

SlotLabelMountArg

SlotLabelMountArg: MountArg<SlotLabelContentArg>

SlotLaneMountArg

SlotLaneMountArg: MountArg<SlotLaneContentArg>

SpecificViewMountArg

SpecificViewMountArg: MountArg<SpecificViewContentArg>

VNode

VNode: preact.VNode<any>

VUIEvent

VUIEvent: UIEvent

ViewComponentType

ViewComponentType: ComponentType<ViewProps>

ViewContainerAppend

ViewContainerAppend: (context: CalendarContext) => ComponentChildren

Type declaration

ViewMountArg

ViewMountArg: MountArg<ViewContentArg>

ViewOptionsRefined

ViewOptionsRefined: BaseOptionsRefined & CalendarListenersLoose & RefinedOptionsFromRefiners<Required<ViewOptionRefiners>>

WeekNumberCalculation

WeekNumberCalculation: "local" | "ISO" | ((m: Date) => number)

WeekNumberMountArg

WeekNumberMountArg: MountArg<WeekNumberContentArg>

WillUnmountHandler

WillUnmountHandler<TheMountArg>: (mountArg: TheMountArg) => void

Type parameters

Type declaration

    • (mountArg: TheMountArg): void
    • Parameters

      • mountArg: TheMountArg

      Returns void

dateSelectionJoinTransformer

dateSelectionJoinTransformer: (hit0: Hit, hit1: Hit) => any

Type declaration

    • Parameters

      Returns any

eventDragMutationMassager

eventDragMutationMassager: (mutation: EventMutation, hit0: Hit, hit1: Hit) => void

Type declaration

Variables

Const BASE_OPTION_DEFAULTS

BASE_OPTION_DEFAULTS: { allDayMaintainDuration: boolean; aspectRatio: number; dayHeaders: boolean; dayPopoverFormat: { day: string; month: string; year: string }; defaultAllDayEventDuration: { day: number }; defaultRangeSeparator: string; defaultTimedEventDuration: string; dragRevertDuration: number; dragScroll: boolean; dropAccept: string; editable: boolean; endParam: string; eventDisplay: string; eventDragMinDistance: number; eventOrder: string; expandRows: boolean; forceEventDuration: boolean; handleWindowResize: boolean; headerToolbar: { center: string; end: string; start: string }; initialView: string; lazyFetching: boolean; locale: string; locales: any[]; longPressDelay: number; navLinks: boolean; nextDayThreshold: string; nowIndicator: boolean; scrollTime: string; selectable: boolean; showNonCurrentDates: boolean; slotMaxTime: string; slotMinTime: string; startParam: string; themeSystem: string; timeZone: string; timeZoneParam: string; titleRangeSeparator: string; unselectAuto: boolean; weekNumberCalculation: WeekNumberCalculation; weekNumbers: boolean; weekends: boolean; windowResizeDelay: number }

Type declaration

  • allDayMaintainDuration: boolean
  • aspectRatio: number
  • dayHeaders: boolean
  • dayPopoverFormat: { day: string; month: string; year: string }
    • day: string
    • month: string
    • year: string
  • defaultAllDayEventDuration: { day: number }
    • day: number
  • defaultRangeSeparator: string
  • defaultTimedEventDuration: string
  • dragRevertDuration: number
  • dragScroll: boolean
  • dropAccept: string
  • editable: boolean
  • endParam: string
  • eventDisplay: string
  • eventDragMinDistance: number
  • eventOrder: string
  • expandRows: boolean
  • forceEventDuration: boolean
  • handleWindowResize: boolean
  • headerToolbar: { center: string; end: string; start: string }
    • center: string
    • end: string
    • start: string
  • initialView: string
  • lazyFetching: boolean
  • locale: string
  • locales: any[]
  • longPressDelay: number
  • navLinks: boolean
  • nextDayThreshold: string
  • nowIndicator: boolean
  • scrollTime: string
  • selectable: boolean
  • showNonCurrentDates: boolean
  • slotMaxTime: string
  • slotMinTime: string
  • startParam: string
  • themeSystem: string
  • timeZone: string
  • timeZoneParam: string
  • titleRangeSeparator: string
  • unselectAuto: boolean
  • weekNumberCalculation: WeekNumberCalculation
  • weekNumbers: boolean
  • weekends: boolean
  • windowResizeDelay: number

Const BASE_OPTION_REFINERS

BASE_OPTION_REFINERS: { allDayClassNames: Identity<ClassNamesGenerator<AllDayContentArg>>; allDayContent: Identity<CustomContentGenerator<AllDayContentArg>>; allDayDidMount: Identity<DidMountHandler<MountArg<AllDayContentArg>>>; allDayMaintainDuration: BooleanConstructor; allDayText: StringConstructor; allDayWillUnmount: Identity<WillUnmountHandler<MountArg<AllDayContentArg>>>; aspectRatio: NumberConstructor; bootstrapFontAwesome: Identity<false | ButtonIconsInput>; businessHours: Identity<BusinessHoursInput>; buttonIcons: Identity<false | ButtonIconsInput>; contentHeight: Identity<string | number>; customButtons: Identity<{}>; dateAlignment: StringConstructor; dateIncrement: typeof createDuration; dayCellClassNames: Identity<ClassNamesGenerator<DayCellContentArg>>; dayCellContent: Identity<CustomContentGenerator<DayCellContentArg>>; dayCellDidMount: Identity<DidMountHandler<MountArg<DayCellContentArg>>>; dayCellWillUnmount: Identity<WillUnmountHandler<MountArg<DayCellContentArg>>>; dayCount: NumberConstructor; dayHeaderClassNames: Identity<ClassNamesGenerator<DayHeaderContentArg>>; dayHeaderContent: Identity<CustomContentGenerator<DayHeaderContentArg>>; dayHeaderDidMount: Identity<DidMountHandler<MountArg<DayHeaderContentArg>>>; dayHeaderFormat: typeof createFormatter; dayHeaderWillUnmount: Identity<WillUnmountHandler<MountArg<DayHeaderContentArg>>>; dayHeaders: BooleanConstructor; dayMaxEventRows: Identity<number | boolean>; dayMaxEvents: Identity<number | boolean>; dayMinWidth: NumberConstructor; dayPopoverFormat: typeof createFormatter; defaultAllDay: BooleanConstructor; defaultAllDayEventDuration: typeof createDuration; defaultRangeSeparator: StringConstructor; defaultTimedEventDuration: typeof createDuration; direction: Identity<"ltr" | "rtl">; displayEventEnd: BooleanConstructor; displayEventTime: BooleanConstructor; dragRevertDuration: NumberConstructor; dragScroll: BooleanConstructor; dropAccept: Identity<string | ((this: CalendarApi, draggable: any) => boolean)>; droppable: BooleanConstructor; duration: typeof createDuration; editable: BooleanConstructor; endParam: StringConstructor; eventAllow: Identity<AllowFunc>; eventBackgroundColor: StringConstructor; eventBorderColor: StringConstructor; eventClassNames: Identity<ClassNamesGenerator<EventContentArg>>; eventColor: StringConstructor; eventConstraint: Identity<ConstraintInput>; eventContent: Identity<CustomContentGenerator<EventContentArg>>; eventDataTransform: Identity<EventInputTransformer>; eventDidMount: Identity<DidMountHandler<MountArg<EventContentArg>>>; eventDisplay: StringConstructor; eventDragMinDistance: NumberConstructor; eventDurationEditable: BooleanConstructor; eventLongPressDelay: NumberConstructor; eventMinHeight: NumberConstructor; eventOrder: typeof parseFieldSpecs; eventOverlap: Identity<boolean | OverlapFunc>; eventResizableFromStart: BooleanConstructor; eventSourceFailure: Identity<(this: CalendarApi, error: any) => void>; eventSourceSuccess: Identity<(this: CalendarApi, eventsInput: EventInput[], xhr?: XMLHttpRequest) => EventInput[] | void>; eventStartEditable: BooleanConstructor; eventTextColor: StringConstructor; eventTimeFormat: typeof createFormatter; eventWillUnmount: Identity<WillUnmountHandler<MountArg<EventContentArg>>>; expandRows: BooleanConstructor; firstDay: NumberConstructor; fixedWeekCount: BooleanConstructor; footerToolbar: Identity<false | ToolbarInput>; forceEventDuration: BooleanConstructor; handleWindowResize: BooleanConstructor; headerToolbar: Identity<false | ToolbarInput>; height: Identity<string | number>; hiddenDays: Identity<number[]>; initialDate: Identity<DateInput>; initialView: StringConstructor; lazyFetching: BooleanConstructor; locale: Identity<LocaleSingularArg>; locales: Identity<LocaleInput[]>; longPressDelay: NumberConstructor; monthMode: BooleanConstructor; moreLinkText: Identity<string | ((this: CalendarApi, num: number) => string)>; navLinkDayClick: Identity<string | ((this: CalendarApi, date: Date, jsEvent: VUIEvent) => void)>; navLinkWeekClick: Identity<string | ((this: CalendarApi, weekStart: Date, jsEvent: VUIEvent) => void)>; navLinks: BooleanConstructor; nextDayThreshold: typeof createDuration; noEventsText: StringConstructor; now: Identity<string | number | Date | number[] | ((this: CalendarApi) => DateInput)>; nowIndicator: BooleanConstructor; nowIndicatorClassNames: Identity<ClassNamesGenerator<NowIndicatorContentArg>>; nowIndicatorContent: Identity<CustomContentGenerator<NowIndicatorContentArg>>; nowIndicatorDidMount: Identity<DidMountHandler<MountArg<NowIndicatorContentArg>>>; nowIndicatorWillUnmount: Identity<WillUnmountHandler<MountArg<NowIndicatorContentArg>>>; plugins: Identity<PluginDef[]>; progressiveEventRendering: BooleanConstructor; rerenderDelay: NumberConstructor; scrollTime: typeof createDuration; selectAllow: Identity<AllowFunc>; selectConstraint: Identity<ConstraintInput>; selectLongPressDelay: NumberConstructor; selectMinDistance: NumberConstructor; selectMirror: BooleanConstructor; selectOverlap: Identity<boolean | OverlapFunc>; selectable: BooleanConstructor; showNonCurrentDates: BooleanConstructor; slotDuration: typeof createDuration; slotEventOverlap: BooleanConstructor; slotLabelClassNames: Identity<ClassNamesGenerator<SlotLabelContentArg>>; slotLabelContent: Identity<CustomContentGenerator<SlotLabelContentArg>>; slotLabelDidMount: Identity<DidMountHandler<MountArg<SlotLabelContentArg>>>; slotLabelFormat: Identity<string | NativeFormatterOptions | FuncFormatterFunc | FormatterInput[]>; slotLabelInterval: typeof createDuration; slotLabelWillUnmount: Identity<WillUnmountHandler<MountArg<SlotLabelContentArg>>>; slotLaneClassNames: Identity<ClassNamesGenerator<SlotLaneContentArg>>; slotLaneContent: Identity<CustomContentGenerator<SlotLaneContentArg>>; slotLaneDidMount: Identity<DidMountHandler<MountArg<SlotLaneContentArg>>>; slotLaneWillUnmount: Identity<WillUnmountHandler<MountArg<SlotLaneContentArg>>>; slotMaxTime: typeof createDuration; slotMinTime: typeof createDuration; slotMinWidth: NumberConstructor; snapDuration: typeof createDuration; startParam: StringConstructor; stickyFooterScrollbar: Identity<boolean | "auto">; stickyHeaderDates: Identity<boolean | "auto">; themeSystem: Identity<string>; timeZone: StringConstructor; timeZoneParam: StringConstructor; titleFormat: Identity<FormatterInput>; titleRangeSeparator: StringConstructor; unselectAuto: BooleanConstructor; unselectCancel: StringConstructor; validRange: Identity<DateRangeInput | ((this: CalendarApi, nowDate: Date) => DateRangeInput)>; viewClassNames: Identity<ClassNamesGenerator<ViewContentArg>>; viewDidMount: Identity<DidMountHandler<MountArg<ViewContentArg>>>; viewHeight: Identity<string | number>; viewWillUnmount: Identity<WillUnmountHandler<MountArg<ViewContentArg>>>; visibleRange: Identity<DateRangeInput | ((this: CalendarApi, currentDate: Date) => DateRangeInput)>; weekNumberCalculation: Identity<WeekNumberCalculation>; weekNumberClassNames: Identity<ClassNamesGenerator<WeekNumberContentArg>>; weekNumberContent: Identity<CustomContentGenerator<WeekNumberContentArg>>; weekNumberDidMount: Identity<DidMountHandler<MountArg<WeekNumberContentArg>>>; weekNumberFormat: typeof createFormatter; weekNumberWillUnmount: Identity<WillUnmountHandler<MountArg<WeekNumberContentArg>>>; weekNumbers: BooleanConstructor; weekText: StringConstructor; weekends: BooleanConstructor; windowResizeDelay: NumberConstructor }

Type declaration

Const CustomContentRenderContext

CustomContentRenderContext: Context<number>

Const Fragment

Fragment: ComponentClass<{}, {}>

Const ViewContextType

ViewContextType: Context<any>

Const config

config: any

Const globalLocales

globalLocales: LocaleInput[]

Const globalPlugins

globalPlugins: PluginDef[]

Const interactionSettingsStore

interactionSettingsStore: InteractionSettingsStore

Const version

version: string

Functions

Const BgEvent

ContentHook

  • ContentHook<HookProps>(props: ContentHookProps<HookProps>): Element
  • Type parameters

    • HookProps

    Parameters

    • props: ContentHookProps<HookProps>

    Returns Element

Const NowIndicatorRoot

Const WeekNumberRoot

addDays

addDurations

  • addDurations(d0: Duration, d1: Duration): { days: number; milliseconds: number; months: number; years: number }
  • Parameters

    Returns { days: number; milliseconds: number; months: number; years: number }

    • days: number
    • milliseconds: number
    • months: number
    • years: number

addMs

addWeeks

allowContextMenu

allowSelection

applyMutationToEventStore

applyStyle

applyStyleProp

  • applyStyleProp(el: HTMLElement, name: string, val: any): void
  • Parameters

    Returns void

asCleanDays

  • Parameters

    Returns number

asRoughMinutes

  • Parameters

    Returns number

asRoughMs

  • Parameters

    Returns number

asRoughSeconds

  • Parameters

    Returns number

buildClassNameNormalizer

  • buildClassNameNormalizer<HookProps>(): (generator: ClassNamesGenerator<HookProps>, hookProps: HookProps) => string[]

buildEventApis

buildEventRangeKey

buildHashFromArray

  • buildHashFromArray<Item, ItemRes>(a: Item[], func: (item: Item, index: number) => [string, ItemRes]): {}
  • Type parameters

    • Item

    • ItemRes

    Parameters

    • a: Item[]
    • func: (item: Item, index: number) => [string, ItemRes]
        • (item: Item, index: number): [string, ItemRes]
        • Parameters

          • item: Item
          • index: number

          Returns [string, ItemRes]

    Returns {}

    • [key: string]: ItemRes

buildNavLinkData

  • buildNavLinkData(date: DateMarker, type?: string): string
  • Parameters

    Returns string

buildSegCompareObj

  • buildSegCompareObj(seg: Seg): { _seg: Seg; allDay: number; defId: string; duration: number; end: number; extendedProps: Record<string, any>; groupId: string; hasEnd: boolean; id: string; publicId: string; recurringDef: { duration: Duration; typeData: any; typeId: number }; sourceId: string; start: number; title: string; ui: EventUi; url: string }
  • Parameters

    Returns { _seg: Seg; allDay: number; defId: string; duration: number; end: number; extendedProps: Record<string, any>; groupId: string; hasEnd: boolean; id: string; publicId: string; recurringDef: { duration: Duration; typeData: any; typeId: number }; sourceId: string; start: number; title: string; ui: EventUi; url: string }

    • _seg: Seg
    • allDay: number
    • defId: string
    • duration: number
    • end: number
    • extendedProps: Record<string, any>
    • groupId: string
    • hasEnd: boolean
    • id: string
    • publicId: string
    • recurringDef: { duration: Duration; typeData: any; typeId: number }
      • duration: Duration
      • typeData: any
      • typeId: number
    • sourceId: string
    • start: number
    • title: string
    • ui: EventUi
    • url: string

buildSegTimeText

collectFromHash

  • collectFromHash<Item>(hash: {}, startIndex?: number, endIndex?: number, step?: number): Item[]
  • Type parameters

    • Item

    Parameters

    • hash: {}
      • [key: string]: Item
    • Optional startIndex: number
    • Optional endIndex: number
    • Optional step: number

    Returns Item[]

combineEventUis

compareByFieldSpec

  • compareByFieldSpec<Subject>(obj0: Subject, obj1: Subject, fieldSpec: OrderSpec<Subject>): number
  • Type parameters

    • Subject

    Parameters

    • obj0: Subject
    • obj1: Subject
    • fieldSpec: OrderSpec<Subject>

    Returns number

compareByFieldSpecs

  • compareByFieldSpecs<Subject>(obj0: Subject, obj1: Subject, fieldSpecs: OrderSpec<Subject>[]): number
  • Type parameters

    • Subject

    Parameters

    • obj0: Subject
    • obj1: Subject
    • fieldSpecs: OrderSpec<Subject>[]

    Returns number

compareNumbers

  • compareNumbers(a: any, b: any): number
  • Parameters

    • a: any
    • b: any

    Returns number

compareObjs

  • compareObjs(oldProps: any, newProps: any, equalityFuncs?: EqualityFuncs<any>): boolean
  • Parameters

    • oldProps: any
    • newProps: any
    • Optional equalityFuncs: EqualityFuncs<any>

    Returns boolean

computeEdges

  • computeEdges(el: HTMLElement, getPadding?: boolean): EdgeInfo
  • Parameters

    Returns EdgeInfo

computeFallbackHeaderFormat

  • computeFallbackHeaderFormat(datesRepDistinctDays: boolean, dayCnt: number): DateFormatter
  • Parameters

    • datesRepDistinctDays: boolean
    • dayCnt: number

    Returns DateFormatter

computeHeightAndMargins

computeInnerRect

  • computeInnerRect(el: any, goWithinPadding?: boolean, doFromWindowViewport?: boolean): { bottom: number; left: any; right: number; top: any }
  • Parameters

    • el: any
    • Optional goWithinPadding: boolean
    • Optional doFromWindowViewport: boolean

    Returns { bottom: number; left: any; right: number; top: any }

    • bottom: number
    • left: any
    • right: number
    • top: any

computeRect

  • computeRect(el: any): Rect
  • Parameters

    • el: any

    Returns Rect

computeSegDraggable

computeSegEndResizable

computeSegStartResizable

computeShrinkWidth

computeSmallestCellWidth

  • computeSmallestCellWidth(cellEl: HTMLElement): number

computeVisibleDayRange

  • computeVisibleDayRange(timedRange: OpenDateRange, nextDayThreshold?: Duration): OpenDateRange
  • Parameters

    • timedRange: OpenDateRange
    • Optional nextDayThreshold: Duration

    Returns OpenDateRange

constrainPoint

createContext

  • createContext<T>(defaultValue: T): Context<T>
  • Type parameters

    • T

    Parameters

    • defaultValue: T

    Returns Context<T>

createDuration

createElement

createEmptyEventStore

createEventInstance

  • createEventInstance(defId: string, range: DateRange, forcedStartTzo?: number, forcedEndTzo?: number): EventInstance
  • Parameters

    • defId: string
    • range: DateRange
    • Optional forcedStartTzo: number
    • Optional forcedEndTzo: number

    Returns EventInstance

createEventUi

createFormatter

createPlugin

createRef

  • Type parameters

    • T = any

    Returns RefObject<T>

diffDates

diffDayAndTime

diffDays

  • diffDays(m0: any, m1: any): number
  • Parameters

    • m0: any
    • m1: any

    Returns number

diffPoints

diffWeeks

  • diffWeeks(m0: any, m1: any): number
  • Parameters

    • m0: any
    • m1: any

    Returns number

diffWholeDays

diffWholeWeeks

disableCursor

  • disableCursor(): void
  • Returns void

elementClosest

elementMatches

enableCursor

  • enableCursor(): void
  • Returns void

eventTupleToStore

filterEventStoreDefs

filterHash

  • filterHash(hash: any, func: any): {}
  • Parameters

    • hash: any
    • func: any

    Returns {}

findDirectChildren

findElements

flexibleCompare

  • flexibleCompare(a: any, b: any): number
  • Parameters

    • a: any
    • b: any

    Returns number

flushToDom

  • flushToDom(): void
  • Returns void

formatDate

formatDayString

formatIsoTimeString

formatRange

getAllowYScrolling

  • getAllowYScrolling(props: { liquid: boolean }, sectionConfig: SectionConfig): boolean
  • Parameters

    • props: { liquid: boolean }
      • liquid: boolean
    • sectionConfig: SectionConfig

    Returns boolean

getCanVGrowWithinCell

  • getCanVGrowWithinCell(): boolean
  • Returns boolean

getClippingParents

getDateMeta

getDayClassNames

getDefaultEventEnd

getElSeg

getEventClassNames

getIsRtlScrollbarOnLeft

  • getIsRtlScrollbarOnLeft(): boolean
  • Returns boolean

getRectCenter

getRelevantEvents

getScrollGridClassNames

  • getScrollGridClassNames(liquid: boolean, context: ViewContext): any[]
  • Parameters

    Returns any[]

getScrollbarWidths

  • getScrollbarWidths(): ScrollbarWidths
  • Returns ScrollbarWidths

getSectionClassNames

  • getSectionClassNames(sectionConfig: SectionConfig, wholeTableVGrow: boolean): string[]
  • Parameters

    Returns string[]

getSectionHasLiquidHeight

  • getSectionHasLiquidHeight(props: { liquid: boolean }, sectionConfig: SectionConfig): boolean
  • Parameters

    • props: { liquid: boolean }
      • liquid: boolean
    • sectionConfig: SectionConfig

    Returns boolean

getSegMeta

  • getSegMeta(seg: Seg, todayRange: DateRange, nowDate?: DateMarker): { isFuture: boolean; isPast: boolean; isToday: boolean }
  • Parameters

    Returns { isFuture: boolean; isPast: boolean; isToday: boolean }

    • isFuture: boolean
    • isPast: boolean
    • isToday: boolean

getSlotClassNames

getStickyFooterScrollbar

getStickyHeaderDates

getUnequalProps

  • getUnequalProps(obj0: any, obj1: any): string[]
  • Parameters

    • obj0: any
    • obj1: any

    Returns string[]

greatestDurationDenominator

  • greatestDurationDenominator(dur: Duration): { unit: string; value: number }
  • Parameters

    Returns { unit: string; value: number }

    • unit: string
    • value: number

guid

  • guid(): string
  • Returns string

hasBgRendering

  • hasBgRendering(def: EventDef): boolean
  • Parameters

    Returns boolean

hasShrinkWidth

  • hasShrinkWidth(cols: ColProps[]): boolean
  • Parameters

    Returns boolean

identity

  • identity<T>(raw: T): T
  • Type parameters

    • T

    Parameters

    • raw: T

    Returns T

interactionSettingsToStore

intersectRanges

  • intersectRanges(range0: OpenDateRange, range1: OpenDateRange): OpenDateRange
  • Parameters

    • range0: OpenDateRange
    • range1: OpenDateRange

    Returns OpenDateRange

intersectRects

isArraysEqual

  • isArraysEqual(a0: any, a1: any, equalityFunc?: (v0: any, v1: any) => boolean): boolean
  • Parameters

    • a0: any
    • a1: any
    • Optional equalityFunc: (v0: any, v1: any) => boolean
        • (v0: any, v1: any): boolean
        • Parameters

          • v0: any
          • v1: any

          Returns boolean

    Returns boolean

isColPropsEqual

isDateSpansEqual

isInt

  • isInt(n: any): boolean
  • Parameters

    • n: any

    Returns boolean

isInteractionValid

isMultiDayRange

  • Parameters

    Returns boolean

isPropsEqual

  • isPropsEqual(obj0: any, obj1: any): boolean
  • Parameters

    • obj0: any
    • obj1: any

    Returns boolean

isPropsValid

isValidDate

listenBySelector

  • listenBySelector(container: HTMLElement, eventType: string, selector: string, handler: (ev: Event, matchedTarget: HTMLElement) => void): () => void

mapHash

  • mapHash<InputItem, OutputItem>(hash: {}, func: (input: InputItem, key: string) => OutputItem): {}
  • Type parameters

    • InputItem

    • OutputItem

    Parameters

    • hash: {}
      • [key: string]: InputItem
    • func: (input: InputItem, key: string) => OutputItem
        • (input: InputItem, key: string): OutputItem
        • Parameters

          • input: InputItem
          • key: string

          Returns OutputItem

    Returns {}

    • [key: string]: OutputItem

memoize

  • memoize<Args, Res>(workerFunc: (...args: Args) => Res, resEquality?: (res0: Res, res1: Res) => boolean, teardownFunc?: (res: Res) => void): (...args: Args) => Res
  • Type parameters

    • Args: any[]

    • Res

    Parameters

    • workerFunc: (...args: Args) => Res
        • (...args: Args): Res
        • Parameters

          • Rest ...args: Args

          Returns Res

    • Optional resEquality: (res0: Res, res1: Res) => boolean
        • (res0: Res, res1: Res): boolean
        • Parameters

          • res0: Res
          • res1: Res

          Returns boolean

    • Optional teardownFunc: (res: Res) => void
        • (res: Res): void
        • Parameters

          • res: Res

          Returns void

    Returns (...args: Args) => Res

      • (...args: Args): Res
      • Parameters

        • Rest ...args: Args

        Returns Res

memoizeArraylike

  • memoizeArraylike<Args, Res>(workerFunc: (...args: Args) => Res, resEquality?: (res0: Res, res1: Res) => boolean, teardownFunc?: (res: Res) => void): (argSets: Args[]) => Res[]
  • Type parameters

    • Args: any[]

    • Res

    Parameters

    • workerFunc: (...args: Args) => Res
        • (...args: Args): Res
        • Parameters

          • Rest ...args: Args

          Returns Res

    • Optional resEquality: (res0: Res, res1: Res) => boolean
        • (res0: Res, res1: Res): boolean
        • Parameters

          • res0: Res
          • res1: Res

          Returns boolean

    • Optional teardownFunc: (res: Res) => void
        • (res: Res): void
        • Parameters

          • res: Res

          Returns void

    Returns (argSets: Args[]) => Res[]

      • (argSets: Args[]): Res[]
      • Parameters

        • argSets: Args[]

        Returns Res[]

memoizeHashlike

  • memoizeHashlike<Args, Res>(workerFunc: (...args: Args) => Res, resEquality?: (res0: Res, res1: Res) => boolean, teardownFunc?: (res: Res) => void): (argHash: {}) => {}
  • Type parameters

    • Args: any[]

    • Res

    Parameters

    • workerFunc: (...args: Args) => Res
        • (...args: Args): Res
        • Parameters

          • Rest ...args: Args

          Returns Res

    • Optional resEquality: (res0: Res, res1: Res) => boolean
        • (res0: Res, res1: Res): boolean
        • Parameters

          • res0: Res
          • res1: Res

          Returns boolean

    • Optional teardownFunc: (res: Res) => void
        • (res: Res): void
        • Parameters

          • res: Res

          Returns void

    Returns (argHash: {}) => {}

      • (argHash: {}): {}
      • Parameters

        • argHash: {}
          • [key: string]: Args

        Returns {}

        • [key: string]: Res

memoizeObjArg

  • memoizeObjArg<Arg, Res>(workerFunc: (arg: Arg) => Res, resEquality?: (res0: Res, res1: Res) => boolean, teardownFunc?: (res: Res) => void): (arg: Arg) => Res
  • Type parameters

    • Arg: Record<string, any>

    • Res

    Parameters

    • workerFunc: (arg: Arg) => Res
        • (arg: Arg): Res
        • Parameters

          • arg: Arg

          Returns Res

    • Optional resEquality: (res0: Res, res1: Res) => boolean
        • (res0: Res, res1: Res): boolean
        • Parameters

          • res0: Res
          • res1: Res

          Returns boolean

    • Optional teardownFunc: (res: Res) => void
        • (res: Res): void
        • Parameters

          • res: Res

          Returns void

    Returns (arg: Arg) => Res

      • (arg: Arg): Res
      • Parameters

        • arg: Arg

        Returns Res

mergeEventStores

multiplyDuration

  • multiplyDuration(d: Duration, n: number): { days: number; milliseconds: number; months: number; years: number }
  • Parameters

    Returns { days: number; milliseconds: number; months: number; years: number }

    • days: number
    • milliseconds: number
    • months: number
    • years: number

padStart

  • padStart(val: any, len: any): string
  • Parameters

    • val: any
    • len: any

    Returns string

parseBusinessHours

parseClassNames

  • parseClassNames(raw: ClassNamesInput): string[]
  • Parameters

    • raw: ClassNamesInput

    Returns string[]

parseDragMeta

parseEventDef

parseFieldSpecs

  • parseFieldSpecs<Subject>(input: FieldSpecInput<Subject>): OrderSpec<Subject>[]
  • Type parameters

    • Subject

    Parameters

    • input: FieldSpecInput<Subject>

    Returns OrderSpec<Subject>[]

parseMarker

  • parseMarker(str: any): { isTimeUnspecified: boolean; marker: Date; timeZoneOffset: any }
  • Parameters

    • str: any

    Returns { isTimeUnspecified: boolean; marker: Date; timeZoneOffset: any }

    • isTimeUnspecified: boolean
    • marker: Date
    • timeZoneOffset: any

pointInsideRect

  • pointInsideRect(point: Point, rect: Rect): boolean
  • Parameters

    Returns boolean

preventContextMenu

preventDefault

  • preventDefault(ev: any): void
  • Parameters

    • ev: any

    Returns void

preventSelection

rangeContainsMarker

  • rangeContainsMarker(range: OpenDateRange, date: DateMarker | number): boolean
  • Parameters

    Returns boolean

rangeContainsRange

  • rangeContainsRange(outerRange: OpenDateRange, innerRange: OpenDateRange): boolean
  • Parameters

    • outerRange: OpenDateRange
    • innerRange: OpenDateRange

    Returns boolean

rangesEqual

  • rangesEqual(range0: OpenDateRange, range1: OpenDateRange): boolean
  • Parameters

    • range0: OpenDateRange
    • range1: OpenDateRange

    Returns boolean

rangesIntersect

  • rangesIntersect(range0: OpenDateRange, range1: OpenDateRange): boolean
  • Parameters

    • range0: OpenDateRange
    • range1: OpenDateRange

    Returns boolean

refineEventDef

  • refineEventDef(raw: EventInput, context: CalendarContext, refiners?: { allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Record<string, any>>; groupId: StringConstructor; id: StringConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }): { extra: Record<string, any>; refined: RefinedOptionsFromRefiners<{ allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Record<string, any>>; groupId: StringConstructor; id: StringConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }> }
  • Parameters

    • raw: EventInput
    • context: CalendarContext
    • Optional refiners: { allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Record<string, any>>; groupId: StringConstructor; id: StringConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }
      • allDay: BooleanConstructor
      • allow: Identity<AllowFunc>
      • backgroundColor: StringConstructor
      • borderColor: StringConstructor
      • className: typeof parseClassNames
      • classNames: typeof parseClassNames
      • color: StringConstructor
      • constraint: Identity<any>
      • date: Identity<DateInput>
      • display: StringConstructor
      • durationEditable: BooleanConstructor
      • editable: BooleanConstructor
      • end: Identity<DateInput>
      • extendedProps: Identity<Record<string, any>>
      • groupId: StringConstructor
      • id: StringConstructor
      • overlap: Identity<boolean>
      • start: Identity<DateInput>
      • startEditable: BooleanConstructor
      • textColor: StringConstructor
      • title: StringConstructor
      • url: StringConstructor

    Returns { extra: Record<string, any>; refined: RefinedOptionsFromRefiners<{ allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Record<string, any>>; groupId: StringConstructor; id: StringConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }> }

refineProps

removeElement

removeExact

  • removeExact(array: any, exactVal: any): number
  • Parameters

    • array: any
    • exactVal: any

    Returns number

render

  • render(vnode: ComponentChild, parent: Element | Document | ShadowRoot | DocumentFragment, replaceNode?: Element | Text): void
  • Parameters

    • vnode: ComponentChild
    • parent: Element | Document | ShadowRoot | DocumentFragment
    • Optional replaceNode: Element | Text

    Returns void

renderChunkContent

renderFill

  • renderFill(fillType: string): Element
  • Parameters

    • fillType: string

    Returns Element

renderScrollShim

requestJson

  • requestJson(method: string, url: string, params: Dictionary, successCallback: any, failureCallback: any): void
  • Parameters

    • method: string
    • url: string
    • params: Dictionary
    • successCallback: any
    • failureCallback: any

    Returns void

sanitizeShrinkWidth

  • sanitizeShrinkWidth(shrinkWidth?: number): number
  • Parameters

    • Optional shrinkWidth: number

    Returns number

setElSeg

setRef

  • setRef<RefType>(ref: Ref<RefType> | void, current: RefType): void
  • Type parameters

    • RefType

    Parameters

    • ref: Ref<RefType> | void
    • current: RefType

    Returns void

sliceEventStore

sliceEvents

sortEventSegs

startOfDay

translateRect

  • translateRect(rect: Rect, deltaX: number, deltaY: number): Rect
  • Parameters

    • rect: Rect
    • deltaX: number
    • deltaY: number

    Returns Rect

triggerDateSelect

unmountComponentAtNode

unpromisify

  • unpromisify(func: any, success: any, failure?: any): void
  • Parameters

    • func: any
    • success: any
    • Optional failure: any

    Returns void

whenTransitionDone

wholeDivideDurations

Generated using TypeDoc