Class PrecomputedAnnotationSourceBackend

Hierarchy

__type<AnnotationSourceParameters, {
prototype: __type<any, any>;
new (...args: any[]): __type<any, typeof AnnotationSource>;
} & typeof AnnotationSource, this> & __type<any, typeof AnnotationSource, this> & AnnotationSource<this>
- PrecomputedAnnotationSourceBackend

Constructors

constructor

new PrecomputedAnnotationSourceBackend(rpc: RPC, options: any): PrecomputedAnnotationSourceBackend
Parameters
- rpc: RPC
- options: any
Returns PrecomputedAnnotationSourceBackend
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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.

annotationPropertySerializer

annotationPropertySerializer: AnnotationPropertySerializer = ...

`Private` byIdMinishardIndexSource

byIdMinishardIndexSource: undefined | MinishardIndexSource = ...

chunkManager

chunkManager: ChunkManager

credentialsProvider

credentialsProvider: undefined | CredentialsProvider<any>

disposedStacks

disposedStacks: any

isOwner

isOwner: undefined | boolean

metadataChunkSource

metadataChunkSource: AnnotationMetadataChunkSource

parameters

parameters: AnnotationSourceParameters

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

references

references: Set<string> = ...

`Private` relationshipIndexSource

relationshipIndexSource: (undefined | MinishardIndexSource)[] = ...

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>
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).add
- 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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): PrecomputedAnnotationSourceBackend
Returns PrecomputedAnnotationSourceBackend
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

delete

delete(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).delete
- Defined in src/neuroglancer/annotation/backend.ts:205

dispose

dispose(): void
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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>
Overrides (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).downloadMetadata
- Defined in src/neuroglancer/datasource/precomputed/backend.ts:766

downloadSegmentFilteredGeometry

downloadSegmentFilteredGeometry(chunk: AnnotationSubsetGeometryChunk, relationshipIndex: number, cancellationToken: CancellationToken): Promise<void>
Parameters
- chunk: AnnotationSubsetGeometryChunk
- relationshipIndex: number
- cancellationToken: CancellationToken
Returns Promise<void>
Overrides (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).downloadSegmentFilteredGeometry
- Defined in src/neuroglancer/datasource/precomputed/backend.ts:754

initializeCounterpart

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

`Protected` ownerDispose

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

Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).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>
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(AnnotationSource), AnnotationSourceParameters)).update
- Defined in src/neuroglancer/annotation/backend.ts:209

Class PrecomputedAnnotationSourceBackend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPC

options: any

Returns PrecomputedAnnotationSourceBackend

Properties

RPC_TYPE_ID

annotationPropertySerializer

Private byIdMinishardIndexSource

chunkManager

credentialsProvider

disposedStacks

isOwner

metadataChunkSource

parameters

refCount

referencedGeneration

references

Private relationshipIndexSource

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 PrecomputedAnnotationSourceBackend

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

Protected refCountReachedZero

Returns void

registerCancellable

`Private` byIdMinishardIndexSource

`Private` relationshipIndexSource

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

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions