NavigationButton | NativeScript

Represents the navigation (a.k.a. "back") button.

Hierarchy

ActionItem

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NavigationButton(): NavigationButton

Inherited from ActionItem.constructor
- Defined in ui/core/view-base/index.ts:337
Returns NavigationButton

Properties

_automaticallyAdjustsScrollViewInsets

_automaticallyAdjustsScrollViewInsets: boolean

_context

_context: any

_cssState

_cssState: CssState

_defaultPaddingBottom

_defaultPaddingBottom: number

_defaultPaddingLeft

_defaultPaddingLeft: number

_defaultPaddingRight

_defaultPaddingRight: number

_defaultPaddingTop

_defaultPaddingTop: number

_domId

_domId: number

_ignoreFlexMinWidthHeightReset

_ignoreFlexMinWidthHeightReset: boolean

_isAddedToNativeVisualTree

_isAddedToNativeVisualTree: boolean

_isPaddingRelative

_isPaddingRelative: boolean

_isStyleScopeHost

_isStyleScopeHost: boolean

_isViewBase

_isViewBase: boolean

_moduleName

_moduleName: string

Optional Private _navigationItem

_navigationItem: any

_oldBottom

_oldBottom: number

_oldLeft

_oldLeft: number

_oldRight

_oldRight: number

_oldTop

_oldTop: number

_styleScope

_styleScope: StyleScope

_suspendNativeUpdatesCount

_suspendNativeUpdatesCount: number

_suspendedUpdates

_suspendedUpdates: object

Type declaration

[propertyName: string]: Property<ViewBase, any> | CssProperty<Style, any> | CssAnimationProperty<Style, any>

actionBar

actionBar: ActionBar

Gets the action bar that contains the action item.

actionView

actionView: View

Gets or sets the custom action view of the action item.

alignSelf

alignSelf: AlignSelf

android

android: AndroidActionItemSettings

Gets the Android specific options of the action item.

bindingContext

bindingContext: any

className

className: string

col

col: number

colSpan

colSpan: number

column

column: number

columnSpan

columnSpan: number

cssClasses

cssClasses: Set<string>

cssPseudoClasses

cssPseudoClasses: Set<string>

dock

dock: DockType

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

flexGrow

flexGrow: number

flexShrink

flexShrink: number

flexWrapBefore

flexWrapBefore: boolean

icon

icon: string

Gets or sets the icon of the action item.

id

id: string

ios

ios: IOSActionItemSettings

Gets the iOS specific options of the action item.

isCollapsed

isCollapsed: any

left

left: LengthType

nativeViewProtected

nativeViewProtected: any

order

order: number

parent

parent: ViewBase

recycleNativeView

recycleNativeView: "auto" | "always" | "never"

reusable

reusable: boolean

row

row: number

rowSpan

rowSpan: number

text

text: string

Gets or sets the text of the action item.

top

top: LengthType

viewController

viewController: any

visibility

visibility: string

Gets or sets the visibility of the action item.

Static createdEvent

createdEvent: string

Static loadedEvent

loadedEvent: string

Static propertyChangeEvent

propertyChangeEvent: string

Static unloadedEvent

unloadedEvent: string

Accessors

class

get (): string
set (v: string): void

- Defined in ui/core/view-base/index.ts:392
Returns string
- Defined in ui/core/view-base/index.ts:395
Parameters
- v: string
Returns void

isLoaded

get (): boolean

- Defined in ui/core/view-base/index.ts:388
Returns boolean

nativeView

get (): any
set (value: any): void

- Defined in ui/core/view-base/index.ts:354
Returns any
- Defined in ui/core/view-base/index.ts:358
Parameters
- value: any
Returns void

parentNode

get (): ViewBase
set (node: ViewBase): void

- Defined in ui/core/view-base/index.ts:347
Returns ViewBase
- Defined in ui/core/view-base/index.ts:350
Parameters
- node: ViewBase
Returns void

style

get (): Style
set (inlineStyle: Style): void

- Defined in ui/core/view-base/index.ts:367
Returns Style
- Defined in ui/core/view-base/index.ts:370
Parameters
- inlineStyle: Style
Returns void

typeName

get (): string

- Defined in ui/core/view-base/index.ts:363
Returns string

Methods

_addView

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

Inherited from ActionItem._addView
- Defined in ui/core/view-base/index.ts:675
Parameters
- view: ViewBase
- Optional atIndex: number
Returns void

_addViewCore

_addViewCore(view: ViewBase, atIndex?: number): void

Inherited from ActionItem._addViewCore
- Defined in ui/core/view-base/index.ts:699
Parameters
- view: ViewBase
- Optional atIndex: number
Returns void

_addViewToNativeVisualTree

_addViewToNativeVisualTree(view: ViewBase, atIndex?: number): boolean

Inherited from ActionItem._addViewToNativeVisualTree
- Defined in ui/core/view-base/index.ts:980
Method is intended to be overridden by inheritors and used as "protected".

Parameters
- view: ViewBase
- Optional atIndex: number
Returns boolean

_applyXmlAttribute

_applyXmlAttribute(attribute: string, value: string): boolean

Inherited from ActionItem._applyXmlAttribute
- Defined in ui/core/view-base/index.ts:1015
deprecated

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.

Parameters
- attribute: string
- value: string
Returns boolean

_batchUpdate

_batchUpdate<T>(callback: function): T

Inherited from ActionItem._batchUpdate
- Defined in ui/core/view-base/index.ts:496
Type parameters
- T
Parameters
- callback: function
  - - (): T
    - Returns T
Returns T

_childIndexToNativeChildIndex

_childIndexToNativeChildIndex(index?: number): number

Inherited from ActionItem._childIndexToNativeChildIndex
- Defined in ui/core/view-base/index.ts:973
Parameters
- Optional index: number
Returns number

_createPropertyChangeData

_createPropertyChangeData(propertyName: string, value: any, oldValue?: any): PropertyChangeData

Inherited from ActionItem._createPropertyChangeData
- Defined in data/observable/index.ts:313
Parameters
- propertyName: string
- value: any
- Optional oldValue: any
Returns PropertyChangeData

_dialogClosed

_dialogClosed(): void

Inherited from ActionItem._dialogClosed
- Defined in ui/core/view-base/index.ts:1111
Returns void

_emit

_emit(eventNames: string): void

Inherited from ActionItem._emit
- Defined in data/observable/index.ts:323
Parameters
- eventNames: string
Returns void

_goToVisualState

_goToVisualState(state: string): void

Inherited from ActionItem._goToVisualState
- Defined in ui/core/view-base/index.ts:995
Parameters
- state: string
Returns void

_inheritStyleScope

_inheritStyleScope(styleScope: StyleScope): void

Inherited from ActionItem._inheritStyleScope
- Defined in ui/core/view-base/index.ts:1080
Parameters
- styleScope: StyleScope
Returns void

_layoutParent

_layoutParent(): void

Inherited from ActionItem._layoutParent
- Defined in ui/core/view-base/index.ts:468
Returns void

_onCssStateChange

_onCssStateChange(): void

Inherited from ActionItem._onCssStateChange
- Defined in ui/core/view-base/index.ts:1071
Returns void

_onRootViewReset

_onRootViewReset(): void

Inherited from ActionItem._onRootViewReset
- Defined in ui/core/view-base/index.ts:1119
Returns void

_parentChanged

_parentChanged(oldParent: ViewBase): void

Inherited from ActionItem._parentChanged
- Defined in ui/core/view-base/index.ts:1036
Parameters
- oldParent: ViewBase
Returns void

Private _raiseTap

_raiseTap(): void

Inherited from ActionItem._raiseTap
- Defined in ui/action-bar/index.d.ts:148
Returns void

_removeView

_removeView(view: ViewBase): void

Inherited from ActionItem._removeView
- Defined in ui/core/view-base/index.ts:732
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.

Parameters
- view: ViewBase
Returns void

_removeViewCore

_removeViewCore(view: ViewBase): void

Inherited from ActionItem._removeViewCore
- Defined in ui/core/view-base/index.ts:753
Method is intended to be overridden by inheritors and used as "protected"

Parameters
- view: ViewBase
Returns void

_removeViewFromNativeVisualTree

_removeViewFromNativeVisualTree(view: ViewBase): void

Inherited from ActionItem._removeViewFromNativeVisualTree
- Defined in ui/core/view-base/index.ts:991
Method is intended to be overridden by inheritors and used as "protected"

Parameters
- view: ViewBase
Returns void

_resumeNativeUpdates

_resumeNativeUpdates(type: SuspendType): void

Inherited from ActionItem._resumeNativeUpdates
- Defined in ui/core/view-base/index.ts:481
Parameters
- type: SuspendType
Returns void

_setupAsRootView

_setupAsRootView(context: any): void

Inherited from ActionItem._setupAsRootView
- Defined in ui/core/view-base/index.ts:796
Parameters
- context: any
Returns void

_setupUI

_setupUI(context: any, atIndex?: number, parentIsLoaded?: boolean): void

Inherited from ActionItem._setupUI
- Defined in ui/core/view-base/index.ts:801
Parameters
- context: any
- Optional atIndex: number
- Optional parentIsLoaded: boolean
Returns void

_shouldDelayLayout

_shouldDelayLayout(): boolean

Inherited from ActionItem._shouldDelayLayout
- Defined in ui/core/view-base/index.ts:719
Returns boolean

_suspendNativeUpdates

_suspendNativeUpdates(type: SuspendType): void

Inherited from ActionItem._suspendNativeUpdates
- Defined in ui/core/view-base/index.ts:474
Parameters
- type: SuspendType
Returns void

_tearDownUI

_tearDownUI(force?: boolean): void

Inherited from ActionItem._tearDownUI
- Defined in ui/core/view-base/index.ts:912
Parameters
- Optional force: boolean
Returns void

addEventListener

addEventListener(eventNames: string, callback: function, thisArg?: any): void

Inherited from ActionItem.addEventListener
- Defined in data/observable/index.ts:109
Parameters
- eventNames: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

addPseudoClass

addPseudoClass(name: string): void

Inherited from ActionItem.addPseudoClass
- Defined in ui/core/view-base/index.ts:568
Parameters
- name: string
Returns void

bind

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

Inherited from ActionItem.bind
- Defined in ui/core/view-base/index.ts:597
Parameters
- options: BindingOptions
- source: Object = ...
Returns void

callLoaded

callLoaded(): void

Inherited from ActionItem.callLoaded
- Defined in ui/core/view-base/index.ts:536
Returns void

callUnloaded

callUnloaded(): void

Inherited from ActionItem.callUnloaded
- Defined in ui/core/view-base/index.ts:540
Returns void

closeModal

closeModal(...args: any[]): void

Inherited from ActionItem.closeModal
- Defined in ui/core/view-base/index.ts:1104
Parameters
- Rest ...args: any[]
Returns void

createNativeView

createNativeView(): Object

Inherited from ActionItem.createNativeView
- Defined in ui/core/view-base/index.ts:761
Returns Object

deletePseudoClass

deletePseudoClass(name: string): void

Inherited from ActionItem.deletePseudoClass
- Defined in ui/core/view-base/index.ts:579
Parameters
- name: string
Returns void

destroyNode

destroyNode(forceDestroyChildren?: boolean): void

Inherited from ActionItem.destroyNode
- Defined in ui/core/view-base/index.ts:906
Parameters
- Optional forceDestroyChildren: boolean
Returns void

disposeNativeView

disposeNativeView(): void

Inherited from ActionItem.disposeNativeView
- Defined in ui/core/view-base/index.ts:765
Returns void

eachChild

eachChild(callback: function): void

Inherited from ActionItem.eachChild
- Defined in ui/core/view-base/index.ts:670
Parameters
- callback: function
  - - (child: ViewBase): boolean
    - Parameters
      - child: ViewBase
      Returns boolean
Returns void

ensureDomNode

ensureDomNode(): void

Inherited from ActionItem.ensureDomNode
- Defined in ui/core/view-base/index.ts:415
Returns void

get

get(name: string): any

Inherited from ActionItem.get
- Defined in data/observable/index.ts:56
Parameters
- name: string
Returns any

getViewByDomId

getViewByDomId<T>(domId: number): T

Inherited from ActionItem.getViewByDomId
- Defined in ui/core/view-base/index.ts:403
Type parameters
- T: ViewBase<T>
Parameters
- domId: number
Returns T

getViewById

getViewById<T>(id: string): T

Inherited from ActionItem.getViewById
- Defined in ui/core/view-base/index.ts:399
Type parameters
- T: ViewBase<T>
Parameters
- id: string
Returns T

hasListeners

hasListeners(eventName: string): boolean

Inherited from ActionItem.hasListeners
- Defined in data/observable/index.ts:309
Parameters
- eventName: string
Returns boolean

initNativeView

initNativeView(): void

Inherited from ActionItem.initNativeView
- Defined in ui/core/view-base/index.ts:769
Returns void

loadView

loadView(view: ViewBase): void

Inherited from ActionItem.loadView
- Defined in ui/core/view-base/index.ts:713
Parameters
- view: ViewBase
Returns void

notify

notify<T>(data: T): void

Inherited from ActionItem.notify
- Defined in data/observable/index.ts:274
Type parameters
- T: NotifyData<T>
Parameters
- data: T
Returns void

notifyPropertyChange

notifyPropertyChange(name: string, value: any, oldValue?: any): void

Inherited from ActionItem.notifyPropertyChange
- Defined in data/observable/index.ts:305
Parameters
- name: string
- value: any
- Optional oldValue: any
Returns void

off

off(eventNames: string, callback?: any, thisArg?: any): void

Inherited from ActionItem.off
- Defined in data/observable/index.ts:105
Parameters
- eventNames: string
- Optional callback: any
- Optional thisArg: any
Returns void

on

on(eventNames: string, callback: function): any
on(event: "tap", callback: function): any

Inherited from ActionItem.on
- Defined in ui/action-bar/index.d.ts:137
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

Parameters
- eventNames: string
  
  String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change").
- callback: function
  
  Callback function which will be executed when event is raised.
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
Returns any
Inherited from ActionItem.on
- Defined in ui/action-bar/index.d.ts:142
Raised when a tap event occurs.

Parameters
- event: "tap"
- callback: function
  - - (args: EventData): void
    - Parameters
      - args: EventData
      Returns void
Returns any

onLoaded

onLoaded(): void

Inherited from ActionItem.onLoaded
- Defined in ui/core/view-base/index.ts:429
Returns void

onResumeNativeUpdates

onResumeNativeUpdates(): void

Inherited from ActionItem.onResumeNativeUpdates
- Defined in ui/core/view-base/index.ts:1051
Returns void

onUnloaded

onUnloaded(): void

Inherited from ActionItem.onUnloaded
- Defined in ui/core/view-base/index.ts:449
Returns void

once

once(event: string, callback: function, thisArg?: any): void

Inherited from ActionItem.once
- Defined in data/observable/index.ts:92
Parameters
- event: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

removeEventListener

removeEventListener(eventNames: string, callback?: any, thisArg?: any): void

Inherited from ActionItem.removeEventListener
- Defined in data/observable/index.ts:130
Parameters
- eventNames: string
- Optional callback: any
- Optional thisArg: any
Returns void

requestLayout

requestLayout(): void

Inherited from ActionItem.requestLayout
- Defined in ui/core/view-base/index.ts:662
Returns void

resetNativeView

resetNativeView(): void

Inherited from ActionItem.resetNativeView
- Defined in ui/core/view-base/index.ts:773
Returns void

set

set(name: string, value: any): void

Inherited from ActionItem.set
- Defined in ui/core/view-base/index.ts:424
Parameters
- name: string
- value: any
Returns void

setInlineStyle

setInlineStyle(style: string): void

Inherited from ActionItem.setInlineStyle
- Defined in ui/core/view-base/index.ts:1027
Parameters
- style: string
Returns void

setNativeView

setNativeView(value: any): void

Inherited from ActionItem.setNativeView
- Defined in ui/core/view-base/index.ts:888
Parameters
- value: any
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from ActionItem.setProperty
- Defined in data/observable/index.ts:72
Parameters
- name: string
- value: any
Returns void

showModal

showModal(...args: any[]): ViewBase

Inherited from ActionItem.showModal
- Defined in ui/core/view-base/index.ts:1098
Parameters
- Rest ...args: any[]
Returns ViewBase

toString

toString(): string

Inherited from ActionItem.toString
- Defined in ui/core/view-base/index.ts:1056
Returns string

unbind

unbind(property: string): void

Inherited from ActionItem.unbind
- Defined in ui/core/view-base/index.ts:626
Parameters
- property: string
Returns void

unloadView

unloadView(view: ViewBase): void

Inherited from ActionItem.unloadView
- Defined in ui/core/view-base/index.ts:723
Parameters
- view: ViewBase
Returns void

Static addEventListener

addEventListener(eventName: string, callback: any, thisArg?: any): void

Inherited from ActionItem.addEventListener
- Defined in data/observable/index.ts:235
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static off

off(eventName: string, callback?: any, thisArg?: any): void

Inherited from ActionItem.off
- Defined in data/observable/index.ts:183
Parameters
- eventName: string
- Optional callback: any
- Optional thisArg: any
Returns void

Static on

on(eventName: string, callback: any, thisArg?: any): void

Inherited from ActionItem.on
- Defined in data/observable/index.ts:160
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static once

once(eventName: string, callback: any, thisArg?: any): void

Inherited from ActionItem.once
- Defined in data/observable/index.ts:164
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static removeEventListener

removeEventListener(eventName: string, callback?: any, thisArg?: any): void

Inherited from ActionItem.removeEventListener
- Defined in data/observable/index.ts:187
Parameters
- eventName: string
- Optional callback: any
- Optional thisArg: any
Returns void

Class NavigationButton

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NavigationButton

Properties

_automaticallyAdjustsScrollViewInsets

_context

_cssState

_defaultPaddingBottom

_defaultPaddingLeft

_defaultPaddingRight

_defaultPaddingTop

_domId

_ignoreFlexMinWidthHeightReset

_isAddedToNativeVisualTree

_isPaddingRelative

_isStyleScopeHost

_isViewBase

_moduleName

Optional Private _navigationItem

_oldBottom

_oldLeft

_oldRight

_oldTop

_styleScope

_suspendNativeUpdatesCount

_suspendedUpdates

Type declaration

[propertyName: string]: Property<ViewBase, any> | CssProperty<Style, any> | CssAnimationProperty<Style, any>

actionBar

actionView

alignSelf

android

bindingContext

className

col

colSpan

column

columnSpan

cssClasses

cssPseudoClasses

dock

domNode

effectiveBorderBottomWidth

effectiveBorderLeftWidth

effectiveBorderRightWidth

effectiveBorderTopWidth

effectiveHeight

effectiveLeft

effectiveMarginBottom

effectiveMarginLeft

effectiveMarginRight

effectiveMarginTop

effectiveMinHeight

effectiveMinWidth

effectivePaddingBottom

effectivePaddingLeft

effectivePaddingRight

effectivePaddingTop

effectiveTop

effectiveWidth

flexGrow

flexShrink

flexWrapBefore

icon

id

ios

isCollapsed

left

nativeViewProtected

order

parent

recycleNativeView

reusable