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

  • View

Index

Constructors

Properties

Methods

Constructors

constructor

  • Please note that should you be using the new Observable({}) constructor, it is obsolete since v3.0, and you have to migrate to the "data/observable" fromObject({}) or the fromObjectRecursive({}) functions.

    Returns RadCalendar

Properties

_context

_context: any

_cssState

_cssState: any

_domId

_domId: number

_isAddedToNativeVisualTree

_isAddedToNativeVisualTree: boolean

alignSelf

alignSelf: AlignSelf

android

android: any

Gets the android-specific native instance that lies behind this proxy. Will be available if running on an Android platform.

automationText

automationText: string

Gets or sets the automation text of the view.

background

background: string

Gets or sets the background style property.

backgroundColor

backgroundColor: string | Color

Gets or sets the background color of the view.

backgroundImage

backgroundImage: string | LinearGradient

Gets or sets the background image of the view.

bindingContext

bindingContext: any

Gets or sets the binding context of this instance. This object is used as a source for each Binding that does not have a source object specified.

borderBottomColor

borderBottomColor: Color

Gets or sets the bottom border color of the view.

borderBottomLeftRadius

borderBottomLeftRadius: Length

Gets or sets the bottom left border radius of the view.

borderBottomRightRadius

borderBottomRightRadius: Length

Gets or sets the bottom right border radius of the view.

borderBottomWidth

borderBottomWidth: Length

Gets or sets the bottom border width of the view.

borderColor

borderColor: string | Color

Gets or sets the border color of the view.

borderLeftColor

borderLeftColor: Color

Gets or sets the left border color of the view.

borderLeftWidth

borderLeftWidth: Length

Gets or sets the left border width of the view.

borderRadius

borderRadius: string | Length

Gets or sets the border radius of the view.

borderRightColor

borderRightColor: Color

Gets or sets the right border color of the view.

borderRightWidth

borderRightWidth: Length

Gets or sets the right border width of the view.

borderTopColor

borderTopColor: Color

Gets or sets the top border color of the view.

borderTopLeftRadius

borderTopLeftRadius: Length

Gets or sets the top left border radius of the view.

borderTopRightRadius

borderTopRightRadius: Length

Gets or sets the top right border radius of the view.

borderTopWidth

borderTopWidth: Length

Gets or sets the top border width of the view.

borderWidth

borderWidth: string | Length

Gets or sets the border width of the view.

className

className: string

Gets or sets the CSS class name for this view.

col

col: number

colSpan

colSpan: number

color

color: Color

Gets or sets the color of the view.

Private css

css: string

cssClasses

cssClasses: Set<string>

cssPseudoClasses

cssPseudoClasses: Set<string>

cssType

cssType: string

Gets the CSS fully qualified type name. Using this as element type should allow for PascalCase and kebap-case selectors, when fully qualified, to match the element.

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.

dock

dock: "left" | "top" | "right" | "bottom"

domNode

domNode: DOMNode

effectiveBorderBottomWidth

effectiveBorderBottomWidth: number

effectiveBorderLeftWidth

effectiveBorderLeftWidth: number

effectiveBorderRightWidth

effectiveBorderRightWidth: number

effectiveBorderTopWidth

effectiveBorderTopWidth: number

effectiveHeight

effectiveHeight: number

effectiveLeft

effectiveLeft: number

effectiveMarginBottom

effectiveMarginBottom: number

effectiveMarginLeft

effectiveMarginLeft: number

effectiveMarginRight

effectiveMarginRight: number

effectiveMarginTop

effectiveMarginTop: number

effectiveMinHeight

effectiveMinHeight: number

effectiveMinWidth

effectiveMinWidth: number

effectivePaddingBottom

effectivePaddingBottom: number

effectivePaddingLeft

effectivePaddingLeft: number

effectivePaddingRight

effectivePaddingRight: number

effectivePaddingTop

effectivePaddingTop: number

effectiveTop

effectiveTop: number

effectiveWidth

effectiveWidth: number

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.

flexGrow

flexGrow: FlexGrow

flexShrink

flexShrink: FlexShrink

flexWrapBefore

flexWrapBefore: FlexWrapBefore

height

height: PercentLength

Gets or sets the desired height of the view.

horizontalAlignment

horizontalAlignment: HorizontalAlignment

Gets or sets the alignment of this view within its parent along the Horizontal axis.

horizontalTransition

horizontalTransition: boolean

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

id

id: string

Gets or sets the id for this view.

ios

ios: any

Gets the ios-specific native instance that lies behind this proxy. Will be available if running on an iOS platform.

iosOverflowSafeArea

iosOverflowSafeArea: boolean

Instruct container view to expand beyond the safe area. This property is iOS specific. Default value: false

iosOverflowSafeAreaEnabled

iosOverflowSafeAreaEnabled: boolean

Enables or disables the iosOverflowSafeArea property for all children. This property is iOS specific. Default value: true

isCollapsed

isCollapsed: boolean

Returns true if visibility is set to 'collapse'. Readonly property

isEnabled

isEnabled: boolean

Gets or sets a value indicating whether the the view is enabled. This affects the appearance of the view.

isLayoutValid

isLayoutValid: boolean

Gets is layout is valid. This is a read-only property.

isLoaded

isLoaded: boolean

isUserInteractionEnabled

isUserInteractionEnabled: boolean

Gets or sets a value indicating whether the user can interact with the view. This does not affect the appearance of the view.

left

left: Length

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.

margin

margin: string | PercentLength

Gets or sets margin style property.

marginBottom

marginBottom: PercentLength

Specifies extra space on the bottom side of this view.

marginLeft

marginLeft: PercentLength

Specifies extra space on the left side of this view.

marginRight

marginRight: PercentLength

Specifies extra space on the right side of this view.

marginTop

marginTop: PercentLength

Specifies extra space on the top side of this view.

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.

minHeight

minHeight: Length

Gets or sets the minimum height the view may grow to.

minWidth

minWidth: Length

Gets or sets the minimum width the view may grow to.

modal

modal: View

Returns the current modal view that this page is showing (is parent of), if any.

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.

nativeView

nativeView: any

nativeViewProtected

nativeViewProtected: any

read-only. If you want to set out-of-band the nativeView use the setNativeView method.

opacity

opacity: number

Gets or sets the opacity style property.

order

order: Order

originX

originX: number

Gets or sets the X component of the origin point around which the view will be transformed. The deafault value is 0.5 representing the center of the view.

originY

originY: number

Gets or sets the Y component of the origin point around which the view will be transformed. The deafault value is 0.5 representing the center of the view.

page

page: Page

Gets owner page. This is a read-only property.

parent

parent: ViewBase

Gets the parent view. This property is read-only.

parentNode

parentNode: ViewBase

Gets the template parent or the native parent. Sets the template parent.

rotate

rotate: number

Gets or sets the rotate affine transform of the view.

row

row: number

rowSpan

rowSpan: number

scaleX

scaleX: number

Gets or sets the scaleX affine transform of the view.

scaleY

scaleY: number

Gets or sets the scaleY affine transform of the view.

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.

style

style: Style

Gets the style object associated to this view.

top

top: Length

transitionMode

transitionMode: CalendarTransitionMode

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

translateX

translateX: dip

Gets or sets the translateX affine transform of the view in device independent pixels.

translateY

translateY: dip

Gets or sets the translateY affine transform of the view in device independent pixels.

typeName

typeName: string

Gets the name of the constructor function for this instance. E.g. for a Button class this will return "Button".

verticalAlignment

verticalAlignment: VerticalAlignment

Gets or sets the alignment of this view within its parent along the Vertical axis.

viewController

viewController: any

returns the native UIViewController.

viewMode

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

visibility

visibility: Visibility

Gets or sets the visibility of the view.

weekViewStyle

weekViewStyle: CalendarWeekViewStyle

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

width

width: PercentLength

Gets or sets the desired width of the view.

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 layoutChangedEvent

layoutChangedEvent: string

String value used when hooking to layoutChanged event.

Static loadedEvent

loadedEvent: string

String value used when hooking to loaded event.

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 propertyChangeEvent

propertyChangeEvent: string

String value used when hooking to propertyChange event.

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 showingModallyEvent

showingModallyEvent: string

String value used when hooking to showingModally event.

Static shownModallyEvent

shownModallyEvent: string

String value used when hooking to shownModally event.

Static transitionModeProperty

transitionModeProperty: Property<RadCalendar, CalendarTransitionMode>

Identifies the transitionMode dependency property.

Static unloadedEvent

unloadedEvent: string

String value used when hooking to unloaded event.

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

_addView

  • _addView(view: ViewBase, atIndex?: number): void
  • Parameters

    • view: ViewBase
    • Optional atIndex: number

    Returns void

_addViewCore

  • _addViewCore(view: ViewBase, atIndex?: number): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Parameters

    • view: ViewBase
    • Optional atIndex: number

    Returns void

_addViewToNativeVisualTree

  • _addViewToNativeVisualTree(view: ViewBase, atIndex?: number): boolean
  • Performs the core logic of adding a child view to the native visual tree. Returns true if the view's native representation has been successfully added, false otherwise.

    Parameters

    • view: ViewBase
    • Optional atIndex: number

    Returns boolean

_applyXmlAttribute

  • _applyXmlAttribute(attribute: any, value: any): boolean
  • This used to be the way to set attribute values in early {N} versions. Now attributes are expected to be set as plain properties on the view instances.

    deprecated

    Parameters

    • attribute: any
    • value: any

    Returns boolean

_childIndexToNativeChildIndex

  • _childIndexToNativeChildIndex(index?: number): number
  • Parameters

    • Optional index: number

    Returns number

_dialogClosed

  • _dialogClosed(): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Returns void

_eachLayoutView

  • _eachLayoutView(callback: function): void
  • Parameters

    • callback: function
        • (View: any): void
        • Parameters

          • View: any

          Returns void

    Returns void

_getNativeViewsCount

  • _getNativeViewsCount(): number
  • Returns number

_getValue

  • _getValue(property: any): never
  • Obsolete: There is a new property system that does not rely on _getValue.

    Parameters

    • property: any

    Returns never

_goToVisualState

  • _goToVisualState(state: string): void
  • Parameters

    • state: string

    Returns void

Private _onCssStateChange

  • _onCssStateChange(): void
  • Returns void

_onRootViewReset

  • _onRootViewReset(): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Returns void

_parentChanged

  • _parentChanged(oldParent: ViewBase): void
  • Parameters

    • oldParent: ViewBase

    Returns void

_removeView

  • _removeView(view: ViewBase): void
  • Parameters

    • view: ViewBase

    Returns void

_removeViewCore

  • _removeViewCore(view: ViewBase): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Parameters

    • view: ViewBase

    Returns void

_removeViewFromNativeVisualTree

  • _removeViewFromNativeVisualTree(view: ViewBase): void
  • Parameters

    • view: ViewBase

    Returns void

_setValue

  • _setValue(property: any, value: any): never
  • Obsolete: There is a new property system that does not rely on _setValue.

    Parameters

    • property: any
    • value: any

    Returns never

_setupUI

  • _setupUI(context: any, atIndex?: number): void
  • Setups the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

    Parameters

    • context: any
    • Optional atIndex: number

    Returns void

_tearDownUI

  • _tearDownUI(force?: boolean): void
  • Tears down the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

    Parameters

    • Optional force: boolean

    Returns void

Private addCss

  • addCss(cssString: string): void
  • Parameters

    • cssString: string

      A valid css which will be added to current css.

    Returns void

Private addCssFile

  • addCssFile(cssFileName: string): void
  • Parameters

    • cssFileName: string

      A valid file name (from the application root) which contains a valid css.

    Returns void

addEventListener

  • addEventListener(eventNames: string, callback: function, thisArg?: any): any
  • Adds a listener for the specified event name.

    Parameters

    • eventNames: string

      Comma delimited names of the events to attach the listener to.

    • callback: function

      A function to be called when some of the specified event(s) is raised.

        • (data: EventData): void
        • Parameters

          • data: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which when set will be used as "this" in callback method call.

    Returns any

Protected addPseudoClass

  • addPseudoClass(name: string): void
  • unstable

    A widget can call this method to add a matching css pseudo class.

    Parameters

    • name: string

    Returns void

animate

  • animate(options: AnimationDefinition): AnimationPromise
  • Animates one or more properties of the view based on the supplied options.

    Parameters

    • options: AnimationDefinition

    Returns AnimationPromise

bind

  • bind(options: BindingOptions, source?: Object): void
  • Parameters

    • options: BindingOptions
    • Optional source: Object

    Returns void

closeModal

  • closeModal(context?: any): void
  • Closes the current modal view that this page is showing.

    Parameters

    • Optional context: any

      Any context you want to pass back to the host when closing the modal view.

    Returns void

createAnimation

  • createAnimation(options: AnimationDefinition): Animation
  • Creates an Animation object based on the supplied options.

    Parameters

    • options: AnimationDefinition

    Returns Animation

createNativeView

  • createNativeView(): Object
  • Creates a native view. Returns either android.view.View or UIView.

    Returns Object

Protected deletePseudoClass

  • deletePseudoClass(name: string): void
  • unstable

    A widget can call this method to discard matching css pseudo class.

    Parameters

    • name: string

    Returns void

disposeNativeView

  • disposeNativeView(): void
  • Clean up references to the native view.

    Returns void

eachChild

  • eachChild(callback: function): void
  • Iterates over children of type ViewBase.

    Parameters

    • callback: function

      Called for each child of type ViewBase. Iteration stops if this method returns falsy value.

        • (child: ViewBase): boolean
        • Parameters

          • child: ViewBase

          Returns boolean

    Returns void

eachChildView

  • eachChildView(callback: function): void
  • Iterates over children of type View.

    Parameters

    • callback: function

      Called for each child of type View. Iteration stops if this method returns falsy value.

        • (view: View): boolean
        • Parameters

          • view: View

          Returns boolean

    Returns void

ensureDomNode

  • ensureDomNode(): any
  • unstable

    Ensures a dom-node for this view.

    Returns any

focus

  • focus(): boolean
  • Tries to focus the view. Returns a value indicating whether this view or one of its descendants actually took focus.

    Returns boolean

get

  • get(name: string): any
  • Gets the value of the specified property.

    Parameters

    • name: string

    Returns any

getActualSize

  • getActualSize(): Size
  • Returns the actual size of the view in device-independent pixels.

    Returns Size

getEventsForDate

getGestureObservers

  • getGestureObservers(type: GestureTypes): Array<GesturesObserver>
  • Parameters

    • type: GestureTypes

    Returns Array<GesturesObserver>

getLocationInWindow

  • getLocationInWindow(): Point
  • Returns the location of this view in the window coordinate system.

    Returns Point

getLocationOnScreen

  • getLocationOnScreen(): Point
  • Returns the location of this view in the screen coordinate system.

    Returns Point

getLocationRelativeTo

  • getLocationRelativeTo(otherView: View): Point
  • Returns the location of this view in the otherView's coordinate system.

    Parameters

    • otherView: View

    Returns Point

getMeasuredHeight

  • getMeasuredHeight(): number
  • Returns the raw height component.

    Returns number

getMeasuredState

  • getMeasuredState(): number
  • Returns number

getMeasuredWidth

  • getMeasuredWidth(): number
  • Returns the raw width component.

    Returns number

getSafeAreaInsets

  • getSafeAreaInsets(): object
  • Returns the iOS safe area insets of this view.

    Returns object

    • bottom: any
    • left: any
    • right: any
    • top: any

getViewById

  • getViewById<T>(id: string): T
  • Returns the child view with the specified id.

    Type parameters

    • T: ViewBase

    Parameters

    • id: string

    Returns T

goToDate

  • goToDate(date: Date): void

hasListeners

  • hasListeners(eventName: string): boolean
  • Checks whether a listener is registered for the specified event name.

    Parameters

    • eventName: string

      The name of the event to check for.

    Returns boolean

initNativeView

  • initNativeView(): void
  • Initializes properties/listeners of the native view.

    Returns void

layout

  • layout(left: number, top: number, right: number, bottom: number, setFrame?: boolean): void
  • Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism. (The first is measuring). In this phase, each parent calls layout on all of its children to position them. This is typically done using the child measurements that were stored in the measure pass(). Derived classes should not override this method. Derived classes with children should override onLayout. In that method, they should call layout on each of their children.

    Parameters

    • left: number
    • top: number
    • right: number
    • bottom: number
    • Optional setFrame: boolean

    Returns void

layoutNativeView

  • layoutNativeView(left: number, top: number, right: number, bottom: number): void
  • Called from onLayout when native view position is about to be changed.

    Parameters

    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

loadView

  • loadView(view: ViewBase): void
  • Load view.

    Parameters

    • view: ViewBase

      to load.

    Returns void

measure

  • measure(widthMeasureSpec: number, heightMeasureSpec: number): void
  • This is called to find out how big a view should be. The parent supplies constraint information in the width and height parameters. The actual measurement work of a view is performed in onMeasure(int, int), called by this method. Therefore, only onMeasure(int, int) can and must be overridden by subclasses.

    Parameters

    • widthMeasureSpec: number

      Horizontal space requirements as imposed by the parent

    • heightMeasureSpec: number

      Vertical space requirements as imposed by the parent

    Returns void

navigateBack

  • navigateBack(): void

navigateForward

  • navigateForward(): void

notify

  • notify<T>(data: T): void
  • Notifies all the registered listeners for the event provided in the data.eventName.

    Type parameters

    • T: EventData

    Parameters

    • data: T

      The data associated with the event.

    Returns void

notifyPropertyChange

  • notifyPropertyChange(propertyName: string, value: any, oldValue?: any): void
  • Notifies all the registered listeners for the property change event.

    Parameters

    • propertyName: string
    • value: any
    • Optional oldValue: any

    Returns void

observe

  • observe(type: GestureTypes, callback: function, thisArg?: any): any
  • [Deprecated. Please use the on() instead.] Adds a gesture observer.

    Parameters

    • type: GestureTypes

      Type of the gesture.

    • callback: function

      A function that will be executed when gesture is received.

        • (args: GestureEventData): void
        • Parameters

          • args: GestureEventData

          Returns void

    • Optional thisArg: any

      An optional parameter which will be used as this context for callback execution.

    Returns any

off

  • off(eventNames: string | GestureTypes, callback?: function, thisArg?: any): any
  • Removes listener(s) for the specified event name.

    Parameters

    • eventNames: string | GestureTypes

      Comma delimited names of the events or gesture types the specified listener is associated with.

    • Optional callback: function

      An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.

        • (args: EventData): void
        • Parameters

          • args: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.

    Returns any

on

  • on(eventNames: string | GestureTypes, callback: function, thisArg?: any): any
  • on(event: "loaded", callback: function, thisArg?: any): any
  • on(event: "unloaded", callback: function, thisArg?: any): any
  • on(event: "androidBackPressed", callback: function, thisArg?: any): any
  • on(event: "showingModally", callback: function, thisArg?: any): void
  • on(event: "shownModally", callback: function, thisArg?: any): any
  • A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

    Parameters

    • eventNames: string | GestureTypes

      String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change") or you can use gesture types.

    • callback: function

      Callback function which will be executed when event is raised.

        • (args: EventData): void
        • Parameters

          • args: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which will be used as this context for callback execution.

    Returns any

  • Raised when a loaded event occurs.

    Parameters

    • event: "loaded"
    • callback: function
        • (args: EventData): void
        • Parameters

          • args: EventData

          Returns void

    • Optional thisArg: any

    Returns any

  • Raised when an unloaded event occurs.

    Parameters

    • event: "unloaded"
    • callback: function
        • (args: EventData): void
        • Parameters

          • args: EventData

          Returns void

    • Optional thisArg: any

    Returns any

  • Raised when a back button is pressed. This event is raised only for android.

    Parameters

    • event: "androidBackPressed"
    • callback: function
        • (args: EventData): void
        • Parameters

          • args: EventData

          Returns void

    • Optional thisArg: any

    Returns any

  • Raised before the view is shown as a modal dialog.

    Parameters

    • event: "showingModally"
    • callback: function
        • (args: ShownModallyData): void
        • Parameters

          • args: ShownModallyData

          Returns void

    • Optional thisArg: any

    Returns void

  • Raised after the view is shown as a modal dialog.

    Parameters

    • event: "shownModally"
    • callback: function
        • (args: ShownModallyData): void
        • Parameters

          • args: ShownModallyData

          Returns void

    • Optional thisArg: any

    Returns any

onBackPressed

  • onBackPressed(): boolean
  • Derived classes can override this method to handle Android back button press.

    Returns boolean

onLayout

  • onLayout(left: number, top: number, right: number, bottom: number): void
  • Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

    Parameters

    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

onLoaded

  • onLoaded(): void
  • Returns void

onMeasure

  • onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void
  • Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents. When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an exception, thrown by measure(int, int).

    Parameters

    • widthMeasureSpec: number

      horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

    • heightMeasureSpec: number

      vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

    Returns void

onResumeNativeUpdates

  • onResumeNativeUpdates(): void
  • Returns void

onUnloaded

  • onUnloaded(): void
  • Returns void

once

  • once(event: string, callback: function, thisArg?: any): any
  • Adds one-time listener function for the event named event.

    Parameters

    • event: string

      Name of the event to attach to.

    • callback: function

      A function to be called when the specified event is raised.

        • (data: EventData): void
        • Parameters

          • data: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which when set will be used as "this" in callback method call.

    Returns any

reload

  • reload(): void

removeEventListener

  • removeEventListener(eventNames: string, callback?: any, thisArg?: any): any
  • Removes listener(s) for the specified event name.

    Parameters

    • eventNames: string

      Comma delimited names of the events the specified listener is associated with.

    • Optional callback: any

      An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.

    • Optional thisArg: any

      An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.

    Returns any

requestLayout

  • requestLayout(): void
  • Invalidates the layout of the view and triggers a new layout pass.

    Returns void

resetNativeView

  • resetNativeView(): void
  • Resets properties/listeners set to the native view.

    Returns void

set

  • set(name: string, value: any): void
  • Updates the specified property with the provided value.

    Parameters

    • name: string
    • value: any

    Returns void

setInlineStyle

  • setInlineStyle(style: string): void
  • Parameters

    • style: string

    Returns void

setMeasuredDimension

  • setMeasuredDimension(measuredWidth: number, measuredHeight: number): void
  • This method must be called by onMeasure(int, int) to store the measured width and measured height. Failing to do so will trigger an exception at measurement time.

    Parameters

    • measuredWidth: number

      The measured width of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

    • measuredHeight: number

      The measured height of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

    Returns void

setNativeView

  • setNativeView(view: any): void
  • Set the nativeView field performing extra checks and updates to the native properties on the new view. Use in cases where the createNativeView is not suitable. As an example use in item controls where the native parent view will create the native views for child items.

    Parameters

    • view: any

    Returns void

showModal

  • showModal(moduleName: string, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): ViewBase
  • showModal(view: ViewBase, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): ViewBase
  • showModal(moduleName: string, modalOptions: ShowModalOptions): ViewBase
  • showModal(view: ViewBase, modalOptions: ShowModalOptions): ViewBase
  • showModal(): ViewBase
  • deprecated

    Use showModal with ShowModalOptions instead. Shows the View contained in moduleName as a modal view.

    Parameters

    • moduleName: string

      The name of the module to load starting from the application root.

    • context: any

      Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.

    • closeCallback: Function

      A function that will be called when the view is closed. Any arguments provided when calling ShownModallyData.closeCallback will be available here.

    • Optional fullscreen: boolean

      An optional parameter specifying whether to show the modal view in full-screen mode.

    • Optional animated: boolean

      An optional parameter specifying whether to show the modal view with animation.

    • Optional stretched: boolean

      An optional parameter specifying whether to stretch the modal view when not in full-screen mode.

    Returns ViewBase

  • deprecated

    Use showModal with ShowModalOptions instead. Shows the view passed as parameter as a modal view.

    Parameters

    • view: ViewBase

      View instance to be shown modally.

    • context: any

      Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.

    • closeCallback: Function

      A function that will be called when the view is closed. Any arguments provided when calling ShownModallyData.closeCallback will be available here.

    • Optional fullscreen: boolean

      An optional parameter specifying whether to show the modal view in full-screen mode.

    • Optional animated: boolean

      An optional parameter specifying whether to show the modal view with animation.

    • Optional stretched: boolean

      An optional parameter specifying whether to stretch the modal view when not in full-screen mode.

    Returns ViewBase

  • Shows the View contained in moduleName as a modal view.

    Parameters

    • moduleName: string

      The name of the module to load starting from the application root.

    • modalOptions: ShowModalOptions

      A ShowModalOptions instance

    Returns ViewBase

  • Shows the view passed as parameter as a modal view.

    Parameters

    • view: ViewBase

      View instance to be shown modally.

    • modalOptions: ShowModalOptions

      A ShowModalOptions instance

    Returns ViewBase

  • Deprecated. Showing view as modal is deprecated. Use showModal method with arguments.

    Returns ViewBase

unbind

  • unbind(property: string): void
  • Parameters

    • property: string

    Returns void

unloadView

  • unloadView(view: ViewBase): void
  • Unload view.

    Parameters

    • view: ViewBase

      to unload.

    Returns void

Static combineMeasuredStates

  • combineMeasuredStates(curState: number, newState: any): number
  • Parameters

    • curState: number
    • newState: any

    Returns number

Static layoutChild

  • layoutChild(parent: View, child: View, left: number, top: number, right: number, bottom: number): void
  • Layout a child by taking into account its margins, horizontal and vertical alignments and a given bounds.

    Parameters

    • parent: View

      This parameter is not used. You can pass null.

    • child: View
    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

Static measureChild

  • measureChild(parent: View, child: View, widthMeasureSpec: number, heightMeasureSpec: number): object
  • Measure a child by taking into account its margins and a given measureSpecs.

    Parameters

    • parent: View

      This parameter is not used. You can pass null.

    • child: View

      The view to be measured.

    • widthMeasureSpec: number
    • heightMeasureSpec: number

    Returns object

    • measuredHeight: number

      The measured height that the parent layout specifies for this view.

    • measuredWidth: number

      The measured width that the parent layout specifies for this view.

Static resolveSizeAndState

  • resolveSizeAndState(size: number, specSize: number, specMode: number, childMeasuredState: number): number
  • Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec. Will take the desired size, unless a different size is imposed by the constraints. The returned value is a compound integer, with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting size is smaller than the size the view wants to be.

    Parameters

    • size: number
    • specSize: number
    • specMode: number
    • childMeasuredState: number

    Returns number

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