Class VariableInspectionHandler

An object that handles code inspection.

Hierarchy

AbstractHandler
- VariableInspectionHandler

Constructors

constructor

new VariableInspectionHandler(options): VariableInspectionHandler
Parameters
- options: VariableInspectionHandler.IOptions
Returns VariableInspectionHandler
Overrides AbstractHandler.constructor
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:94

Properties

`Protected` _connector

_connector: KernelConnector

`Private` _deleteCommand

_deleteCommand: string

`Private` _id

_id: string

`Private` _initScript

_initScript: string

`Protected` _inspected

_inspected: Signal<IInspectable, IVariableInspectorUpdate> = ...

`Private` _matrixQueryCommand

_matrixQueryCommand: string

`Private` _queryCommand

_queryCommand: string

`Private` _ready

_ready: Promise<void>

`Protected` _rendermime

_rendermime: null | IRenderMimeRegistry = null

`Private` _widgetQueryCommand

_widgetQueryCommand: string

Accessors

disposed

get disposed(): ISignal<this, void>
Returns ISignal<this, void>
Inherited from AbstractHandler.disposed
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:35

id

get id(): string
Returns string
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:131

inspected

get inspected(): ISignal<IInspectable, IVariableInspectorUpdate>
Returns ISignal<IInspectable, IVariableInspectorUpdate>
Inherited from AbstractHandler.inspected
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:43

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from AbstractHandler.isDisposed
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:39

ready

get ready(): Promise<void>
Returns Promise<void>
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:135

rendermime

get rendermime(): null | IRenderMimeRegistry
Returns null | IRenderMimeRegistry
Inherited from AbstractHandler.rendermime
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:50

Methods

`Private` _handleQueryResponse

_handleQueryResponse(response): void
Parameters
- response: IIOPubMessage<IOPubMessageType>
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:236

`Private` _initOnKernel

_initOnKernel(): Promise<IExecuteReplyMsg>
Initializes the kernel by running the set up script located at _initScriptPath.

Returns Promise<IExecuteReplyMsg>
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:220

`Private` _queryCall

_queryCall(kernel, msg): void
Parameters
- kernel: IKernelConnection
- msg: IMessage<MessageType>
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:293

dispose

dispose(): void
Returns void
Inherited from AbstractHandler.dispose
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:68

performDelete

performDelete(varName): void
Send a kernel request to delete a variable from the global environment
Parameters
- varName: string
Returns void
Overrides AbstractHandler.performDelete
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:207

performInspection

performInspection(): void
Performs an inspection by sending an execute request with the query command to the kernel.

Returns void
Overrides AbstractHandler.performInspection
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:141

performMatrixInspection

performMatrixInspection(varName, maxRows?): Promise<DataModel>
Performs an inspection of the specified matrix.
Parameters
- varName: string
- maxRows: number = 100000
Returns Promise<DataModel>
Overrides AbstractHandler.performMatrixInspection
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:167

performWidgetInspection

performWidgetInspection(varName): IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>
Performs an inspection of a Jupyter Widget
Parameters
- varName: string
Returns IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>
Overrides AbstractHandler.performWidgetInspection
- Defined in tech/jupyter/ui/packages/react/src/components/kernel/variables/handler.ts:153