`State`
type in module `ui.router.state`

Description

Definition object for states. Includes methods for manipulating the state heirarchy.

Usage

State(config);

Parameters

Param	Type	Details
config	Object	A configuration object hash that includes the results of user-supplied values, as well as values from `StateBuilder`.

Returns

Returns a new State object.

Methods

fqn()

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.
is(ref)

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
Param Type Details
ref Object
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.
root()

Returns the root node of this state's tree.

Returns
State
The root of this state's tree.