Used to control the visibility the Navigation Bar in iOS and the Action Bar in Android.
Gets the AndroidFrame object that represents the Android-specific APIs for this Frame. Valid when running on Android OS.
Gets or sets the dynamic elevation offset of the android view.
Gets or sets the elevation of the android view.
Gets or sets if navigation transitions should be animated.
Gets or sets the automation text of the view.
Gets the back stack of this instance.
Gets or sets the background style property.
Gets or sets the background color of the view.
Gets or sets the background image of the view.
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.
Gets or sets the bottom border color of the view.
Gets or sets the bottom left border radius of the view.
Gets or sets the bottom right border radius of the view.
Gets or sets the bottom border width of the view.
Gets or sets the border color of the view.
Gets or sets the left border color of the view.
Gets or sets the left border width of the view.
Gets or sets the border radius of the view.
Gets or sets the right border color of the view.
Gets or sets the right border width of the view.
Gets or sets the top border color of the view.
Gets or sets the top left border radius of the view.
Gets or sets the top right border radius of the view.
Gets or sets the top border width of the view.
Gets or sets the border width of the view.
Gets or sets the color of the view.
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.
Gets the NavigationEntry instance the Frame is currently navigated to.
Gets the Page instance the Frame is currently navigated to.
Gets or sets the desired height of the view.
Gets or sets the alignment of this view within its parent along the Horizontal axis.
Gets the iOSFrame object that represents the iOS-specific APIs for this Frame. Valid when running on iOS.
Gets or sets a value indicating whether the the view should totally ignore safe areas computation. This property is iOS specific. Default value: false
Instruct container view to expand beyond the safe area. This property is iOS specific. Default value: true
Enables or disables the iosOverflowSafeArea property for all children. This property is iOS specific. Default value: true
Gets or sets a value indicating whether the the view is enabled. This affects the appearance of the view.
Gets is layout is valid. This is a read-only property.
Gets or sets a value indicating whether the user can interact with the view. This does not affect the appearance of the view.
Gets or sets margin style property.
Specifies extra space on the bottom side of this view.
Specifies extra space on the left side of this view.
Specifies extra space on the right side of this view.
Specifies extra space on the top side of this view.
Gets or sets the minimum height the view may grow to.
Gets or sets the minimum width the view may grow to.
Returns the current modal view that this page is showing (is parent of), if any.
Gets or sets the opacity style property.
Gets or sets the X component of the origin point around which the view will be transformed. The default value is 0.5 representing the center of the view.
Gets or sets the Y component of the origin point around which the view will be transformed. The default value is 0.5 representing the center of the view.
Gets or sets the distance of the camera form the view perspective. Usually needed when rotating the view over the X or Y axis.
Gets or sets the rotate affine transform of the view along the Z axis.
Gets or sets the rotate affine transform of the view along the X axis.
Gets or sets the rotate affine transform of the view along the Y axis.
Gets or sets the scaleX affine transform of the view.
Gets or sets the scaleY affine transform of the view.
Gets or sets the default navigation transition for this frame.
Gets or sets the translateX affine transform of the view in device independent pixels.
Gets or sets the translateY affine transform of the view in device independent pixels.
Gets or sets the alignment of this view within its parent along the Vertical axis.
Gets or sets the visibility of the view.
Gets or sets the desired width of the view.
Gets or sets if navigation transitions should be animated globally.
Gets or sets the default NavigationTransition for all frames across the app.
String value used when hooking to layoutChanged event.
String value used when hooking to showingModally event.
String value used when hooking to shownModally event.
Internal method: Closes all modal views. Should be used
by plugins like nativescript-angular which
implement their own modal views service.
Return view bounds.
Internal method: Gets all modal views of the current view.
Obsolete: There is a new property system that does not rely on _getValue.
Checks whether the current view has specific view for an ancestor.
Called in android when native view is attached to window.
Called in android when native view is dettached from window.
iOS Only Internal method used to update various view details like background rerendering, border, etc.
Core logic for removing a child view from this instance. Used by the framework to handle lifecycle events more centralized. Do not use outside the UI Stack implementation.
Method is intended to be overridden by inheritors and used as "protected"
Called by layout method to cache view bounds.
Called by measure method to cache measureSpecs.
Obsolete: There is a new property system that does not rely on _setValue.
Updates styleScope or create new styleScope.
A valid css which will be added to current css.
A valid file name (from the application root) which contains a valid css.
Animates one or more properties of the view based on the supplied options.
Checks whether the goBack operation is available.
A valid file name (from the application root) which contains a valid css.
Creates an Animation object based on the supplied options.
Tries to focus the view. Returns a value indicating whether this view or one of its descendants actually took focus.
Returns the actual size of the view in device-independent pixels.
Returns the location of this view in the window coordinate system.
Returns the location of this view in the screen coordinate system.
Returns the location of this view in the otherView's coordinate system.
Returns the raw height component.
Returns the raw width component.
Returns the iOS safe area insets of this view.
Navigates to the previous entry (if any) in the back stack.
The backstack entry to navigate back to.
Android only check if gesture observers are attached
to check
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.
Called from onLayout when native view position is about to be changed.
Left position, relative to parent
Top position, relative to parent
Right position, relative to parent
Bottom position, relative to parent
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.
Horizontal space requirements as imposed by the parent
Vertical space requirements as imposed by the parent
Navigates to a Page instance as described by the module name. This method will require the module and will check for a Page property in the exports of the module.
The name of the module to require starting from the application root. For example if you want to navigate to page called "myPage.js" in a folder called "subFolder" and your root folder is "app" you can call navigate method like this: const frames = require("@nativescript/core/ui/frame"); frames.topmost().navigate("app/subFolder/myPage");
Creates a new Page instance using the provided callback and navigates to that Page.
The function to be used to create the new Page instance.
Navigates to a Page resolved by the provided NavigationEntry object. Since there are a couple of ways to specify a Page instance through an entry, there is a resolution priority: 1. entry.moduleName 2. entry.create()
The NavigationEntry instance.
Removes listener(s) for the specified event name.
Comma delimited names of the events or gesture types the specified listener is associated with.
An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
String corresponding to events (e.g.
"propertyChange"). Optionally could be used
more events separated by , (e.g.
"propertyChange", "change").
Callback function which will be executed when event is raised.
An optional parameter which will be used as
this context for callback execution.
Raised when navigation to the page has started.
Raised when navigation to the page has finished.
Derived classes can override this method to handle Android back button press.
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.
Left position, relative to parent
Top position, relative to parent
Right position, relative to parent
Bottom position, relative to parent
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).
horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
to set as current
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.
The measured width of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.
The measured height of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.
Android only to set the touch listener
Gets a frame by id.
Navigates back using the navigation hierarchy (if any). Updates the Frame stack as needed. This method will start from the topmost Frame and will recursively search for an instance that has the canGoBack operation available.
Layout a child by taking into account its margins, horizontal and vertical alignments and a given bounds.
This parameter is not used. You can pass null.
Left position, relative to parent
Top position, relative to parent
Right position, relative to parent
Bottom position, relative to parent
Measure a child by taking into account its margins and a given measureSpecs.
This parameter is not used. You can pass null.
The view to be measured.
The measured height that the parent layout specifies for this view.
The measured width that the parent layout specifies for this view.
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 MEASURED_SIZE_MASK bits and optionally the bit MEASURED_STATE_TOO_SMALL set if the resulting size is smaller than the size the view wants to be.
Gets the topmost frame in the frames stack. An application will typically has one frame instance. Multiple frames handle nested (hierarchical) navigation scenarios.
Represents the logical View unit that is responsible for navigation within an application. Nested frames are supported, enabling hierarchical navigation scenarios.