jupyterlab-emrys/lib/inspector/handler.d.ts

A computational environment for Jupyter. Powered by Emrys

import { IKernel, KernelMessage } from 'jupyter-js-services';
import { IDisposable } from 'phosphor-disposable';
import { ISignal } from 'phosphor-signaling';
import { BaseCellWidget } from '../notebook/cells/widget';
import { CellEditorWidget, ITextChange } from '../notebook/cells/editor';
import { RenderMime } from '../rendermime';
import { Inspector } from './';
/**
 * An object that handles code inspection.
 */
export declare class InspectionHandler implements IDisposable, Inspector.IInspectable {
    /**
     * Construct a new inspection handler for a widget.
     */
    constructor(rendermime: RenderMime);
    /**
     * The cell widget used by the inspection handler.
     */
    activeCell: BaseCellWidget;
    /**
     * The kernel used by the inspection handler.
     */
    kernel: IKernel;
    /**
     * A signal emitted when inspector should clear all items with no history.
     */
    clearEphemeral: ISignal<InspectionHandler, void>;
    /**
     * A signal emitted when the handler is disposed.
     */
    disposed: ISignal<InspectionHandler, void>;
    /**
     * A signal emitted when an inspector value is generated.
     */
    inspected: ISignal<InspectionHandler, Inspector.IInspectorUpdate>;
    /**
     * Get whether the inspection handler is disposed.
     *
     * #### Notes
     * This is a read-only property.
     */
    isDisposed: boolean;
    /**
     * Dispose of the resources used by the handler.
     */
    dispose(): void;
    /**
     * Update the inspector based on page outputs from the kernel.
     *
     * #### Notes
     * Payloads are deprecated and there are no official interfaces for them in
     * the kernel type definitions.
     * See [Payloads (DEPRECATED)](http://jupyter-client.readthedocs.io/en/latest/messaging.html#payloads-deprecated).
     */
    handleExecuteReply(content: KernelMessage.IExecuteOkReply): void;
    /**
     * Handle a text changed signal from an editor.
     *
     * #### Notes
     * Update the hints inspector based on a text change.
     */
    protected onTextChanged(editor: CellEditorWidget, change: ITextChange): void;
    private _activeCell;
    private _isDisposed;
    private _kernel;
    private _pending;
    private _rendermime;
}