18 KiB
| id | title |
|---|---|
| CalendarCore | CalendarCore |
Class: CalendarCore<TFeatures, TResource, TEvent>
Defined in: calendar/calendar.ts:188
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:235
Parameters
options
CalendarCoreOptions<TFeatures, TResource, TEvent>
Returns
CalendarCore<TFeatures, TResource, TEvent>
Overrides
Properties
calendarId
calendarId: string;
Defined in: calendar/date-core.ts:103
Inherited from
formatters
formatters: object;
Defined in: calendar/date-core.ts:105
date
date: DateTimeFormat;
dateTime
dateTime: DateTimeFormat;
time
time: DateTimeFormat;
Inherited from
options
options: ParsedCalendarCoreOptions<TFeatures, TResource, TEvent>;
Defined in: calendar/calendar.ts:196
Overrides
store
store: Store<CalendarStore>;
Defined in: calendar/date-core.ts:100
Inherited from
timeZoneId
timeZoneId: string;
Defined in: calendar/date-core.ts:104
Inherited from
Accessors
activeDatePlain
Get Signature
get protected activeDatePlain(): PlainDate;
Defined in: calendar/date-core.ts:166
Returns
PlainDate
Inherited from
currentPeriodPlain
Get Signature
get protected currentPeriodPlain(): PlainDate;
Defined in: calendar/date-core.ts:170
Returns
PlainDate
Inherited from
featureApi
Get Signature
get featureApi(): ComposedApi<TFeatures, TResource, TEvent>;
Defined in: calendar/calendar.ts:210
Returns
ComposedApi<TFeatures, TResource, TEvent>
Methods
addEvent()
addEvent(event, options?): Promise<SaveEventResult>;
Defined in: calendar/calendar.ts:1058
Parameters
event
TEvent
options?
dependsOn?
Returns
Promise<SaveEventResult>
Implementation of
CalendarActions.addEvent
canGoNextPeriod()
canGoNextPeriod(): boolean;
Defined in: calendar/date-core.ts:499
Returns
boolean
Implementation of
CalendarActions.canGoNextPeriod
Inherited from
canGoPreviousPeriod()
canGoPreviousPeriod(): boolean;
Defined in: calendar/date-core.ts:468
Returns
boolean
Implementation of
CalendarActions.canGoPreviousPeriod
Inherited from
changeViewMode()
changeViewMode(newViewMode): void;
Defined in: calendar/date-core.ts:319
Parameters
newViewMode
Returns
void
Implementation of
CalendarActions.changeViewMode
Inherited from
commitAdd()
commitAdd(event): void;
Defined in: calendar/calendar.ts:874
Parameters
event
TEvent
Returns
void
commitUpdate()
commitUpdate(id, updates): void;
Defined in: calendar/calendar.ts:892
Parameters
id
string
updates
Partial<Omit<TEvent, "id">>
Returns
void
editEvent()
editEvent(
eventId,
updates,
options?): Promise<SaveEventResult>;
Defined in: calendar/calendar.ts:1120
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:713
Returns
void
fetchEventsForRange()
fetchEventsForRange(start, end): Promise<void>;
Defined in: calendar/calendar.ts:770
Parameters
start
string
end
string
Returns
Promise<void>
Implementation of
CalendarActions.fetchEventsForRange
formatCurrentPeriod()
formatCurrentPeriod(options?): string;
Defined in: calendar/calendar.ts:788
Parameters
options?
locale?
string
Returns
string
Implementation of
CalendarActions.formatCurrentPeriod
formatDate()
formatDate(date): string;
Defined in: calendar/date-core.ts:194
Parameters
date
Returns
string
Inherited from
formatDateTime()
formatDateTime(date): string;
Defined in: calendar/date-core.ts:202
Parameters
date
Returns
string
Inherited from
formatPeriod()
formatPeriod(date?, options?): string;
Defined in: calendar/date-core.ts:182
Parameters
date?
options?
Returns
string
Implementation of
CalendarActions.formatPeriod
Inherited from
formatPeriodLabel()
formatPeriodLabel(options?): string;
Defined in: calendar/calendar.ts:774
Parameters
options?
locale?
string
Returns
string
Implementation of
CalendarActions.formatPeriodLabel
formatTime()
formatTime(date): string;
Defined in: calendar/date-core.ts:198
Parameters
date
Returns
string
Inherited from
getAllDayEventsByDate()
getAllDayEventsByDate(date): TEvent[];
Defined in: calendar/calendar.ts:830
Parameters
date
string
Returns
TEvent[]
Implementation of
CalendarActions.getAllDayEventsByDate
getCalendarDays()
protected getCalendarDays(): PlainDate[];
Defined in: calendar/calendar.ts:604
Returns
PlainDate[]
Overrides
getDateParts()
getDateParts(date, options?): DateParts;
Defined in: calendar/date-core.ts:174
Parameters
date
options?
Returns
Implementation of
CalendarActions.getDateParts
Inherited from
getDaysInRange()
getDaysInRange(start, end): object[];
Defined in: calendar/calendar.ts:729
Parameters
start
string
end
string
Returns
object[]
Implementation of
CalendarActions.getDaysInRange
getDaysNames()
getDaysNames(weekday): string[];
Defined in: calendar/date-core.ts:302
Parameters
weekday
"short" | "long"
Returns
string[]
Implementation of
CalendarActions.getDaysNames
Inherited from
getDaysWithEvents()
getDaysWithEvents(): object[];
Defined in: calendar/calendar.ts:725
Returns
object[]
getEvents()
getEvents(): TEvent[];
Defined in: calendar/calendar.ts:947
Returns
TEvent[]
Implementation of
CalendarActions.getEvents
getEventsByDate()
getEventsByDate(date): TEvent[];
Defined in: calendar/calendar.ts:818
Parameters
date
string
Returns
TEvent[]
Implementation of
CalendarActions.getEventsByDate
getFirstDayOfMonth()
protected getFirstDayOfMonth(): PlainDate;
Defined in: calendar/date-core.ts:206
Returns
PlainDate
Inherited from
getFirstDayOfWeek()
protected getFirstDayOfWeek(): PlainDate;
Defined in: calendar/date-core.ts:212
Returns
PlainDate
Inherited from
getLoadedRanges()
getLoadedRanges(): readonly object[];
Defined in: calendar/calendar.ts:766
Returns
readonly object[]
getTimeSlots()
getTimeSlots(options?): TimeSlot[];
Defined in: calendar/calendar.ts:814
Parameters
options?
TimeSlotOptions
Returns
TimeSlot[]
Implementation of
CalendarActions.getTimeSlots
getWeekStartsOn()
getWeekStartsOn(): number;
Defined in: calendar/date-core.ts:216
Returns
number
Inherited from
goToCurrentPeriod()
goToCurrentPeriod(): void;
Defined in: calendar/date-core.ts:429
Returns
void
Implementation of
CalendarActions.goToCurrentPeriod
Inherited from
goToNextPeriod()
goToNextPeriod(): void;
Defined in: calendar/date-core.ts:381
Returns
void
Implementation of
CalendarActions.goToNextPeriod
Inherited from
goToPreviousPeriod()
goToPreviousPeriod(): void;
Defined in: calendar/date-core.ts:333
Returns
void
Implementation of
CalendarActions.goToPreviousPeriod
Inherited from
goToSpecificPeriod()
goToSpecificPeriod(date): void;
Defined in: calendar/date-core.ts:449
Parameters
date
Returns
void
Implementation of
CalendarActions.goToSpecificPeriod
Inherited from
groupDaysBy()
groupDaysBy(__namedParameters): (Day<TResource, TEvent> | null)[][];
Defined in: calendar/calendar.ts:795
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:214
Parameters
name
string
Returns
boolean
removeEvent()
removeEvent(id): void;
Defined in: calendar/calendar.ts:1227
Parameters
id
string
Returns
void
Implementation of
CalendarActions.removeEvent
setEvents()
setEvents(events): void;
Defined in: calendar/calendar.ts:1247
Parameters
events
TEvent[] | null
Returns
void
Implementation of
CalendarActions.setEvents
setResources()
setResources(resources): void;
Defined in: calendar/calendar.ts:1241
Parameters
resources
TResource[] | null
Returns
void
Implementation of
CalendarActions.setResources
toPlainDate()
protected toPlainDate(isoDate): PlainDate;
Defined in: calendar/date-core.ts:162
Parameters
isoDate
string
Returns
PlainDate
Inherited from
validateMove()
validateMove(
eventId,
newStart,
newEnd,
newResources?,
newConsumption?): object;
Defined in: calendar/calendar.ts:957
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