Class PlaceComTool

This class is used to create the Centre of Mass (COM) annotation tool.

Hierarchy

PlaceAnnotationTool
- PlaceComTool

Constructors

constructor

new PlaceComTool(layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer, options: any, session?: undefined | COMSession, mode?: ComToolMode, sessionDiv?: undefined | HTMLElement, iconDiv?: undefined | HTMLElement): PlaceComTool
Parameters
- layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer
- options: any
- session: undefined | COMSession = undefined
- mode: ComToolMode = ComToolMode.NOOP
- sessionDiv: undefined | HTMLElement = undefined
- iconDiv: undefined | HTMLElement = undefined
Returns PlaceComTool
Overrides PlaceAnnotationTool.constructor
- Defined in src/neuroglancer/ui/annotations.ts:2558

Properties

active

active: boolean

bindingsRef

bindingsRef: undefined | RefCounted

changed

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

disposedStacks

disposedStacks: any

icon

icon: WatchableValue<undefined | HTMLElement> = ...

layer

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

mode

mode: ComToolMode

refCount

refCount: number = 1

session

session: WatchableValue<undefined | COMSession> = ...

sessionWidget

sessionWidget: undefined | RefCounted

sessionWidgetDiv

sessionWidgetDiv: undefined | HTMLElement

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

description

get description(): "com session (draw mode)" | "com session (edit mode)" | "com session (view mode)"
Returns "com session (draw mode)" | "com session (edit mode)" | "com session (view mode)"
Overrides PlaceAnnotationTool.description
- Defined in src/neuroglancer/ui/annotations.ts:2787

mouseState

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

Methods

addRef

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

deactivate

deactivate(): void
Deactivates the annotation tool.

Returns void
Overrides PlaceAnnotationTool.deactivate
- Defined in src/neuroglancer/ui/annotations.ts:2676

displayComSession

displayComSession(): void
This function is used to display the COM session data in the annotation tabs while the user is annotating.

Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2709

dispose

dispose(): void
Disposes the annotation tool.

Returns void
Overrides PlaceAnnotationTool.dispose
- Defined in src/neuroglancer/ui/annotations.ts:2641

`Private` disposeSession

disposeSession(): void
Deletes the current active session

Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2685

disposed

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

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from PlaceAnnotationTool.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 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
Activates the annotation tool if value is true.
Parameters
- _value: boolean
Returns void
Overrides PlaceAnnotationTool.setActive
- Defined in src/neuroglancer/ui/annotations.ts:2652

setIconColor

setIconColor(): void
Sets the icon color of the volume tool based on the type of mode

Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2586

toJSON

toJSON(): string
Returns string
Overrides PlaceAnnotationTool.toJSON
- Defined in src/neuroglancer/ui/annotations.ts:2798

trigger

trigger(mouseState: MouseSelectionState): void
This function is called when the user tries to draw annotation

Returns
void
Parameters
- mouseState: MouseSelectionState
Returns void
Overrides PlaceAnnotationTool.trigger
- Defined in src/neuroglancer/ui/annotations.ts:2608

unbind

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

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

validateSession

validateSession(annotationId: undefined | string, annotationLayer: undefined | AnnotationLayerState): boolean
Valides the session, that is if the volume id edited is the current active session or not.

Returns
Parameters
- annotationId: undefined | string
- annotationLayer: undefined | AnnotationLayerState
Returns boolean
- Defined in src/neuroglancer/ui/annotations.ts:2696

Class PlaceComTool

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

options: any

session: undefined | COMSession = undefined

mode: ComToolMode = ComToolMode.NOOP

sessionDiv: undefined | HTMLElement = undefined

iconDiv: undefined | HTMLElement = undefined

Returns PlaceComTool

Properties

active

bindingsRef

changed

disposedStacks

icon

layer

mode

refCount

session

sessionWidget

sessionWidgetDiv

wasDisposed

Accessors

annotationColorPicker

Returns undefined | AnnotationColorWidget

annotationLayer

Returns undefined | AnnotationLayerState

description

Returns "com session (draw mode)" | "com session (edit mode)" | "com session (view mode)"

mouseState

Returns MouseSelectionState

Methods

addRef

Returns PlaceComTool

deactivate

Returns void

displayComSession

Returns void

dispose

Returns void

Private disposeSession

Returns void

disposed

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

setActive

Parameters

_value: boolean

Returns void

setIconColor

Returns void

toJSON

`Private` disposeSession

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions