Class Sequence

class: Sequence
classdesc: Represents a sequence of ordered nodes.

Hierarchy

Sequence

Index

Constructors

constructor

Properties

_key
_keys

Accessors

key
keys

Methods

Constructors

constructor

new Sequence(apiNavImS: IAPINavImS): Sequence

- Defined in graph/Sequence.ts:14
Create a new sequene instance.

Parameters
- apiNavImS: IAPINavImS
  
  Raw sequence data.
Returns Sequence

Properties

Private _key

_key: string

Private _keys

_keys: string[]

Accessors

key

get key(): string

- Defined in graph/Sequence.ts:31
Get key.

Returns string

Unique sequence key.

keys

get keys(): string[]

- Defined in graph/Sequence.ts:40
Get keys.

Returns string[]

Array of ordered node keys in the sequence.

Methods

findNextKey

findNextKey(key: string): string

- Defined in graph/Sequence.ts:51
Find the next node key in the sequence with respect to the provided node key.

Parameters
- key: string
  
  Reference node key.
Returns string

Next key in sequence if it exists, null otherwise.

findPrevKey

findPrevKey(key: string): string

- Defined in graph/Sequence.ts:68
Find the previous node key in the sequence with respect to the provided node key.

Parameters
- key: string
  
  Reference node key.
Returns string

Previous key in sequence if it exists, null otherwise.

Generated using TypeDoc