17 KiB
| id | title |
|---|---|
| CalendarCore | CalendarCore |
Class: CalendarCore<TFeatures, TResource, TEvent>
Defined in: calendar/calendar.ts:181
Extends
Type Parameters
TFeatures
TFeatures extends CalendarFeatureList
TResource
TResource extends Resource = Resource
TEvent
TEvent extends Event<TResource> = Event<TResource>
Implements
CalendarActions<TResource,TEvent>
Constructors
Constructor
new CalendarCore<TFeatures, TResource, TEvent>(options): CalendarCore<TFeatures, TResource, TEvent>;
Defined in: calendar/calendar.ts:229
Parameters
options
CalendarCoreOptions<TFeatures, TResource, TEvent>
Returns
CalendarCore<TFeatures, TResource, TEvent>
Overrides
Properties
formatters
formatters: object;
Defined in: calendar/date-core.ts:83
date
date: DateTimeFormat;
dateTime
dateTime: DateTimeFormat;
time
time: DateTimeFormat;
Inherited from
options
options: ParsedCalendarCoreOptions<TFeatures, TResource, TEvent>;
Defined in: calendar/calendar.ts:189
Overrides
store
store: Store<CalendarStore>;
Defined in: calendar/date-core.ts:80
Inherited from
Accessors
activeDatePlain
Get Signature
get protected activeDatePlain(): PlainDate;
Defined in: calendar/date-core.ts:138
Returns
PlainDate
Inherited from
currentPeriodPlain
Get Signature
get protected currentPeriodPlain(): PlainDate;
Defined in: calendar/date-core.ts:142
Returns
PlainDate
Inherited from
featureApi
Get Signature
get featureApi(): ComposedApi<TFeatures, TResource, TEvent>;
Defined in: calendar/calendar.ts:203
Returns
ComposedApi<TFeatures, TResource, TEvent>
Methods
addEvent()
addEvent(event, options?): Promise<SaveEventResult>;
Defined in: calendar/calendar.ts:1032
Parameters
event
TEvent
options?
dependsOn?
Returns
Promise<SaveEventResult>
Implementation of
CalendarActions.addEvent
canGoNextPeriod()
canGoNextPeriod(): boolean;
Defined in: calendar/date-core.ts:466
Returns
boolean
Implementation of
CalendarActions.canGoNextPeriod
Inherited from
canGoPreviousPeriod()
canGoPreviousPeriod(): boolean;
Defined in: calendar/date-core.ts:435
Returns
boolean
Implementation of
CalendarActions.canGoPreviousPeriod
Inherited from
changeViewMode()
changeViewMode(newViewMode): void;
Defined in: calendar/date-core.ts:286
Parameters
newViewMode
Returns
void
Implementation of
CalendarActions.changeViewMode
Inherited from
commitAdd()
commitAdd(event): void;
Defined in: calendar/calendar.ts:832
Parameters
event
TEvent
Returns
void
commitUpdate()
commitUpdate(id, updates): void;
Defined in: calendar/calendar.ts:853
Parameters
id
string
updates
Partial<Omit<TEvent, "id">>
Returns
void
editEvent()
editEvent(
eventId,
updates,
options?): Promise<SaveEventResult>;
Defined in: calendar/calendar.ts:1096
Parameters
eventId
string
updates
Partial<Omit<TEvent, "id">>
options?
dependsOn?
Returns
Promise<SaveEventResult>
Implementation of
CalendarActions.editEvent
ensureRangeLoaded()
ensureRangeLoaded(): void;
Defined in: calendar/calendar.ts:665
Returns
void
fetchEventsForRange()
fetchEventsForRange(start, end): Promise<void>;
Defined in: calendar/calendar.ts:723
Parameters
start
string
end
string
Returns
Promise<void>
Implementation of
CalendarActions.fetchEventsForRange
formatCurrentPeriod()
formatCurrentPeriod(options?): string;
Defined in: calendar/calendar.ts:746
Parameters
options?
locale?
string
Returns
string
Implementation of
CalendarActions.formatCurrentPeriod
formatDate()
formatDate(date): string;
Defined in: calendar/date-core.ts:146
Parameters
date
Returns
string
Inherited from
formatDateTime()
formatDateTime(date): string;
Defined in: calendar/date-core.ts:154
Parameters
date
Returns
string
Inherited from
formatPeriodLabel()
formatPeriodLabel(options?): string;
Defined in: calendar/calendar.ts:727
Parameters
options?
locale?
string
Returns
string
Implementation of
CalendarActions.formatPeriodLabel
formatTime()
formatTime(date): string;
Defined in: calendar/date-core.ts:150
Parameters
date
Returns
string
Inherited from
getAllDayEventsByDate()
getAllDayEventsByDate(date): TEvent[];
Defined in: calendar/calendar.ts:793
Parameters
date
string
Returns
TEvent[]
Implementation of
CalendarActions.getAllDayEventsByDate
getCalendarDays()
protected getCalendarDays(): PlainDate[];
Defined in: calendar/calendar.ts:550
Returns
PlainDate[]
Overrides
getDaysInRange()
getDaysInRange(start, end): object[];
Defined in: calendar/calendar.ts:681
Parameters
start
string
end
string
Returns
object[]
Implementation of
CalendarActions.getDaysInRange
getDaysNames()
getDaysNames(weekday): string[];
Defined in: calendar/date-core.ts:269
Parameters
weekday
"long" | "short"
Returns
string[]
Implementation of
CalendarActions.getDaysNames
Inherited from
getDaysWithEvents()
getDaysWithEvents(): object[];
Defined in: calendar/calendar.ts:677
Returns
object[]
getEvents()
getEvents(): TEvent[];
Defined in: calendar/calendar.ts:917
Returns
TEvent[]
Implementation of
CalendarActions.getEvents
getEventsByDate()
getEventsByDate(date): TEvent[];
Defined in: calendar/calendar.ts:781
Parameters
date
string
Returns
TEvent[]
Implementation of
CalendarActions.getEventsByDate
getFirstDayOfMonth()
protected getFirstDayOfMonth(): PlainDate;
Defined in: calendar/date-core.ts:158
Returns
PlainDate
Inherited from
getFirstDayOfWeek()
protected getFirstDayOfWeek(): PlainDate;
Defined in: calendar/date-core.ts:166
Returns
PlainDate
Inherited from
getLoadedRanges()
getLoadedRanges(): readonly object[];
Defined in: calendar/calendar.ts:719
Returns
readonly object[]
getTimeSlots()
getTimeSlots(options?): TimeSlot[];
Defined in: calendar/calendar.ts:777
Parameters
options?
TimeSlotOptions
Returns
TimeSlot[]
Implementation of
CalendarActions.getTimeSlots
getWeekStartsOn()
getWeekStartsOn(): number;
Defined in: calendar/date-core.ts:173
Returns
number
Inherited from
goToCurrentPeriod()
goToCurrentPeriod(): void;
Defined in: calendar/date-core.ts:396
Returns
void
Implementation of
CalendarActions.goToCurrentPeriod
Inherited from
goToNextPeriod()
goToNextPeriod(): void;
Defined in: calendar/date-core.ts:348
Returns
void
Implementation of
CalendarActions.goToNextPeriod
Inherited from
goToPreviousPeriod()
goToPreviousPeriod(): void;
Defined in: calendar/date-core.ts:300
Returns
void
Implementation of
CalendarActions.goToPreviousPeriod
Inherited from
goToSpecificPeriod()
goToSpecificPeriod(date): void;
Defined in: calendar/date-core.ts:414
Parameters
date
Returns
void
Implementation of
CalendarActions.goToSpecificPeriod
Inherited from
groupDaysBy()
groupDaysBy(__namedParameters): (Day<TResource, TEvent> | null)[][];
Defined in: calendar/calendar.ts:759
Parameters
__namedParameters
days
(Day<TResource, TEvent> | null)[]
fillMissingDays?
boolean = true
unit
"week" | "workWeek"
Returns
(Day<TResource, TEvent> | null)[][]
Implementation of
CalendarActions.groupDaysBy
hasFeature()
hasFeature(name): boolean;
Defined in: calendar/calendar.ts:207
Parameters
name
string
Returns
boolean
removeEvent()
removeEvent(id): void;
Defined in: calendar/calendar.ts:1209
Parameters
id
string
Returns
void
Implementation of
CalendarActions.removeEvent
setEvents()
setEvents(events): void;
Defined in: calendar/calendar.ts:1229
Parameters
events
TEvent[] | null
Returns
void
Implementation of
CalendarActions.setEvents
setResources()
setResources(resources): void;
Defined in: calendar/calendar.ts:1223
Parameters
resources
TResource[] | null
Returns
void
Implementation of
CalendarActions.setResources
toPlainDate()
protected toPlainDate(isoDate): PlainDate;
Defined in: calendar/date-core.ts:134
Parameters
isoDate
string
Returns
PlainDate
Inherited from
validateMove()
validateMove(
eventId,
newStart,
newEnd,
newResources?,
newConsumption?): object;
Defined in: calendar/calendar.ts:927
Parameters
eventId
string
newStart
string
newEnd
string
newResources?
(string | TResource)[]
newConsumption?
number[]
Returns
object
blocked
blocked: boolean;
blockedEventTitle?
optional blockedEventTitle: string;
message?
optional message: string;
Implementation of
CalendarActions.validateMove