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.
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.
- 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.
- 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)
- 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.
- 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 Cell Above—Inserts an empty cell above the currently selected cell.
- Insert Cell Below—Inserts an empty cell below the currently selected 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.
- 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.
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.