Class StateAPI

This class works with the REST API and interfaces with the Neuroglancer state.

Hierarchy

StateAPI

Index

Constructors

Properties

stateUrl userUrl

Methods

getState getUser newState saveAnnotations saveState segmentVolume

Constructors

constructor

new StateAPI(userUrl: string, stateUrl: string): StateAPI
Parameters
- userUrl: string
- stateUrl: string
Returns StateAPI
- Defined in src/neuroglancer/services/state_loader.ts:146

Properties

`Private` stateUrl

stateUrl: string

`Private` userUrl

userUrl: string

Methods

getState

getState(stateID: string | number): Promise<State>
Parameters
- stateID: string | number
Returns Promise<State>
- Defined in src/neuroglancer/services/state_loader.ts:160

getUser

getUser(): Promise<User>
Returns Promise<User>
- Defined in src/neuroglancer/services/state_loader.ts:148

newState

newState(state: State): Promise<State>
Parameters
- state: State
Returns Promise<State>
- Defined in src/neuroglancer/services/state_loader.ts:189

saveAnnotations

saveAnnotations(stateId: string | number, layerName: string): Promise<any>
Parameters
- stateId: string | number
- layerName: string
Returns Promise<any>
- Defined in src/neuroglancer/services/state_loader.ts:265

saveState

saveState(stateID: string | number, state: State): Promise<State>
Parameters
- stateID: string | number
- state: State
Returns Promise<State>
- Defined in src/neuroglancer/services/state_loader.ts:222

segmentVolume

segmentVolume(stateID: string | number, volumeId: string): Promise<Segmentation>
Parameters
- stateID: string | number
- volumeId: string
Returns Promise<Segmentation>
- Defined in src/neuroglancer/services/state_loader.ts:252

Generated using TypeDoc