Class MultiStepAnnotationTool`Abstract`

An abstract class to represent any annotation tool with multiple steps to complete annotation.

Hierarchy

PlaceAnnotationTool
- MultiStepAnnotationTool
  - PlaceCollectionAnnotationTool

Constructors

constructor

new MultiStepAnnotationTool(layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer, options: any): MultiStepAnnotationTool
Parameters
- layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer
- options: any
Returns MultiStepAnnotationTool
Inherited from PlaceAnnotationTool.constructor
- Defined in src/neuroglancer/ui/annotations.ts:1245

Properties

changed

changed: Signal<(() => void)> = ...

`Abstract` description

description: string

disposedStacks

disposedStacks: any

inProgressAnnotation

inProgressAnnotation: undefined | {
    annotationLayer: AnnotationLayerState;
    disposer: (() => void);
    reference: AnnotationReference;
}

layer

layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer

refCount

refCount: number = 1

wasDisposed

wasDisposed: undefined | boolean

Accessors

annotationColorPicker

get annotationColorPicker(): undefined | AnnotationColorWidget
Returns undefined | AnnotationColorWidget
Inherited from PlaceAnnotationTool.annotationColorPicker
- Defined in src/neuroglancer/ui/annotations.ts:1257

annotationLayer

get annotationLayer(): undefined | AnnotationLayerState
Returns undefined | AnnotationLayerState
Inherited from PlaceAnnotationTool.annotationLayer
- Defined in src/neuroglancer/ui/annotations.ts:1250

mouseState

get mouseState(): MouseSelectionState
Returns MouseSelectionState
Inherited from PlaceAnnotationTool.mouseState
- Defined in src/neuroglancer/ui/tool.ts:81

Methods

addRef

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

`Abstract` complete

complete(): boolean
Returns boolean
- Defined in src/neuroglancer/ui/annotations.ts:1408

registerCancellable

registerCancellable<T>(cancellable: T): T
Type Parameters
- T extends {
  cancel: (() => void);
  }
Parameters
- cancellable: T
Returns T
Inherited from PlaceAnnotationTool.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 PlaceAnnotationTool.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 PlaceAnnotationTool.registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

setActive

setActive(_value: boolean): void
Parameters
- _value: boolean
Returns void
Inherited from PlaceAnnotationTool.setActive
- Defined in src/neuroglancer/ui/tool.ts:87

`Abstract` toJSON

toJSON(): any
Returns any
Inherited from PlaceAnnotationTool.toJSON
- Defined in src/neuroglancer/ui/tool.ts:85

`Abstract` trigger

trigger(mouseState: MouseSelectionState): void
Parameters
- mouseState: MouseSelectionState
Returns void
Inherited from PlaceAnnotationTool.trigger
- Defined in src/neuroglancer/ui/tool.ts:84

unbind

unbind(): void
Returns void
Inherited from PlaceAnnotationTool.unbind
- Defined in src/neuroglancer/ui/tool.ts:89

`Abstract` undo

undo(mouseState: MouseSelectionState): boolean
Parameters
- mouseState: MouseSelectionState
Returns boolean
- Defined in src/neuroglancer/ui/annotations.ts:1409

unregisterDisposer

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

Class MultiStepAnnotationToolAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer

options: any

Returns MultiStepAnnotationTool

Properties

changed

Abstract description

disposedStacks

inProgressAnnotation

layer

refCount

wasDisposed

Accessors

annotationColorPicker

Returns undefined | AnnotationColorWidget

annotationLayer

Returns undefined | AnnotationLayerState

mouseState

Returns MouseSelectionState

Methods

addRef

Returns MultiStepAnnotationTool

Abstract complete

Returns boolean

deactivate

Returns void

dispose

Returns void

disposed

Returns void

Abstract getInitialAnnotation

Parameters

mouseState: MouseSelectionState

annotationLayer: AnnotationLayerState

Returns Annotation

Abstract getUpdatedAnnotation

Parameters

oldAnnotation: Annotation

mouseState: MouseSelectionState

annotationLayer: AnnotationLayerState

Returns Annotation

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

setActive

Parameters

_value: boolean

Returns void

Abstract toJSON

Returns any

Abstract trigger

Parameters

mouseState: MouseSelectionState

Class MultiStepAnnotationTool`Abstract`

`Abstract` description

`Abstract` complete

`Abstract` getInitialAnnotation

`Abstract` getUpdatedAnnotation

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Abstract` toJSON

`Abstract` trigger

`Abstract` undo