Class AnnotationSource

Base class for defining a SharedObject type that will never be owned.

Hierarchy

SharedObjectCounterpart
- AnnotationSource

Constructors

constructor

new AnnotationSource(rpc: RPC, options: any): AnnotationSource
Parameters
- rpc: RPC
- options: any
Returns AnnotationSource
Inherited from SharedObjectCounterpart.constructor
- Defined in src/neuroglancer/annotation/backend.ts:176

Properties

RPC_TYPE_ID

RPC_TYPE_ID: string

Should be set to a constant specifying the SharedObject type identifier on the prototype of final derived owner classes. It is not used on counterpart (non-owner) classes.

chunkManager

chunkManager: ChunkManager

disposedStacks

disposedStacks: any

isOwner

isOwner: undefined | boolean

metadataChunkSource

metadataChunkSource: AnnotationMetadataChunkSource

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

references

references: Set<string> = ...

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

segmentFilteredSources

segmentFilteredSources: AnnotationSubsetGeometryChunkSource[]

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

Methods

add

add(annotation: Annotation): Promise<string>
Parameters
- annotation: Annotation
Returns Promise<string>
- Defined in src/neuroglancer/annotation/backend.ts:201

addCounterpartRef

addCounterpartRef(): {
gen: number;
id: null | number;
}
Precondition: this.isOwner === true.

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from SharedObjectCounterpart.addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

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

counterpartRefCountReachedZero

counterpartRefCountReachedZero(generation: number): void
Precondition: this.isOwner === true.

This should be called when the counterpart's refCount is decremented and reaches zero.
Parameters
- generation: number
Returns void
Inherited from SharedObjectCounterpart.counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

delete

delete(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in src/neuroglancer/annotation/backend.ts:205

dispose

dispose(): void
Returns void
Inherited from SharedObjectCounterpart.dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

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

downloadMetadata

downloadMetadata(chunk: AnnotationMetadataChunk, cancellationToken: CancellationToken): Promise<void>
Parameters
- chunk: AnnotationMetadataChunk
- cancellationToken: CancellationToken
Returns Promise<void>
- Defined in src/neuroglancer/annotation/backend.ts:164

downloadSegmentFilteredGeometry

downloadSegmentFilteredGeometry(chunk: AnnotationSubsetGeometryChunk, relationshipIndex: number, cancellationToken: CancellationToken): Promise<void>
Parameters
- chunk: AnnotationSubsetGeometryChunk
- relationshipIndex: number
- cancellationToken: CancellationToken
Returns Promise<void>
- Defined in src/neuroglancer/annotation/backend.ts:166

initializeCounterpart

initializeCounterpart(rpc: RPC, options?: any): void
Parameters
- rpc: RPC
- options: any = {}
Returns void
Inherited from SharedObjectCounterpart.initializeCounterpart
- Defined in src/neuroglancer/worker_rpc.ts:182

initializeSharedObject

initializeSharedObject(rpc: RPC, rpcId?: number): void
Parameters
- rpc: RPC
- rpcId: number = ...
Returns void
Inherited from SharedObjectCounterpart.initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

`Protected` ownerDispose

ownerDispose(): void
Precondition: this.isOwner === true.

Returns void
Inherited from SharedObjectCounterpart.ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Private` recomputeChunkPriorities

recomputeChunkPriorities(): void
Returns void
- Defined in src/neuroglancer/annotation/backend.ts:192

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from SharedObjectCounterpart.refCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:203

registerCancellable

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

unregisterDisposer

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

update

update(id: string, newAnnotation: Annotation): Promise<void>
Parameters
- id: string
- newAnnotation: Annotation
Returns Promise<void>
- Defined in src/neuroglancer/annotation/backend.ts:209

Class AnnotationSource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPC

options: any

Returns AnnotationSource

Properties

RPC_TYPE_ID

chunkManager

disposedStacks

isOwner

metadataChunkSource

refCount

referencedGeneration

references

rpc

rpcId

segmentFilteredSources

unreferencedGeneration

wasDisposed

Methods

add

Parameters

annotation: Annotation

Returns Promise<string>

addCounterpartRef

Returns { gen: number; id: null | number; }

gen: number

id: null | number

addRef

Returns AnnotationSource

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

delete

Parameters

id: string

Returns Promise<void>

dispose

Returns void

disposed

Returns void

downloadMetadata

Parameters

chunk: AnnotationMetadataChunk

cancellationToken: CancellationToken

Returns Promise<void>

downloadSegmentFilteredGeometry

Parameters

chunk: AnnotationSubsetGeometryChunk

relationshipIndex: number

cancellationToken: CancellationToken

Returns Promise<void>

initializeCounterpart

Parameters

rpc: RPC

options: any = {}

Returns void

initializeSharedObject

Parameters

rpc: RPC

rpcId: number = ...

Returns void

Protected ownerDispose

Returns void

Private recomputeChunkPriorities

Returns void

Protected refCountReachedZero

Returns void

registerCancellable

Type Parameters

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

Parameters

Returns {
gen: number;
id: null | number;
}

`Protected` ownerDispose

`Private` recomputeChunkPriorities

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions