ArcGIS Notebooks are authored in the notebook editor, which is opened from the ArcGIS Enterprise portal. This topic introduces the components and menus in the notebook editor.
Interface basics
The notebook editor has the following five basic components:
- Navigation barâBrowse in the portal, open other apps from the app launcher, view help resources, and sign in or out of your profile. The navigation bar also displays the title of your notebook and indicates whether you have unsaved changes to the notebook.
- Top ribbonâPerform various tasks involving your notebook from the portal. This ribbon has the following buttons:
- AddâAdd layers and web tools to your notebook.
- AnalysisâAccess analysis tools to use in your notebook.
- FilesâBrowse files in your ArcGIS workspace and the sample notebook data on the ArcGIS Notebook Server machine.
- ShareâShare your notebook.
- InfoâGet information about the notebook, and edit the notebook's metadata (title, tags, description, terms of use, and credits).
- SaveâSaves the notebook in its present state. When you open a shared notebook, this button reads Save As.
- SamplesâOpens a new tab to the sample notebook gallery in the portal.
- Notebook menu ribbonâThe actions on this ribbon are for working directly in your notebook. You can add and delete cells, change the notebook appearance, return the notebook to a previous checkpoint, and so on. This ribbon also displays whether the notebook is trusted and the version of Python being run.
- ToolbarâUse the tools for common tasks in your notebook.
- WorkspaceâYour notebook content is displayed here, and you can modify the content here as well.
Items in the notebook menu ribbon
The following actions are available from the drop-down lists in the notebook menu ribbon.
File
- Print PreviewâOpens a new tab and displays an HTML rendering of your notebook workspace. Note that spatially enabled data frames will not display in this preview.
- Download asâGives you the option to download your notebook in several formats:
- Python code (.py)
- Python notebook (.ipynb)
- HTML (.html)
- Reveal.js slides (.html)
- Markdown (.md)
- Text file (.txt)
- Slides (.slides.html)
- Custom (.txt or .html)
Edit
- Cut CellsâCuts the currently selected cells from the notebook workspace.
- Copy CellsâCopies the currently selected cells in the notebook workspace.
- Paste Cells AboveâPastes the copied cells above the currently selected cell.
- Paste Cells BelowâPastes the copied cells below the currently selected cell.
- Paste Cells & ReplaceâPastes the copied cells and replaces the currently selected cell with the copied cells.
- Delete CellsâDeletes the currently selected cells.
- Undo Delete CellsâReverses the delete cell actions you've performed in reverse order; the most recent delete is undone first.
- Split CellâDivides one cell into two by splitting the content within the cell at the pointer's current location.
- Merge Cell AboveâMerges the currently selected cell with the one above it.
- Merge Cell BelowâMerges the currently selected cell with the one below it.
- Move Cell UpâMoves the currently selected cell up one position in the notebook workspace.
- Move Cell DownâMoves the currently selected cell down one position in the notebook workspace.
- Find and ReplaceâOpens a pop-up window that allows you to enter a search query. This allows you to find and replace specific values or strings within your notebook.
- Copy Cell AttachmentsâCopies the attachments contained in the selected cell.
- Cut Cell AttachmentsâCuts and copies the attachments contained in the selected cell.
- Paste Cell AttachmentsâPastes the copied attachments into the selected cell.
- Insert ImageâOpens a pop-up window that allows you to browse and add images, including GIFs, into Markdown cells only.
View
- Toggle ToolbarâHides or shows the toolbar.
- Toggle Line NumbersâHides or shows line numbers within each cell in the notebook workspace.
- Cell ToolbarâHides or shows the selected slide toolbar option for each cell in the notebook workspace. The options are the following:
- NoneâDo not show cell toolbars.
- Edit MetadataâDisplays an option to enter metadata for each cell using JSON.
- Raw Cell FormatâRaw cells allow you to write output directly; the content of these cells is not evaluated by the notebook.
- SlideshowâDisplays an option for each cell for you to specify how it will display in a slide show. Helpful when presenting code.
- AttachmentsâAllows you to manage the associated attachments within each cell in the notebook workspace.
- TagsâAllows you to create and manage tags for each cell within the notebook workspace.
Insert
- Insert Cell AboveâInserts an empty cell above the currently selected cell.
- Insert Cell BelowâInserts an empty cell below the currently selected cell.
Cell
- Run CellsâRuns the currently selected cell and moves the pointer to the next cell.
- Run Cells and Select BelowâRuns the currently selected cell and then selects the cell below.
- Runs Cells and Insert BelowâRuns the currently selected cell and then inserts an empty cell below your selected cell.
- Run AllâRuns all the cells in the notebook in sequential order.
- Run All AboveâRuns all cells above the currently selected cell, but does not run your selected cell.
- Run All BelowâRuns the currently selected cell and all cells below it.
- Cell TypeâAllows you to change the type of the currently selected cell. The options are Code, Markdown, and Raw NBConvert. Note that the Heading type will switch to Markdown.
- Current OutputsâAllows you to control the output of the currently selected cell. The options include the following:
- Toggle OutputâHides or shows the output of the currently selected cell.
- Toggle ScrollingâEnables or disables scrolling on the currently selected cell.
- Clear OutputâClears the output of the currently selected cell.
- All OutputâAllows you to control the output of all cells within the notebook workspace. The options include the following:
- Toggle OutputâHides or shows the output of all cells.
- Toggle ScrollingâEnables or disables scrolling on all cells.
- Clear OutputâClears the output of all cells.
Kernel
- InterruptâPauses the running kernel if a calculation or analysis is taking too long.
- RestartâRestarts the entire computational process by restarting the kernel.
- Restart & Clear OutputâRestarts the computational process and clears any output that is displayed within the notebooks.
- Restart & Run AllâRestarts the computational process and then runs all the cells in sequential order.
- ReconnectâAllows you to reconnect to a kernel if it goes idle.
- ShutdownâShuts down all computational processes within the notebook.
- Change KernelâAllows you to change the kernel type. In ArcGIS Notebook Server, only the Python 3 kernel type is supported.
Help
This list provides access to information on keyboard shortcuts, the user interface, and the various help documents associated with ArcGIS Notebook Server and key Python modules.
The User Interface Tour is particularly helpful for users who are new to the notebook environment.
Icons on the notebook toolbar
The notebook toolbar provides quick access to the most commonly used actions from the notebook menu ribbon. The icons available, from left to right, are as follows:
- Add iconâInserts a cell below the currently selected cell.
- Scissors iconâCuts the currently selected cell.
- Copy iconâCopies the currently selected cell.
- Paste iconâPastes your copied cells below the currently selected cell.
- Up arrowâMoves the selected cell up in the notebook sequence.
- Down arrowâMoves the selected cell down in the notebook sequence.
- Run iconâRuns the currently selected cell.
- Stop iconâInterrupts the kernel.
- Restart iconâRestarts the kernel.
- Fast-forward iconâRestarts the kernel and runs all cells.
- Cell type listâAllows you to select or change the type of the currently selected cell.
- Keyboard iconâOpens the command palette.
- Chart iconâEnters or exits slide show mode.