Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventApi

Hierarchy

  • EventApi

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_context

_context: CalendarContext

_def

_def: EventDef

_instance

_instance: null | EventInstance

Accessors

allDay

  • get allDay(): boolean

  • Returns boolean

allow

backgroundColor

  • get backgroundColor(): string

  • Returns string

borderColor

  • get borderColor(): string

  • Returns string

classNames

  • get classNames(): string[]

  • Returns string[]

constraint

display

  • get display(): string

  • Returns string

durationEditable

  • get durationEditable(): boolean

  • Returns boolean

end

  • get end(): null | Date

endStr

  • get endStr(): string

  • Returns string

extendedProps

groupId

  • get groupId(): string

  • Returns string

id

  • get id(): string

  • Returns string

overlap

  • get overlap(): boolean

  • Returns boolean

source

start

  • get start(): null | Date

startEditable

  • get startEditable(): boolean

  • Returns boolean

startStr

  • get startStr(): string

  • Returns string

textColor

  • get textColor(): string

  • Returns string

title

  • get title(): string

  • Returns string

url

  • get url(): string

  • Returns string

Methods

formatRange

moveDates

moveEnd

moveStart

mutate

remove

  • remove(): void

  • Returns void

setAllDay

  • setAllDay(allDay: boolean, options?: { maintainDuration?: boolean }): void

  • Parameters

    • allDay: boolean
    • Optional options: { maintainDuration?: boolean }
      • Optional maintainDuration?: boolean

    Returns void

setDates

  • setDates(startInput: DateInput, endInput: null | DateInput, options?: { allDay?: boolean; granularity?: string }): void

  • Parameters

    • startInput: DateInput
    • endInput: null | DateInput
    • Optional options: { allDay?: boolean; granularity?: string }
      • Optional allDay?: boolean
      • Optional granularity?: string

    Returns void

setEnd

  • setEnd(endInput: null | DateInput, options?: { granularity?: string }): void

  • Parameters

    • endInput: null | DateInput
    • Optional options: { granularity?: string }
      • Optional granularity?: string

    Returns void

setExtendedProp

  • setExtendedProp(name: string, val: any): void

  • Parameters

    • name: string
    • val: any

    Returns void

setProp

  • setProp(name: string, val: any): void

  • Parameters

    • name: string
    • val: any

    Returns void

setStart

  • setStart(startInput: DateInput, options?: { granularity?: string; maintainDuration?: boolean }): void

  • Parameters

    • startInput: DateInput
    • Optional options: { granularity?: string; maintainDuration?: boolean }
      • Optional granularity?: string
      • Optional maintainDuration?: boolean

    Returns void

toJSON

toPlainObject

  • toPlainObject(settings?: { collapseColor?: boolean; collapseExtendedProps?: boolean }): Dictionary

  • Parameters

    • Optional settings: { collapseColor?: boolean; collapseExtendedProps?: boolean }
      • Optional collapseColor?: boolean
      • Optional collapseExtendedProps?: boolean

    Returns Dictionary

Generated using TypeDoc