Options
All
  • Public
  • Public/Protected
  • All
Menu

Input used to initialize or mass change the properties of a Calendar.

Type parameters

  • T

    The type of data stored in the Event class.

  • M

    The type of metadata stored in the schedule.

Hierarchy

  • CalendarInput

Index

Properties

Optional around

around: DayInput

What day should the calendar be based around (contain)?

Optional delayRefresh

delayRefresh: boolean

When morphing or creating passing a value of true will avoid calling Calendar.refresh as is typically done right after each of those functions.

Optional eventSorter

eventSorter: SortEvent<T, M>

Optional events

events: EventInput<T, M>[]

Optional eventsOutside

eventsOutside: boolean

Optional fill

fill: boolean

Optional listTimes

listTimes: boolean

Optional minimumSize

minimumSize: number

Optional otherwiseFocus

otherwiseFocus: number

When morphing a calendar and preferToday is false OR today is not in the calendar AND around is not specified, we will pick a day at this number in the current calendar (a value between 0 and 1 signifying the start and and of the current calendar).

Optional preferToday

preferToday: boolean

When morphing a calendar to a fewer number of days, do we want to keep today in the calendar if it is already in the calendar?

Optional repeatCovers

repeatCovers: boolean

Optional size

size: number

Optional type

type: Units

Optional updateColumns

updateColumns: boolean

Optional updateRows

updateRows: boolean

Methods

Optional parseData

  • parseData(input: any): T

Optional parseMeta

  • parseMeta(input: any): M

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc