NativeScript Docs
Core Modules
NativeScript Angular
NativeScript UI
Article title
view on GitHub
Search
Preparing search index...
The search index is not available
NativeScript Angular
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
"router/ns-location-strategy"
NSLocationStrategy
Class NSLocationStrategy
Globals
"router/ns-
location-
strategy"
NSLocation
Strategy
constructor
_current
Navigation
Options
_modal
Navigation
Depth
current
Outlet
current
Url
Tree
frame
Service
outlets
pop
State
Callbacks
_begin
Back
Page
Navigation
_begin
Modal
Navigation
_begin
Page
Navigation
_close
Modal
Navigation
_finish
Back
Page
Navigation
_get
Outlets
_set
Navigation
Options
back
call
Pop
State
can
GoBack
clear
Outlet
create
Outlet
find
Outlet
find
Outlet
ByModal
forward
get
Base
Href
get
Outlet
ByFrame
get
Outlet
Key
get
Path
ByOutlets
get
Route
Full
Path
get
Segment
Group
ByOutlet
get
Segment
Group
Full
Path
ng
OnDestroy
on
Pop
State
path
prepare
External
Url
push
State
push
State
Internal
replace
State
to
String
update
Outlet
Frame
update
Parents
States
update
Segment
Group
update
States
upsert
Modal
Outlet
Hierarchy
LocationStrategy
Index
Constructors
constructor
Properties
_current
Navigation
Options
_modal
Navigation
Depth
current
Outlet
current
Url
Tree
frame
Service
outlets
pop
State
Callbacks
Methods
_begin
Back
Page
Navigation
_begin
Modal
Navigation
_begin
Page
Navigation
_close
Modal
Navigation
_finish
Back
Page
Navigation
_get
Outlets
_set
Navigation
Options
back
call
Pop
State
can
GoBack
clear
Outlet
create
Outlet
find
Outlet
find
Outlet
ByModal
forward
get
Base
Href
get
Outlet
ByFrame
get
Outlet
Key
get
Path
ByOutlets
get
Route
Full
Path
get
Segment
Group
ByOutlet
get
Segment
Group
Full
Path
ng
OnDestroy
on
Pop
State
path
prepare
External
Url
push
State
push
State
Internal
replace
State
to
String
update
Outlet
Frame
update
Parents
States
update
Segment
Group
update
States
upsert
Modal
Outlet
Constructors
constructor
new NSLocation
Strategy
(
frameService
:
FrameService
)
:
NSLocationStrategy
Parameters
frameService:
FrameService
Returns
NSLocationStrategy
Properties
Private
_current
Navigation
Options
_current
Navigation
Options
:
NavigationOptions
_modal
Navigation
Depth
_modal
Navigation
Depth
:
number
Private
current
Outlet
current
Outlet
:
Outlet
Private
current
Url
Tree
current
Url
Tree
:
UrlTree
Private
frame
Service
frame
Service
:
FrameService
Private
outlets
outlets
:
Array
<
Outlet
>
Private
pop
State
Callbacks
pop
State
Callbacks
:
function[]
Methods
_begin
Back
Page
Navigation
_begin
Back
Page
Navigation
(
frame
:
Frame
)
:
void
Parameters
frame:
Frame
Returns
void
_begin
Modal
Navigation
_begin
Modal
Navigation
(
frame
:
Frame
)
:
void
Parameters
frame:
Frame
Returns
void
_begin
Page
Navigation
_begin
Page
Navigation
(
frame
:
Frame
)
:
NavigationOptions
Parameters
frame:
Frame
Returns
NavigationOptions
_close
Modal
Navigation
_close
Modal
Navigation
(
)
:
void
Returns
void
_finish
Back
Page
Navigation
_finish
Back
Page
Navigation
(
frame
:
Frame
)
:
void
Parameters
frame:
Frame
Returns
void
_get
Outlets
_get
Outlets
(
)
:
Array
<
Outlet
>
Returns
Array
<
Outlet
>
_set
Navigation
Options
_set
Navigation
Options
(
options
:
NavigationOptions
)
:
void
Parameters
options:
NavigationOptions
Returns
void
back
back
(
outlet
?:
Outlet
, frame
?:
Frame
)
:
void
Parameters
Optional
outlet:
Outlet
Optional
frame:
Frame
Returns
void
Private
call
Pop
State
call
Pop
State
(
state
:
LocationState
, pop
?:
boolean
, outlet
?:
Outlet
)
:
void
Parameters
state:
LocationState
Default value
pop:
boolean
= true
Optional
outlet:
Outlet
Returns
void
can
GoBack
can
GoBack
(
outlet
?:
Outlet
)
:
boolean
Parameters
Optional
outlet:
Outlet
Returns
boolean
clear
Outlet
clear
Outlet
(
frame
:
Frame
)
:
void
Parameters
frame:
Frame
Returns
void
Private
create
Outlet
create
Outlet
(
outletKey
:
string
, path
:
string
, segmentGroup
:
any
, parent
:
Outlet
, modalNavigation
?:
number
, queryParams
?:
Params
)
:
Outlet
Parameters
outletKey:
string
path:
string
segmentGroup:
any
parent:
Outlet
Optional
modalNavigation:
number
Default value
queryParams:
Params
= {}
Returns
Outlet
find
Outlet
find
Outlet
(
outletKey
:
string
, activatedRouteSnapshot
?:
ActivatedRouteSnapshot
)
:
Outlet
Parameters
outletKey:
string
Optional
activatedRouteSnapshot:
ActivatedRouteSnapshot
Returns
Outlet
Private
find
Outlet
ByModal
find
Outlet
ByModal
(
modalNavigation
:
number
, isShowingModal
?:
boolean
)
:
Outlet
Parameters
modalNavigation:
number
Optional
isShowingModal:
boolean
Returns
Outlet
forward
forward
(
)
:
void
Returns
void
get
Base
Href
get
Base
Href
(
)
:
string
Returns
string
Private
get
Outlet
ByFrame
get
Outlet
ByFrame
(
frame
:
Frame
)
:
Outlet
Parameters
frame:
Frame
Returns
Outlet
Private
get
Outlet
Key
get
Outlet
Key
(
path
:
string
, outletName
:
string
)
:
string
Parameters
path:
string
outletName:
string
Returns
string
get
Path
ByOutlets
get
Path
ByOutlets
(
urlSegmentGroup
:
any
)
:
string
Parameters
urlSegmentGroup:
any
Returns
string
get
Route
Full
Path
get
Route
Full
Path
(
currentRoute
:
any
)
:
string
Parameters
currentRoute:
any
Returns
string
Private
get
Segment
Group
ByOutlet
get
Segment
Group
ByOutlet
(
outlet
:
Outlet
)
:
UrlSegmentGroup
Parameters
outlet:
Outlet
Returns
UrlSegmentGroup
get
Segment
Group
Full
Path
get
Segment
Group
Full
Path
(
segmentGroup
:
UrlSegmentGroup
)
:
string
Parameters
segmentGroup:
UrlSegmentGroup
Returns
string
ng
OnDestroy
ng
OnDestroy
(
)
:
void
Returns
void
on
Pop
State
on
Pop
State
(
fn
:
function
)
:
void
Parameters
fn:
function
(
_
:
any
)
:
any
Parameters
_:
any
Returns
any
Returns
void
path
path
(
)
:
string
Returns
string
prepare
External
Url
prepare
External
Url
(
internal
:
string
)
:
string
Parameters
internal:
string
Returns
string
push
State
push
State
(
state
:
any
, title
:
string
, url
:
string
, queryParams
:
string
)
:
void
Parameters
state:
any
title:
string
url:
string
queryParams:
string
Returns
void
push
State
Internal
push
State
Internal
(
state
:
any
, title
:
string
, url
:
string
, queryParams
:
string
)
:
void
Parameters
state:
any
title:
string
url:
string
queryParams:
string
Returns
void
replace
State
replace
State
(
state
:
any
, title
:
string
, url
:
string
, queryParams
:
string
)
:
void
Parameters
state:
any
title:
string
url:
string
queryParams:
string
Returns
void
to
String
to
String
(
)
:
string
Returns
string
update
Outlet
Frame
update
Outlet
Frame
(
outlet
:
Outlet
, frame
:
Frame
, isEmptyOutletFrame
:
boolean
)
:
void
Parameters
outlet:
Outlet
frame:
Frame
isEmptyOutletFrame:
boolean
Returns
void
Private
update
Parents
States
update
Parents
States
(
outlet
:
Outlet
, newSegmentGroup
:
UrlSegmentGroup
)
:
void
Parameters
outlet:
Outlet
newSegmentGroup:
UrlSegmentGroup
Returns
void
Private
update
Segment
Group
update
Segment
Group
(
rootNode
:
any
, oldSegmentGroup
:
UrlSegmentGroup
, newSegmentGroup
:
UrlSegmentGroup
)
:
void
Parameters
rootNode:
any
oldSegmentGroup:
UrlSegmentGroup
newSegmentGroup:
UrlSegmentGroup
Returns
void
Private
update
States
update
States
(
outlet
:
Outlet
, currentSegmentGroup
:
UrlSegmentGroup
, queryParams
:
Params
)
:
boolean
Parameters
outlet:
Outlet
currentSegmentGroup:
UrlSegmentGroup
queryParams:
Params
Returns
boolean
Private
upsert
Modal
Outlet
upsert
Modal
Outlet
(
parentOutlet
:
Outlet
, segmentedGroup
:
UrlSegmentGroup
, queryParams
:
Params
)
:
void
Parameters
parentOutlet:
Outlet
segmentedGroup:
UrlSegmentGroup
queryParams:
Params
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