Class PlaceCollectionAnnotationTool`Abstract`

Abstract class to represent any tool which draws a Collection.

Hierarchy

MultiStepAnnotationTool
- PlaceCollectionAnnotationTool
  - PlacePolygonTool
  - PlaceVolumeTool

Constructors

constructor

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

Properties

annotationType

annotationType: POLYGON | VOLUME

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 MultiStepAnnotationTool.annotationColorPicker
- Defined in src/neuroglancer/ui/annotations.ts:1257

annotationLayer

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

mouseState

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

Methods

getInitialAnnotation

getInitialAnnotation(mouseState: MouseSelectionState, annotationLayer: AnnotationLayerState): Annotation
Returns the initial collection annotation based on the mouse location.

Returns
newly created annotation.
Parameters
- mouseState: MouseSelectionState
- annotationLayer: AnnotationLayerState
Returns Annotation
Overrides MultiStepAnnotationTool.getInitialAnnotation
- Defined in src/neuroglancer/ui/annotations.ts:1435

getUpdatedAnnotation

getUpdatedAnnotation(oldAnnotation: Annotation, mouseState: MouseSelectionState, annotationLayer: AnnotationLayerState): Annotation
Get updated annotation based on the source position of the mouse.

Returns
updated annotation.
Parameters
- oldAnnotation: Annotation
- mouseState: MouseSelectionState
- annotationLayer: AnnotationLayerState
Returns Annotation
Overrides MultiStepAnnotationTool.getUpdatedAnnotation
- Defined in src/neuroglancer/ui/annotations.ts:1460

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from MultiStepAnnotationTool.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 MultiStepAnnotationTool.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 MultiStepAnnotationTool.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 MultiStepAnnotationTool.registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

setActive

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

`Abstract` toJSON

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

`Abstract` trigger

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

unbind

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

`Abstract` undo

undo(mouseState: MouseSelectionState): boolean
Parameters
- mouseState: MouseSelectionState
Returns boolean
Inherited from MultiStepAnnotationTool.undo
- 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 MultiStepAnnotationTool.unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

Class PlaceCollectionAnnotationToolAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

options: any

Returns PlaceCollectionAnnotationTool

Properties

annotationType

changed

Abstract description

disposedStacks

inProgressAnnotation

layer

refCount

wasDisposed

Accessors

annotationColorPicker

Returns undefined | AnnotationColorWidget

annotationLayer

Returns undefined | AnnotationLayerState

mouseState

Returns MouseSelectionState

Methods

addRef

Returns PlaceCollectionAnnotationTool

Abstract complete

Returns boolean

deactivate

Returns void

dispose

Returns void

disposed

Returns void

getInitialAnnotation

Returns

Parameters

mouseState: MouseSelectionState

annotationLayer: AnnotationLayerState

Returns Annotation

getUpdatedAnnotation

Returns

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

Class PlaceCollectionAnnotationTool`Abstract`

`Abstract` description

`Abstract` complete

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Abstract` toJSON

`Abstract` trigger

`Abstract` undo