Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RadCalendar

This class represents the RadCalendar component. RadCalendar is based on the already familiar native Android and iOS components from Progress Telerik UI for Android and Progress Telerik UI for iOS. The component exposes all major features supported by the native controls through a unified API suitable for NativeScript developers.

Hierarchy

  • any

Index

Properties

dayViewStyle

dayViewStyle: CalendarDayViewStyle

Gets or sets the style properties for Week view mode. See CalendarDayViewStyle for available styling properties.

displayedDate

displayedDate: Date

Gets or sets the current displayed date in the RadCalendar instance.

eventSource

eventSource: ObservableArray<CalendarEvent>

Gets or sets the current event source in the RadCalendar instance.

eventsViewMode

eventsViewMode: CalendarEventsViewMode

Gets or sets the events view mode in RadCalendar instance.

horizontalTransition

horizontalTransition: boolean

Gets or sets if the transition of the RadCalendar instance is horizontal.

locale

locale: string

Gets or sets the locale used throughout RadCalendar. Valid locale values are standard BCP-47 language tags like: us-US, ru-RU, bg-BG, etc.

maxDate

maxDate: Date

Gets or sets the max date accessible by the (@link RadCalendar) instance.

minDate

minDate: Date

Gets or sets the min date accessible by the (@link RadCalendar) instance.

monthNamesViewStyle

monthNamesViewStyle: CalendarMonthNamesViewStyle

Gets or sets the style properties for MonthNames view mode. See CalendarMonthNamesViewStyle for available styling properties.

monthViewStyle

monthViewStyle: CalendarMonthViewStyle

Gets or sets the style properties for Month view mode. See CalendarMonthViewStyle for available styling properties.

selectedDate

selectedDate: Date

Gets or sets the current selected date in the RadCalendar instance.

selectedDateRange

selectedDateRange: DateRange

Gets or sets the current selected date range in the RadCalendar instance.

selectedDates

selectedDates: any

Gets or sets the current selected dates in the RadCalendar instance.

selectionMode

selectionMode: CalendarSelectionMode

Gets or sets the current selection mode in the RadCalendar instance.

transitionMode

transitionMode: CalendarTransitionMode

Gets or sets the current transition mode in the RadCalendar instance.

viewMode

Gets or sets the current view mode in the RadCalendar instance.

weekViewStyle

weekViewStyle: CalendarWeekViewStyle

Gets or sets the style properties for Week view mode. See CalendarWeekViewStyle for available styling properties.

yearViewStyle

yearViewStyle: CalendarYearViewStyle

Gets or sets the style properties for Year view mode. See CalendarYearViewStyle for available styling properties.

Static cellTapEvent

cellTapEvent: string

This event is fired when a cell is tapped. The event exposes an instance of the CalendarCellTapEventData class.

Static dateDeselectedEvent

dateDeselectedEvent: string

This event is fired when a date is deselected. The event exposes an instance of the CalendarSelectionEventData class.

Static dateSelectedEvent

dateSelectedEvent: string

This event is fired when a date is selected. The event exposes an instance of the CalendarSelectionEventData class.

Static dayViewEventSelectedEvent

dayViewEventSelectedEvent: string

This event is fired when RadCalendar an event from the day view has been tapped. The event exposes an instance of the CalendarDayViewEventSelectedData class.

Static dayViewStyleProperty

dayViewStyleProperty: Property<RadCalendar, CalendarDayViewStyle>

Identifies the dayViewStyle dependency property.

Static displayedDateProperty

displayedDateProperty: Property<RadCalendar, Date>

Gets the displayedDate dependency property.

Static eventSourceProperty

eventSourceProperty: Property<RadCalendar, ObservableArray<CalendarEvent>>

Identifies the eventSource dependency property.

Static eventsViewModeProperty

eventsViewModeProperty: Property<RadCalendar, CalendarEventsViewMode>

Identifies the eventsViewMode dependency property.

Static horizontalTransitionProperty

horizontalTransitionProperty: Property<RadCalendar, boolean>

Identifies the horizontalTransition dependency property.

Static inlineEventSelectedEvent

inlineEventSelectedEvent: string

This event is fired when RadCalendar an inline event has been tapped. The event exposes an instance of the CalendarInlineEventSelectedData class.

Static localeProperty

localeProperty: Property<RadCalendar, string>

Identifies the locale dependency property.

Static maxDateProperty

maxDateProperty: Property<RadCalendar, Date>

Identifies the maxDate dependency property.

Static minDateProperty

minDateProperty: Property<RadCalendar, Date>

Identifies the minDate dependency property.

Static monthNamesViewStyleProperty

monthNamesViewStyleProperty: Property<RadCalendar, CalendarMonthNamesViewStyle>

Identifies the monthViewStyle dependency property.

Static monthViewStyleProperty

monthViewStyleProperty: Property<RadCalendar, CalendarMonthViewStyle>

Identifies the monthViewStyle dependency property.

Static navigatedToDateEvent

navigatedToDateEvent: string

This event is fired when RadCalendar has navigated to a certain date. The event exposes an instance of the CalendarNavigationEventData class.

Static navigatingToDateStartedEvent

navigatingToDateStartedEvent: string

This event is fired when RadCalendar is about to navigate to a certain date. The event exposes an instance of the CalendarNavigationEventData class.

Static selectedDateProperty

selectedDateProperty: Property<RadCalendar, Date>

Identifies the selectedDate dependency property.

Static selectedDateRangeProperty

selectedDateRangeProperty: Property<RadCalendar, DateRange>

Identifies the selectedDateRange dependency property.

Static selectedDatesProperty

selectedDatesProperty: Property<RadCalendar, any>

Identifies the selectedDates dependency property.

Static selectionModeProperty

selectionModeProperty: Property<RadCalendar, CalendarSelectionMode>

Identifies the selectionMode dependency property.

Static transitionModeProperty

transitionModeProperty: Property<RadCalendar, CalendarTransitionMode>

Identifies the transitionMode dependency property.

Static viewModeChangedEvent

viewModeChangedEvent: string

This event is fired when RadCalendar's viewMode has been changed. The event exposes an instance of the CalendarViewModeChangedEventData class.

Static viewModeProperty

viewModeProperty: Property<RadCalendar, CalendarViewMode>

Identifies the viewMode dependency property.

Static weekViewStyleProperty

weekViewStyleProperty: Property<RadCalendar, CalendarWeekViewStyle>

Identifies the monthViewStyle dependency property.

Static yearViewStyleProperty

yearViewStyleProperty: Property<RadCalendar, CalendarYearViewStyle>

Identifies the monthViewStyle dependency property.

Methods

getEventsForDate

  • Gets an array with the events for a specific date.

    Parameters

    • date: Date

    Returns Array<CalendarEvent>

goToDate

  • goToDate(date: Date): void
  • Navigates to the specified date.

    Parameters

    • date: Date

    Returns void

navigateBack

  • navigateBack(): void
  • Navigates to the previous screen in the current view mode context.

    Returns void

navigateForward

  • navigateForward(): void
  • Navigates to the next screen in current view mode context.

    Returns void

reload

  • reload(): void
  • Reloads all events in the RadCalendar instance and resets the selection.

    Returns void

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