Frame | API - NativeScript

FrameBase

Frame

Summary

Constructors

constructor

Properties

defaultAnimatedNavigation

164 properties inherited from FrameBase

Click to expand

Methods

139 methods inherited from FrameBase

Click to expand

Constructors

constructor

new Frame(): Frame

inherited from

defined in @nativescript/core/data/observable/index.d.ts:76:1

Returns Frame

Properties

_animationInProgress

Private

_animationInProgress: boolean

defined in @nativescript/core/ui/frame/index.d.ts:162:1

_currentEntry

Private

_currentEntry: BackstackEntry

defined in @nativescript/core/ui/frame/index.d.ts:166:1

_executingContext

Private

_executingContext: NavigationContext

defined in @nativescript/core/ui/frame/index.d.ts:170:1

actionBarVisibility

actionBarVisibility: "auto" | "always" | "never"

defined in @nativescript/core/ui/frame/index.d.ts:85:8

android

android: AndroidFrame

defined in @nativescript/core/ui/frame/index.d.ts:130:1

animated

animated: boolean

defined in @nativescript/core/ui/frame/index.d.ts:109:1

backStack

backStack: BackstackEntry[]

defined in @nativescript/core/ui/frame/index.d.ts:91:1

currentEntry

currentEntry: NavigationEntry

defined in @nativescript/core/ui/frame/index.d.ts:103:1

currentPage

currentPage: Page

defined in @nativescript/core/ui/frame/index.d.ts:97:1

ios

ios: iOSFrame

defined in @nativescript/core/ui/frame/index.d.ts:135:1

navigationBarHeight

Private

navigationBarHeight: number

defined in @nativescript/core/ui/frame/index.d.ts:158:1

transition

transition: NavigationTransition

defined in @nativescript/core/ui/frame/index.d.ts:115:1

defaultAnimatedNavigation

Static

defaultAnimatedNavigation: boolean

defined in @nativescript/core/ui/frame/index.d.ts:120:8

defaultTransition

Static

defaultTransition: NavigationTransition

defined in @nativescript/core/ui/frame/index.d.ts:125:8

Methods

_findEntryForTag

Private

_findEntryForTag(fragmentTag: string): BackstackEntry

defined in @nativescript/core/ui/frame/index.d.ts:199:1

Parameter	Default	Description
`fragmentTag`		`string`

Returns BackstackEntry

_getIsAnimatedNavigation

Private

_getIsAnimatedNavigation(entry: NavigationEntry): boolean

defined in @nativescript/core/ui/frame/index.d.ts:178:1

Parameter	Default	Description
`entry`		`NavigationEntry`

Returns boolean

_getNavBarVisible

Private

_getNavBarVisible(page: Page): boolean

defined in @nativescript/core/ui/frame/index.d.ts:195:1

Parameter	Default	Description
`page`		`Page`

Returns boolean

_getNavigationTransition

Private

_getNavigationTransition(entry: NavigationEntry): NavigationTransition

defined in @nativescript/core/ui/frame/index.d.ts:182:1

Parameter	Default	Description
`entry`		`NavigationEntry`

Returns NavigationTransition

_processNavigationQueue

Private

_processNavigationQueue(page: Page): any

defined in @nativescript/core/ui/frame/index.d.ts:174:1

Parameter	Default	Description
`page`		`Page`

Returns any

_pushInFrameStack

Private

_pushInFrameStack(): any

defined in @nativescript/core/ui/frame/index.d.ts:207:1

Returns any

_pushInFrameStackRecursive

Private

_pushInFrameStackRecursive(): any

defined in @nativescript/core/ui/frame/index.d.ts:211:1

Returns any

_removeFromFrameStack

Private

_removeFromFrameStack(): any

defined in @nativescript/core/ui/frame/index.d.ts:215:1

Returns any

_updateActionBar

Private

_updateActionBar(page?: Page, disableNavBarAnimation?: boolean): any

defined in @nativescript/core/ui/frame/index.d.ts:186:1

Parameter	Default	Description
`page`		`Page`
`disableNavBarAnimation`		`boolean`

Returns any

_updateBackstack

Private

_updateBackstack(entry: BackstackEntry, navigationType: NavigationType): void

defined in @nativescript/core/ui/frame/index.d.ts:203:1

Parameter	Default	Description
`entry`		`BackstackEntry`
`navigationType`		`NavigationType`

Returns void

canGoBack

canGoBack(): boolean

defined in @nativescript/core/ui/frame/index.d.ts:55:1

Returns boolean

goBack

goBack(to?: BackstackEntry): any

defined in @nativescript/core/ui/frame/index.d.ts:50:1

Parameter	Default	Description
`to`		`BackstackEntry`

Returns any

isCurrent

Private

isCurrent(entry: BackstackEntry): boolean

defined in @nativescript/core/ui/frame/index.d.ts:142:1

Parameter	Default	Description
`entry`		`BackstackEntry`

Returns boolean

navigate

navigate(pageModuleName: string): any

defined in @nativescript/core/ui/frame/index.d.ts:65:1

Parameter	Default	Description
`pageModuleName`		`string`

Returns any

navigate(create: () => Page): any

defined in @nativescript/core/ui/frame/index.d.ts:71:1

Parameter	Default	Description
`create`		`() => Page`

Returns any

navigate(entry: NavigationEntry): any

defined in @nativescript/core/ui/frame/index.d.ts:80:1

Parameter	Default	Description
`entry`		`NavigationEntry`

Returns any

navigationQueueIsEmpty

Private

navigationQueueIsEmpty(): boolean

defined in @nativescript/core/ui/frame/index.d.ts:153:1

Returns boolean

on

on(eventNames: string, callback: (args: EventData) => void, thisArg?: any): any

defined in @nativescript/core/ui/frame/index.d.ts:224:1

Parameter	Default	Description
`eventNames`		`string`
`callback`		`(args: EventData) => void`
`thisArg`		`any`

Returns any

on(
  event: "navigatingTo",
  callback: (args: NavigationData) => void,
  thisArg?: any
): any

defined in @nativescript/core/ui/frame/index.d.ts:229:1

Parameter	Default	Description
`event`		`"navigatingTo"`
`callback`		`(args: NavigationData) => void`
`thisArg`		`any`

Returns any

on(
  event: "navigatedTo",
  callback: (args: NavigationData) => void,
  thisArg?: any
): any

defined in @nativescript/core/ui/frame/index.d.ts:234:1

Parameter	Default	Description
`event`		`"navigatedTo"`
`callback`		`(args: NavigationData) => void`
`thisArg`		`any`

Returns any

performNavigation

Private

performNavigation(navigationContext: NavigationContext): void

defined in @nativescript/core/ui/frame/index.d.ts:191:1

Parameter	Default	Description
`navigationContext`		`NavigationContext`

Returns void

setCurrent

Private

setCurrent(entry: BackstackEntry, navigationType: NavigationType): void

defined in @nativescript/core/ui/frame/index.d.ts:149:1

Parameter	Default	Description
`entry`		`BackstackEntry`
`navigationType`		`NavigationType`

Returns void

_stack

PrivateStatic

_stack(): Frame[]

defined in @nativescript/core/ui/frame/index.d.ts:44:1

Returns Frame[]

getFrameById

Static

getFrameById(id: string): Frame

defined in @nativescript/core/ui/frame/index.d.ts:23:1

Parameter	Default	Description
`id`		`string`

Returns Frame

goBack

Static

goBack(): any

defined in @nativescript/core/ui/frame/index.d.ts:34:1

Returns any

reloadPage

PrivateStatic

reloadPage(context?: ModuleContext): void

defined in @nativescript/core/ui/frame/index.d.ts:39:1

Parameter	Default	Description
`context`		`ModuleContext`

Returns void

topmost

Static

topmost(): Frame

defined in @nativescript/core/ui/frame/index.d.ts:28:1

Returns Frame

Summary #

Constructors

Properties

Methods

Constructors #

constructor #

Properties #

_animationInProgress #

_currentEntry #

_executingContext #

actionBarVisibility #

android #

animated #

backStack #

currentEntry #

currentPage #

ios #

navigationBarHeight #

transition #

defaultAnimatedNavigation #

defaultTransition #

Methods #

_findEntryForTag #

_getIsAnimatedNavigation #

_getNavBarVisible #

_getNavigationTransition #

_processNavigationQueue #

_pushInFrameStack #

_pushInFrameStackRecursive #

_removeFromFrameStack #

_updateActionBar #

_updateBackstack #

canGoBack #

goBack #

isCurrent #

navigate #

navigationQueueIsEmpty #

on #

performNavigation #

setCurrent #

_stack #

getFrameById #

goBack #

reloadPage #

topmost #

Summary

Constructors

constructor

Properties

_animationInProgress

_currentEntry

_executingContext

actionBarVisibility

android

animated

backStack

currentEntry

currentPage

ios

navigationBarHeight

transition

defaultAnimatedNavigation

defaultTransition

Methods

_findEntryForTag

_getIsAnimatedNavigation

_getNavBarVisible

_getNavigationTransition

_processNavigationQueue

_pushInFrameStack

_pushInFrameStackRecursive

_removeFromFrameStack

_updateActionBar

_updateBackstack

canGoBack

goBack

isCurrent

navigate

navigationQueueIsEmpty

on

performNavigation

setCurrent

_stack

getFrameById

goBack

reloadPage

topmost