Class StateLoader

This class takes care of the buttons and inputs used by the user to load a specific Neuroglancer state.

Hierarchy

RefCounted
- StateLoader

Constructors

constructor

new StateLoader(viewer: Viewer): StateLoader
Parameters
- viewer: Viewer
Returns StateLoader
Overrides RefCounted.constructor
- Defined in src/neuroglancer/services/state_loader.ts:296

Properties

disposedStacks

disposedStacks: any

element

element: HTMLDivElement = ...

`Private` input

input: StateAutocomplete

`Private` newButton

newButton: HTMLElement

refCount

refCount: number = 1

`Private` resetButton

resetButton: HTMLElement

`Private` saveButton

saveButton: HTMLElement

`Private` stateAPI

stateAPI: StateAPI

`Private` stateID

stateID: number

`Private` user

user: User

viewer

viewer: Viewer

wasDisposed

wasDisposed: undefined | boolean

Methods

addRef

addRef(): StateLoader
Returns StateLoader
Inherited from RefCounted.addRef
- Defined in src/neuroglancer/util/disposable.ts:48

dispose

dispose(): void
Returns void
Inherited from RefCounted.dispose
- Defined in src/neuroglancer/util/disposable.ts:53

disposed

disposed(): void
Returns void
Inherited from RefCounted.disposed
- Defined in src/neuroglancer/util/disposable.ts:75

`Private` getState

getState(): void
A method used to fetch the Neuroglancer state. This is the R in the CRUD operations.

Returns void
- Defined in src/neuroglancer/services/state_loader.ts:359

`Private` newState

newState(): void
This is used when the user clicks the 'New' button. This is the C in the CRUD operations.

Returns
returns a JSON object of state

Returns void
- Defined in src/neuroglancer/services/state_loader.ts:406

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from RefCounted.refCountReachedZero
- Defined in src/neuroglancer/util/disposable.ts:66

registerCancellable

registerCancellable<T>(cancellable: T): T
Type Parameters
- T extends {
  cancel: (() => void);
  }
Parameters
- cancellable: T
Returns T
Inherited from RefCounted.registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from RefCounted.registerDisposer
- Defined in src/neuroglancer/util/disposable.ts:76

registerEventListener

registerEventListener(target: EventTarget, type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- target: EventTarget
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from RefCounted.registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

`Private` resetState

resetState(): void
A method to reset the state from what is stored in the database.

Returns void
- Defined in src/neuroglancer/services/state_loader.ts:509

saveAnnotations

saveAnnotations(layerName: string): void
This is used when the user clicks the 'Save Annotations' button.

Returns
Nothing if there is an error.
Parameters
- layerName: string
  
  The name of the layer the user is saving.
Returns void
- Defined in src/neuroglancer/services/state_loader.ts:476

`Private` saveState

saveState(): void
This method is used when the user clicks the 'Save' button. This is the U in the CRUD operations.

Returns
the state object

Returns void
- Defined in src/neuroglancer/services/state_loader.ts:378

segmentVolume

segmentVolume(volumeId: string, successCallback: ((_: Segmentation) => void)): void
This method is used for the segmentation volume. It calls the saveState method after preparing the segment volume for saving.

Returns
Nothing if there is no comments.
Parameters
- volumeId: string
  
  ID of the volume
- successCallback: ((_: Segmentation) => void)
  
  method to determine if the method was successful.
  - - (_: Segmentation): void
    - Parameters
      
      _: Segmentation
      
      Returns void
Returns void
- Defined in src/neuroglancer/services/state_loader.ts:439

unregisterDisposer

unregisterDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from RefCounted.unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

`Private` validateState

validateState(state: null | State): void
This method makes sure the Neuroglancer state is valid JSON
Parameters
- state: null | State
  
  the JSON data
Returns void
- Defined in src/neuroglancer/services/state_loader.ts:347

Class StateLoader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

viewer: Viewer

Returns StateLoader

Properties

disposedStacks

element

Private input

Private newButton

refCount

Private resetButton

Private saveButton

Private stateAPI

Private stateID

Private user

viewer

wasDisposed

Methods

addRef

Returns StateLoader

dispose

Returns void

disposed

Returns void

Private getState

Returns void

Private newState

Returns

Returns void

Protected refCountReachedZero

Returns void

registerCancellable

Type Parameters

T extends { cancel: (() => void); }

Parameters

cancellable: T

Returns T

registerDisposer

Type Parameters

T extends Disposer

Parameters

f: T

Returns T

registerEventListener

Parameters

target: EventTarget

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

Private resetState

Returns void

saveAnnotations

Returns

Parameters

layerName: string

Returns void

Private saveState

Returns

Returns void

segmentVolume

Returns

Parameters

volumeId: string

successCallback: ((_: Segmentation) => void)

Parameters

_: Segmentation

Returns void

Returns void

unregisterDisposer

Type Parameters

T extends Disposer

Parameters

`Private` input

`Private` newButton

`Private` resetButton

`Private` saveButton

`Private` stateAPI

`Private` stateID

`Private` user

`Private` getState

`Private` newState

`Protected` refCountReachedZero

T extends {
cancel: (() => void);
}

`Optional` options: boolean | AddEventListenerOptions

`Private` resetState

`Private` saveState

`Private` validateState