ArrayInput#

Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).


import numpy as np
import panel as pn

pn.extension()

The ArrayInput widget allows rendering and editing NumPy arrays using a text entry box whose contents are then parsed in Python. In order to avoid issues with large arrays the ArrayInput defines a max_array_size, if the array exceeds this size the textual representation will be summarized and editing will be disabled.

Discover more on using widgets to add interactivity to your applications in the how-to guides on interactivity. Alternatively, learn how to set up callbacks and (JS-)links between parameters or how to use them as part of declarative UIs with Param.

Parameters:#

For details on other options for customizing the component see the layout and styling how-to guides.

Core#

  • max_array_size (int): Arrays larger than this limit will be allowed in Python but will not be serialized into JavaScript. Although such large arrays will thus not be editable in the widget, such a restriction helps avoid overwhelming the browser and lets other widgets remain usable.

  • value: Parsed value of the indicated type

Display#

  • disabled (boolean): Whether the widget is editable

  • name (str): The title of the widget

  • placeholder (str): A placeholder string displayed when no value is entered


array_input = pn.widgets.ArrayInput(name='Array Input ', value=np.random.randint(0, 10, (10, 2)))
array_input

ArrayInput.value returns a value of the evaluated type that can be read out and set like other widgets:

array_input.value
array([[8, 1],
       [4, 2],
       [0, 9],
       [8, 9],
       [5, 8],
       [6, 9],
       [8, 9],
       [4, 2],
       [5, 6],
       [4, 2]])

Controls#

The ArrayInput widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively:

pn.Row(array_input.controls(jslink=True), array_input)

Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).