Home Reference Source Repository

Function

Static Public Summary
public

Display(props: *): *

public

Output(props: *): *

public

TogglableDisplay(props: *): *

public

authAndPublish(item: *, focusedWindow: *)

public

changeCellType(id: *, to: *): *

public
public
public

childOf(parentMessage: Object): Observable

childOf filters out messages that don't have the parent header matching parentMessage
public

cleanupKernel(kernel: *, closeChannels: *, _fs: *)

public

clearCellOutput(id: *): *

public

configureStore(initialState: *): *

public

copyCell(id: *): *

public

createCellAfter(cellType: *, id: *, source: *): *

public

createCellAppend(cellType: *): *

public

createCellBefore(cellType: *, id: *): *

public

createMessage(msg_type: *, fields: *): *

public

createTitleFeed(state$: *): *

public

cutCell(id: *): *

public

deferURL(event: *, url: *)

public

focusCell(id: *): *

public

focusNextCell(id: *, createCellIfUndefined: *): *

public

focusPreviousCell(id: *): *

public

forceShutdownKernel(kernel: *, _fs: *)

public
public
public

initNativeHandlers(store: *): *

public

launch(filename: *): *

public

launchNewNotebook(kernelSpecName: *): *

public
public

mergeCellAfter(id: *): *

public

moveCell(id: *, destinationId: *, above: *): *

public

newKernel(kernelSpecName: *, cwd: *): *

public

ofMessageType(messageTypes: Array): Observable

ofMessageType is an Rx Operator that filters on msg.header.msg_type being one of messageTypes
public

overwriteMetadata(field: *, value: *): *

public

pasteCell(): *

public

removeCell(id: *): *

public
public

setBackwardCheckpoint(documentState: *, clearFutureStack: *): *

public

setExecutionState(executionState: *): *

public

setForwardCheckpoint(documentState: *): *

public

setGithubToken(githubToken: *): *

public

setNotebookKernelInfo(kernelInfo: *): *

public

setNotificationSystem(notificationSystem: *): *

public

setTitleFromAttributes(attributes: *)

public
public

shutdownKernel(kernel: *): *

public

splitCell(id: *, position: *): *

public

Turn a path like /Users/n/mine.ipynb to ~/mine.ipynb
public

toggleStickyCell(id: *): *

public

updateCellExecutionCount(id: *, count: *): *

public

updateCellOutputs(id: *, outputs: *): *

public

updateCellPagers(id: *, pagers: *): *

public

updateCellSource(id: *, source: *): *

public

updateCellStatus(id: *, status: *): *

Static Public

public Display(props: *): * source 

import Display from 'nteract/src/notebook/components/cell/display-area/display.js'

Params:

NameTypeAttributeDescription
props *

Return:

*

public Output(props: *): * source 

import Output from 'nteract/src/notebook/components/cell/display-area/output.js'

Params:

NameTypeAttributeDescription
props *

Return:

*

public TogglableDisplay(props: *): * source 

import TogglableDisplay from 'nteract/src/notebook/components/cell/display-area/togglable-display.js'

Params:

NameTypeAttributeDescription
props *

Return:

*

public authAndPublish(item: *, focusedWindow: *) source 

import {authAndPublish} from 'nteract/src/main/menu.js'

Params:

NameTypeAttributeDescription
item *
focusedWindow *

public changeCellType(id: *, to: *): * source 

import {changeCellType} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
to *

Return:

*

public changeInputVisibility(id: *): * source 

import {changeInputVisibility} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public changeOutputVisibility(id: *): * source 

import {changeOutputVisibility} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public childOf(parentMessage: Object): Observable source 

import {childOf} from 'nteract/src/notebook/kernel/messaging.js'

childOf filters out messages that don't have the parent header matching parentMessage

Params:

NameTypeAttributeDescription
parentMessage Object

Jupyter message protocol message

Return:

Observable

the resulting observable

public cleanupKernel(kernel: *, closeChannels: *, _fs: *) source 

import {cleanupKernel} from 'nteract/src/notebook/kernel/shutdown.js'

Params:

NameTypeAttributeDescription
kernel *
closeChannels *
_fs *
  • optional
  • default: fs

public clearCellOutput(id: *): * source 

import {clearCellOutput} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public configureStore(initialState: *): * source 

import configureStore from 'nteract/src/notebook/store.js'

Params:

NameTypeAttributeDescription
initialState *

Return:

*

public copyCell(id: *): * source 

import {copyCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public createCellAfter(cellType: *, id: *, source: *): * source 

import {createCellAfter} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
cellType *
id *
source *

Return:

*

public createCellAppend(cellType: *): * source 

import {createCellAppend} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
cellType *

Return:

*

public createCellBefore(cellType: *, id: *): * source 

import {createCellBefore} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
cellType *
id *

Return:

*

public createMessage(msg_type: *, fields: *): * source 

import {createMessage} from 'nteract/src/notebook/kernel/messaging.js'

Params:

NameTypeAttributeDescription
msg_type *
fields *

Return:

*

public createTitleFeed(state$: *): * source 

import {createTitleFeed} from 'nteract/src/notebook/native-window.js'

Params:

NameTypeAttributeDescription
state$ *

Return:

*

public cutCell(id: *): * source 

import {cutCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public deferURL(event: *, url: *) source 

import {deferURL} from 'nteract/src/main/launch.js'

Params:

NameTypeAttributeDescription
event *
url *

public focusCell(id: *): * source 

import {focusCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public focusNextCell(id: *, createCellIfUndefined: *): * source 

import {focusNextCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
createCellIfUndefined *

Return:

*

public focusPreviousCell(id: *): * source 

import {focusPreviousCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public forceShutdownKernel(kernel: *, _fs: *) source 

import {forceShutdownKernel} from 'nteract/src/notebook/kernel/shutdown.js'

Params:

NameTypeAttributeDescription
kernel *
_fs *
  • optional
  • default: fs

public generateDefaultTemplate(): * source 

import {generateDefaultTemplate} from 'nteract/src/main/menu.js'

Return:

*

public getUsername(): * source 

import {getUsername} from 'nteract/src/notebook/kernel/messaging.js'

Return:

*

public initNativeHandlers(store: *): * source 

import {initNativeHandlers} from 'nteract/src/notebook/native-window.js'

Params:

NameTypeAttributeDescription
store *

Return:

*

public launch(filename: *): * source 

import {launch} from 'nteract/src/main/launch.js'

Params:

NameTypeAttributeDescription
filename *

Return:

*

public launchNewNotebook(kernelSpecName: *): * source 

import {launchNewNotebook} from 'nteract/src/main/launch.js'

Params:

NameTypeAttributeDescription
kernelSpecName *

Return:

*

public loadFullMenu(): * source 

import {loadFullMenu} from 'nteract/src/main/menu.js'

Return:

*

public mergeCellAfter(id: *): * source 

import {mergeCellAfter} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public moveCell(id: *, destinationId: *, above: *): * source 

import {moveCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
destinationId *
above *

Return:

*

public newKernel(kernelSpecName: *, cwd: *): * source 

import {newKernel} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
kernelSpecName *
cwd *

Return:

*

public ofMessageType(messageTypes: Array): Observable source 

import {ofMessageType} from 'nteract/src/notebook/kernel/messaging.js'

ofMessageType is an Rx Operator that filters on msg.header.msg_type being one of messageTypes

Params:

NameTypeAttributeDescription
messageTypes Array

e.g. ['stream', 'error']

Return:

Observable

the resulting observable

public overwriteMetadata(field: *, value: *): * source 

import {overwriteMetadata} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
field *
value *

Return:

*

public pasteCell(): * source 

import {pasteCell} from 'nteract/src/notebook/actions.js'

Return:

*

public removeCell(id: *): * source 

import {removeCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public setAnonGithub(): * source 

import {setAnonGithub} from 'nteract/src/notebook/actions.js'

Return:

*

public setBackwardCheckpoint(documentState: *, clearFutureStack: *): * source 

import {setBackwardCheckpoint} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
documentState *
clearFutureStack *

Return:

*

public setExecutionState(executionState: *): * source 

import {setExecutionState} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
executionState *

Return:

*

public setForwardCheckpoint(documentState: *): * source 

import {setForwardCheckpoint} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
documentState *

Return:

*

public setGithubToken(githubToken: *): * source 

import {setGithubToken} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
githubToken *

Return:

*

public setNotebookKernelInfo(kernelInfo: *): * source 

import {setNotebookKernelInfo} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
kernelInfo *

Return:

*

public setNotificationSystem(notificationSystem: *): * source 

import {setNotificationSystem} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
notificationSystem *

Return:

*

public setTitleFromAttributes(attributes: *) source 

import {setTitleFromAttributes} from 'nteract/src/notebook/native-window.js'

Params:

NameTypeAttributeDescription
attributes *

public setUserGithub(): * source 

import {setUserGithub} from 'nteract/src/notebook/actions.js'

Return:

*

public shutdownKernel(kernel: *): * source 

import {shutdownKernel} from 'nteract/src/notebook/kernel/shutdown.js'

Params:

NameTypeAttributeDescription
kernel *

Return:

*

public splitCell(id: *, position: *): * source 

import {splitCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
position *

Return:

*

public tildify(p: string): string source 

import {tildify} from 'nteract/src/notebook/native-window.js'

Turn a path like /Users/n/mine.ipynb to ~/mine.ipynb

Params:

NameTypeAttributeDescription
p string

the full path to a file

Return:

string

tildified path

public toggleStickyCell(id: *): * source 

import {toggleStickyCell} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *

Return:

*

public updateCellExecutionCount(id: *, count: *): * source 

import {updateCellExecutionCount} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
count *

Return:

*

public updateCellOutputs(id: *, outputs: *): * source 

import {updateCellOutputs} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
outputs *

Return:

*

public updateCellPagers(id: *, pagers: *): * source 

import {updateCellPagers} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
pagers *

Return:

*

public updateCellSource(id: *, source: *): * source 

import {updateCellSource} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
source *

Return:

*

public updateCellStatus(id: *, status: *): * source 

import {updateCellStatus} from 'nteract/src/notebook/actions.js'

Params:

NameTypeAttributeDescription
id *
status *

Return:

*