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 basic components:
- Navigation bar—Browse the website, 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. This ribbon has the following buttons:
- Add—Add layers and web tools to the notebook.
- Analysis—Access analysis tools to use in the notebook.
- Code snippets—Use Python code snippets in the notebook.
- Files—Browse files in your ArcGIS workspace and the data from sample notebooks.
- Tasks—Create one or multiple tasks to automate running of the notebook, and specify the task's schedule.
- Parameters—Configure input and output parameters for the notebook to be published as a web tool. Input parameters configured for a notebook will be available when creating a scheduled task.
- Publish—Publish the notebook as a web tool.
- Snapshots—Create a snapshot of the notebook.
- Share—Share the notebook.
- Info—Get information about the notebook. You can edit the notebook's metadata (title, tags, description, terms of use, and credits) here. You can also view the notebook runtime and its available libraries here.
- Save—Saves the notebook in its present state. When you open a shared notebook, this button reads Save As.
- Notebook menu ribbon—The actions on this ribbon are for working directly in the notebook. You can add and delete cells, change the notebook appearance, return the notebook to a previous checkpoint, and more. This ribbon also displays whether the notebook is trusted and the version of Python being run.
- Toolbar—Use the tools for common tasks in the notebook.
- Workspace—The notebook content is displayed here, and you can modify the content here as well.
Notebook menu ribbon
The following actions are available from the drop-down lists in the notebook menu ribbon.
File
From the File menu, you can choose to download the notebook in one of the following formats:
- Markdown (.md)
- Notebook (.ipynb)
- Python (.py)
- Reveal.js slides (.slides.html)
You can also download the notebook in .ipynb format from the notebook's item details page.
Edit
The following items are available in the Edit menu:
- 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 in the 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
The following items are available in the View menu:
- 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 as follows:
- None—Do not show cell toolbars.
- Edit Metadata—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—Specify how each cell will display in a slide show. This option is helpful when presenting code.
- Attachments—Manage the associated attachments within each cell in the notebook workspace.
- Tags—Create and manage tags for each cell within the notebook workspace.
Insert
The following items are available in the Insert menu:
- Insert Cell Above—Insert an empty cell above the currently selected cell.
- Insert Cell Below—Insert an empty cell below the currently selected cell.
- Insert Heading Above— Insert a heading cell above the currently selected cell with the default text of New heading.
- Insert Heading Below— Insert a heading cell below the currently selected cell with the default text of New heading.
Cell
The following items are available in the Cell menu:
- Run Cells—Run the currently selected cell and move the pointer to the next cell.
- Run Cells and Select Below—Run the currently selected cell and then select the cell below.
- Runs Cells and Insert Below—Run the currently selected cell and then insert an empty cell below the selected cell.
- Run All—Run all the cells in the notebook in sequential order.
- Run All Above—Run all cells above the currently selected cell but not the selected cell.
- Run All Below—Run the currently selected cell and all cells below it.
- Cell Type—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—Hide or show the output of the currently selected cell.
- Toggle Scrolling—Enable or disable scrolling on the currently selected cell.
- Clear—Clear the output of the currently selected cell.
- All Output—Control the output of all cells within the notebook workspace. The options include the following:
- Toggle—Hide or show the output of all cells.
- Toggle Scrolling—Enable or disable scrolling on all cells.
- Clear—Clear the output of all cells.
Kernel
The following items are available in the Kernel menu:
- Interrupt—Pause the running kernel if a calculation or analysis is taking too long.
- Restart—Restart the entire computational process by restarting the kernel.
- Restart & Clear Output—Restart the computational process and clear any output that is displayed within the notebooks.
- Restart & Run All—Restart the computational process and then run all the cells in sequential order.
- Reconnect—Reconnect to a kernel if it goes idle.
- Shutdown—Shut down all computational processes within the notebook.
- Change Kernel—Change the kernel type. Only the Python 3 kernel type is supported in ArcGIS Notebooks.
Help
This list provides access to information on keyboard shortcuts, the user interface, and the various help documents associated with ArcGIS Notebooks and key Python modules.
The User Interface Tour tool is particularly helpful for users who are new to the notebook environment.
Notebook toolbar buttons
The notebook toolbar provides quick access to the most commonly used actions from the notebook menu ribbon. The available buttons, from left to right, are as follows:
- Add—Insert a cell below the currently selected cell.
- Cut—Cut the currently selected cell.
- Copy—Copy the currently selected cell.
- Paste—Paste the copied cells below the currently selected cell.
- Up arrow—Move the selected cell up in the notebook sequence.
- Down arrow—Move the selected cell down in the notebook sequence.
- Run—Run the currently selected cell.
- Stop—Interrupt the kernel.
- Restart—Restart the kernel.
- Fast-forward—Restart the kernel and run all cells.
- Cell type—Select or change the type of the currently selected cell.
- Keyboard—Open the command palette.
- Chart—Enter or exit slide show mode.