Interface: IThebeCell

thebe-core / Exports / IThebeCell

Hierarchy¶

• IPassiveCell

  ↳ IThebeCell

Implemented by¶

• ThebeCell

Table of contents¶

Properties¶

• id
• isAttached
• isAttachedToDOM
• isBusy
• metadata
• notebookId
• outputs
• rendermime
• session
• source
• tags

Methods¶

• attachSession
• attachToDOM
• clear
• clearOnError
• detachSession
• execute
• render
• setAsBusy
• setAsIdle
• setOutputText

Properties¶

id¶

• Readonly id: string

Inherited from¶

IPassiveCell.id

Defined in¶

packages/core/src/types.ts:78

isAttached¶

• Readonly isAttached: boolean

Defined in¶

packages/core/src/types.ts:96

isAttachedToDOM¶

• Readonly isAttachedToDOM: boolean

Inherited from¶

IPassiveCell.isAttachedToDOM

Defined in¶

packages/core/src/types.ts:80

isBusy¶

• Readonly isBusy: boolean

Defined in¶

packages/core/src/types.ts:95

metadata¶

• metadata: JsonObject

Defined in¶

packages/core/src/types.ts:93

notebookId¶

• Readonly notebookId: string

Defined in¶

packages/core/src/types.ts:94

outputs¶

• Readonly outputs: IOutput[]

Inherited from¶

IPassiveCell.outputs

Defined in¶

packages/core/src/types.ts:81

rendermime¶

• Readonly rendermime: IRenderMimeRegistry

Inherited from¶

IPassiveCell.rendermime

Defined in¶

packages/core/src/types.ts:79

session¶

• Optional session: ThebeSession

Defined in¶

packages/core/src/types.ts:92

source¶

• source: string

Defined in¶

packages/core/src/types.ts:91

tags¶

• Readonly tags: string[]

Defined in¶

packages/core/src/types.ts:97

Methods¶

attachSession¶

▸ attachSession(session): void

Parameters¶

Returns¶

void

Defined in¶

packages/core/src/types.ts:99

attachToDOM¶

▸ attachToDOM(el?): void

Parameters¶

Returns¶

void

Inherited from¶

IPassiveCell.attachToDOM

Defined in¶

packages/core/src/types.ts:83

clear¶

▸ clear(): void

Returns¶

void

Inherited from¶

IPassiveCell.clear

Defined in¶

packages/core/src/types.ts:85

clearOnError¶

▸ clearOnError(error?): void

Parameters¶

Returns¶

void

Inherited from¶

IPassiveCell.clearOnError

Defined in¶

packages/core/src/types.ts:86

detachSession¶

▸ detachSession(): void

Returns¶

void

Defined in¶

packages/core/src/types.ts:100

execute¶

▸ execute(source?): Promise<null | IThebeCellExecuteReturn>

Parameters¶

Returns¶

Promise<null | IThebeCellExecuteReturn>

Defined in¶

packages/core/src/types.ts:101

render¶

▸ render(outputs): void

Parameters¶

Returns¶

void

Inherited from¶

IPassiveCell.render

Defined in¶

packages/core/src/types.ts:87

setAsBusy¶

▸ setAsBusy(): void

Returns¶

void

Defined in¶

packages/core/src/types.ts:102

setAsIdle¶

▸ setAsIdle(): void

Returns¶

void

Defined in¶

packages/core/src/types.ts:103

setOutputText¶

▸ setOutputText(text): void

Parameters¶

Returns¶

void

Inherited from¶

IPassiveCell.setOutputText

Defined in¶

packages/core/src/types.ts:84