Class BrainmapsAnnotationGeometryChunkSource

Hierarchy

__type<AnnotationSpatialIndexSourceParameters, {
prototype: __type<any, any>;
new (...args: any[]): __type<OAuth2Credentials, typeof AnnotationGeometryChunkSourceBackend>;
} & typeof AnnotationGeometryChunkSourceBackend, this> & __type<OAuth2Credentials, typeof AnnotationGeometryChunkSourceBackend, this> & AnnotationGeometryChunkSourceBackend<this>
- BrainmapsAnnotationGeometryChunkSource

Constructors

constructor

new BrainmapsAnnotationGeometryChunkSource(rpc: RPC, options: any): BrainmapsAnnotationGeometryChunkSource
Parameters
- rpc: RPC
- options: any
Returns BrainmapsAnnotationGeometryChunkSource
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).constructor
- Defined in src/neuroglancer/annotation/backend.ts:130

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.

chunkConstructor

chunkConstructor: ChunkConstructor<SliceViewChunk>

chunkManager

chunkManager: ChunkManager

chunks

chunks: Map<string, AnnotationGeometryChunk>

credentialsProvider

credentialsProvider: CredentialsProvider<OAuth2Credentials>

disposedStacks

disposedStacks: any

freeChunks

freeChunks: Chunk[] = ...

isOwner

isOwner: undefined | boolean

parameters

parameters: AnnotationSpatialIndexSourceParameters

parent

parent: AnnotationSource

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

sourceQueueLevel

sourceQueueLevel: number = 0

sourceQueueLevel must be greater than the sourceQueueLevel of any ChunkSource whose download method depends on chunks from this source. A normal ChunkSource with no other dependencies should have a level of 0.

spec

spec: AnnotationGeometryChunkSpecification

statistics

statistics: Float64Array = ...

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

Methods

addChunk

addChunk(chunk: Chunk): void
Adds the specified chunk to the chunk cache.

If the chunk cache was previously empty, also call this.addRef() to increment the reference count.
Parameters
- chunk: Chunk
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).addChunk
- Defined in src/neuroglancer/chunk_manager/backend.ts:288

addCounterpartRef

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

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): BrainmapsAnnotationGeometryChunkSource
Returns BrainmapsAnnotationGeometryChunkSource
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).addRef
- Defined in src/neuroglancer/util/disposable.ts:48

chunkStateChanged

chunkStateChanged(chunk: Chunk, oldState: ChunkState): void
Parameters
- chunk: Chunk
- oldState: ChunkState
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).chunkStateChanged
- Defined in src/neuroglancer/chunk_manager/backend.ts:337

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 (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

dispose

dispose(): void
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).disposed
- Defined in src/neuroglancer/util/disposable.ts:75

download

download(chunk: AnnotationGeometryChunk, cancellationToken: CancellationToken): Promise<void>
Parameters
- chunk: AnnotationGeometryChunk
- cancellationToken: CancellationToken
Returns Promise<void>
Overrides (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).download
- Defined in src/neuroglancer/datasource/brainmaps/backend.ts:844

getChunk

getChunk(chunkGridPosition: vec3): AnnotationGeometryChunk
Parameters
- chunkGridPosition: vec3
Returns AnnotationGeometryChunk
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).getChunk
- Defined in src/neuroglancer/sliceview/backend.ts:302
getChunk(chunkGridPosition: Float32Array): AnnotationGeometryChunk
Parameters
- chunkGridPosition: Float32Array
Returns AnnotationGeometryChunk
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).getChunk
- Defined in src/neuroglancer/sliceview/backend.ts:318

getNewChunk_

getNewChunk_<T>(chunkType: ChunkConstructor<T>): T
Type Parameters
- T extends Chunk<T>
Parameters
- chunkType: ChunkConstructor<T>
Returns T
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).getNewChunk_
- Defined in src/neuroglancer/chunk_manager/backend.ts:268

initializeCounterpart

initializeCounterpart(rpc: RPC, options?: any): void
Parameters
- rpc: RPC
- options: any = {}
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).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 (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

`Protected` ownerDispose

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

Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).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 (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerChunkListener

registerChunkListener(key: string, listener: ChunkStateListener): boolean
Parameters
- key: string
- listener: ChunkStateListener
Returns boolean
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).registerChunkListener
- Defined in src/neuroglancer/chunk_manager/backend.ts:312

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).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 (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

removeChunk

removeChunk(chunk: Chunk): void
Remove the specified chunk from the chunk cache.

If the chunk cache becomes empty, also call this.dispose() to decrement the reference count.
Parameters
- chunk: Chunk
Returns void
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).removeChunk
- Defined in src/neuroglancer/chunk_manager/backend.ts:302

unregisterChunkListener

unregisterChunkListener(key: string, listener: ChunkStateListener): boolean
Parameters
- key: string
- listener: ChunkStateListener
Returns boolean
Inherited from (BrainmapsSource(AnnotationGeometryChunkSourceBackend, AnnotationSpatialIndexSourceParameters)).unregisterChunkListener
- Defined in src/neuroglancer/chunk_manager/backend.ts:321

unregisterDisposer

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

Class BrainmapsAnnotationGeometryChunkSource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPC

options: any

Returns BrainmapsAnnotationGeometryChunkSource

Properties

RPC_TYPE_ID

chunkConstructor

chunkManager

chunks

credentialsProvider

disposedStacks

freeChunks

isOwner

parameters

parent

refCount

referencedGeneration

rpc

rpcId

sourceQueueLevel

spec

statistics

unreferencedGeneration

wasDisposed

Methods

addChunk

Parameters

chunk: Chunk

Returns void

addCounterpartRef

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

gen: number

id: null | number

addRef

Returns BrainmapsAnnotationGeometryChunkSource

chunkStateChanged

Parameters

chunk: Chunk

oldState: ChunkState

Returns void

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

dispose

Returns void

disposed

Returns void

download

Parameters

chunk: AnnotationGeometryChunk

cancellationToken: CancellationToken

Returns Promise<void>

getChunk

Parameters

chunkGridPosition: vec3

Returns AnnotationGeometryChunk

Parameters

chunkGridPosition: Float32Array

Returns AnnotationGeometryChunk

getNewChunk_

Type Parameters

T extends Chunk<T>

Parameters

chunkType: ChunkConstructor<T>

Returns T

initializeCounterpart

Parameters

rpc: RPC

options: any = {}

Returns void

initializeSharedObject

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

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions