Class C<TBase>

Type Parameters

TBase extends ChunkSourceConstructor<GettableChunkSource & ChunkSource & {
    OPTIONS: {
        parameters: PythonSourceParameters;
    };
}>

Hierarchy

Base
- C

Constructors

constructor

new C(...args: any[]): C<TBase> & SharedObject & {
    OPTIONS: {};
    key: any;
} & ChunkSource & {
    OPTIONS: {
        parameters: PythonSourceParameters;
    };
}
Parameters
- Rest ...args: any[]
Returns C<TBase> & SharedObject & {
    OPTIONS: {};
    key: any;
} & ChunkSource & {
    OPTIONS: {
        parameters: PythonSourceParameters;
    };
}
Overrides Base.constructor
- Defined in src/neuroglancer/datasource/python/frontend.ts:60

Properties

OPTIONS

OPTIONS: Options

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

chunks

chunks: Map<string, Chunk> = ...

dataSource

dataSource: PythonDataSource

disposedStacks

disposedStacks: any

generation

generation: number

immediateChunkUpdates

immediateChunkUpdates: boolean = false

If set to true, chunk updates will be applied to this source immediately, rather than queueing them. Sources that dynamically update chunks and need to ensure a consistent order of processing relative to other messages between the frontend and worker should set this to true.

isOwner

isOwner: undefined | boolean

key

key: any

parameters

parameters: PythonSourceParameters

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

`Static` prototype

prototype: any

Accessors

gl

get gl(): GL
Returns GL
Inherited from Base.gl
- Defined in src/neuroglancer/chunk_manager/frontend.ts:372

Methods

addChunk

addChunk(key: string, chunk: Chunk): void
Parameters
- key: string
- chunk: Chunk
Returns void
Inherited from Base.addChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:384

addCounterpartRef

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

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

addRef

addRef(): C<TBase>
Returns C<TBase>
Inherited from Base.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 Base.counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

deleteChunk

deleteChunk(key: string): void
Parameters
- key: string
Returns void
Inherited from Base.deleteChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:376

dispose

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

disposed

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

getChunk

getChunk(_x: any): Chunk
Default implementation for use with backendOnly chunk sources.
Parameters
- _x: any
Returns Chunk
Inherited from Base.getChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:391

initializeCounterpart

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

initializeSharedObject

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

invalidateCache

invalidateCache(): void
Invalidates the chunk cache. Operates asynchronously.

Returns void
Inherited from Base.invalidateCache
- Defined in src/neuroglancer/chunk_manager/frontend.ts:398

`Protected` ownerDispose

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

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

`Protected` refCountReachedZero

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

`Static` encodeOptions

encodeOptions(options: Options): any
Parameters
- options: Options
Returns any
Inherited from Base.encodeOptions
- Defined in src/neuroglancer/datasource/python/frontend.ts:68
encodeOptions(options: {
parameters: PythonSourceParameters;
}): any
Parameters
- options: {
  parameters: PythonSourceParameters;
  }
  - parameters: PythonSourceParameters
Returns any
Inherited from Base.encodeOptions
- Defined in src/neuroglancer/chunk_manager/frontend.ts:317

Class C<TBase>

Type Parameters

TBase extends ChunkSourceConstructor<GettableChunkSource & ChunkSource & { OPTIONS: { parameters: PythonSourceParameters; }; }>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: any[]

Returns C<TBase> & SharedObject & { OPTIONS: {}; key: any; } & ChunkSource & { OPTIONS: { parameters: PythonSourceParameters; }; }

Properties

OPTIONS

RPC_TYPE_ID

chunkManager

chunks

dataSource

disposedStacks

generation

immediateChunkUpdates

isOwner

key

parameters

refCount

referencedGeneration

rpc

rpcId

unreferencedGeneration

wasDisposed

Static prototype

Accessors

gl

Returns GL

Methods

addChunk

Parameters

key: string

chunk: Chunk

Returns void

addCounterpartRef

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

gen: number

id: null | number

addRef

Returns C<TBase>

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

deleteChunk

Parameters

key: string

Returns void

dispose

Returns void

disposed

Returns void

getChunk

Parameters

_x: any

Returns Chunk

initializeCounterpart

Parameters

rpc: RPC

options: any = {}

Returns void

Parameters

rpc: RPC

options: any

Returns void

initializeSharedObject

Parameters

rpc: RPC

rpcId: number = ...

Returns void

invalidateCache

Returns void

TBase extends ChunkSourceConstructor<GettableChunkSource & ChunkSource & {
OPTIONS: {
parameters: PythonSourceParameters;
};
}>

`Rest` ...args: any[]

Returns C<TBase> & SharedObject & {
OPTIONS: {};
key: any;
} & ChunkSource & {
OPTIONS: {
parameters: PythonSourceParameters;
};
}

`Static` prototype

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

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Static` encodeOptions

options: {
parameters: PythonSourceParameters;
}