State | UI-Router

Class State

ngdoc: object
name: ui.router.state.type:State
description: Definition object for states. Includes methods for manipulating the state heirarchy.
param: A configuration object hash that includes the results of user-supplied values, as well as values from StateBuilder.
returns: Returns a new State object.

Hierarchy

State

Index

Constructors

constructor

Properties

Methods

Constructors

new State(config?: StateDeclaration): State

Parameters
- config Optional: StateDeclaration
Returns State
- Defined in state/stateObject.ts:53

Properties

abstract: boolean

data: any

includes: object

Type declaration

[name: string]: boolean

lazyLoad: function

Type declaration

- (transition: Transition): Promise<StateDeclaration[]>
- Parameters
  - transition: Transition
  Returns Promise<StateDeclaration[]>

name: string

navigable: State

onEnter: TransitionStateHookFn

onExit: TransitionStateHookFn

onRetain: TransitionStateHookFn

params: object

Type declaration

[key: string]: Param

parent: State

path: State[]

redirectTo: string | function | object

resolvables: Resolvable[]

resolve: object | Array<any>

resolvePolicy: any

self: StateDeclaration

url: UrlMatcher

views: object

Type declaration

[key: string]: _ViewDeclaration

Methods

fqn(): string

ngdoc

function

name

ui.router.state.type:State#fqn

methodof

ui.router.state.type:State

description

Returns the fully-qualified name of the state, based on its current position in the tree.

Returns string
:
Returns a dot-separated name of the state.
- Defined in state/stateObject.ts:89

is(ref: State | StateDeclaration | string): boolean

ngdoc

function

name

ui.router.state.type:State#is

methodof

ui.router.state.type:State

description

Compares the identity of the state against the passed value, which is either an object reference to the actual State instance, the original definition object passed to $stateProvider.state(), or the fully-qualified name.

Parameters
- ref: State | StateDeclaration | string
  :
  
  Can be one of (a) a State instance, (b) an object that was passed into $stateProvider.state(), (c) the fully-qualified name of a state as a string.
Returns boolean
:
Returns true if ref matches the current State instance.
- Defined in state/stateObject.ts:75

parameter(id: string, opts?: any): Param

Parameters
- id: string
- opts Default value: any = {}
Returns Param
- Defined in state/stateObject.ts:115

parameters(opts?: object): Param[]

Parameters
- opts Optional: object
  - inherit: boolean
Returns Param[]
- Defined in state/stateObject.ts:109

root(): State

ngdoc

function

name

ui.router.state.type:State#root

methodof

ui.router.state.type:State

description

Returns the root node of this state's tree.

Returns State
:
The root of this state's tree.
- Defined in state/stateObject.ts:105

toString(): string

Returns string
- Defined in state/stateObject.ts:123

Generated using TypeDoc