Class BeakerNotebook

constructor

• new BeakerNotebook(): BeakerNotebook

  Returns BeakerNotebook

cells

content

addCell

• addCell(
      cell:
          | BeakerCodeCell
          | BeakerMarkdownCell
          | BeakerRawCell
          | IUnrecognizedCell
          | IRawCell
          | IMarkdownCell
          | ICodeCell,
  ): void

  Parameters

  • cell:
        | BeakerCodeCell
        | BeakerMarkdownCell
        | BeakerRawCell
        | IUnrecognizedCell
        | IRawCell
        | IMarkdownCell
        | ICodeCell

  Returns void

cutCell

• cutCell(index: number): null | IBeakerCell

  Parameters

  • index: number

  Returns null | IBeakerCell

fromJSON

• fromJSON(obj: any): void

  Parameters

  • obj: any

  Returns void

insertCell

• insertCell(
      cell:
          | BeakerCodeCell
          | BeakerMarkdownCell
          | BeakerRawCell
          | IUnrecognizedCell
          | IRawCell
          | IMarkdownCell
          | ICodeCell,
      position: number,
  ): void

  Parameters

  • cell:
        | BeakerCodeCell
        | BeakerMarkdownCell
        | BeakerRawCell
        | IUnrecognizedCell
        | IRawCell
        | IMarkdownCell
        | ICodeCell
  • position: number

  Returns void

loadFromIPynb

• loadFromIPynb(obj: any): void

  Parameters

  • obj: any

  Returns void

moveCell

• moveCell(fromIndex: number, toIndex: number): void

  Parameters

  • fromIndex: number
  • toIndex: number

  Returns void

removeCell

• removeCell(index: number): void

  Parameters

  • index: number

  Returns void

setSubkernelInfo

• setSubkernelInfo(sessionInfo: any): void

  Parameters

  • sessionInfo: any

  Returns void

toIPynb

• toIPynb(): {
      cells: IBaseCell[];
      metadata: INotebookMetadata;
      nbformat: number;
      nbformat_minor: number;
  }

  Returns {
      cells: IBaseCell[];
      metadata: INotebookMetadata;
      nbformat: number;
      nbformat_minor: number;
  }

toJSON

• toJSON(): {
      cells: BeakerBaseCell[];
      metadata: INotebookMetadata;
      nbformat: number;
      nbformat_minor: number;
      [key: string]: PartialJSONValue;
  }

  Returns {
      cells: BeakerBaseCell[];
      metadata: INotebookMetadata;
      nbformat: number;
      nbformat_minor: number;
      [key: string]: PartialJSONValue;
  }