Event | dayspan

A pairing of a user specified event object and the schedule which defines when it occurs on a calendar.

Type parameters

T

The type of data stored in the Event class.
M

The type of metadata stored in the schedule.

Hierarchy

Event

Index

Constructors

constructor

Properties

Constructors

constructor

new Event(schedule: Schedule<M>, data?: T, id?: any, visible?: boolean): Event

- Defined in Event.ts:46
Creates a new event.

Parameters
- schedule: Schedule<M>
  
  The schedule which defines when the event occurs.
- Optional data: T
  
  User specified object which describes this event.
- Optional id: any
  
  User specified ID which identifies this event.
- Default value visible: boolean = true
Returns Event

Properties

data

data: T

User specified object which describes this event.

id

id: any

User specified ID which can be used to find or remove this event from a Calendar.

schedule

schedule: Schedule<M>

The schedule which defines when this event occurs.

visible

visible: boolean

If the event is visible on the calendar.

Generated using TypeDoc