# ScatterPlot

```python
gradio.ScatterPlot(···)
```

### Description

Creates a scatter plot component to display data from a pandas DataFrame.

### Behavior

### Initialization

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `value` | `pd.DataFrame \| Callable \| None` | `None` | The pandas dataframe containing the data to display in the plot. |
| `x` | `str \| None` | `None` | Column corresponding to the x axis. Column can be numeric, datetime, or string/category. |
| `y` | `str \| None` | `None` | Column corresponding to the y axis. Column must be numeric. |
| `color` | `str \| None` | `None` | Column corresponding to series, visualized by color. Column must be string/category. |
| `title` | `str \| None` | `None` | The title to display on top of the chart. |
| `x_title` | `str \| None` | `None` | The title given to the x axis. By default, uses the value of the x parameter. |
| `y_title` | `str \| None` | `None` | The title given to the y axis. By default, uses the value of the y parameter. |
| `color_title` | `str \| None` | `None` | The title given to the color legend. By default, uses the value of color parameter. |
| `x_bin` | `str \| float \| None` | `None` | Grouping used to cluster x values. If x column is numeric, should be number to bin the x values. If x column is datetime, should be string such as "1h", "15m", "10s", using "s", "m", "h", "d" suffixes. |
| `y_aggregate` | `Literal['sum', 'mean', 'median', 'min', 'max', 'count'] \| None` | `None` | Aggregation function used to aggregate y values, used if x_bin is provided or x is a string/category. Must be one of "sum", "mean", "median", "min", "max". |
| `color_map` | `dict[str, str] \| None` | `None` | Mapping of series to color names or codes. For example, {"success": "green", "fail": "#FF8888"}. |
| `colors_in_legend` | `list[str] \| None` | `None` | List containing column names of the series to show in the legend. By default, all series are shown. |
| `x_lim` | `list[float \| None] \| None` | `None` | A tuple or list containing the limits for the x-axis, specified as [x_min, x_max]. To fix only one of these values, set the other to None, e.g. [0, None] to scale from 0 to the maximum value. If x column is datetime type, x_lim should be timestamps. |
| `y_lim` | `list[float \| None]` | `None` | A tuple of list containing the limits for the y-axis, specified as [y_min, y_max]. To fix only one of these values, set the other to None, e.g. [0, None] to scale from 0 to the maximum to value. |
| `x_label_angle` | `float` | `0` | The angle of the x-axis labels in degrees offset clockwise. |
| `y_label_angle` | `float` | `0` | The angle of the y-axis labels in degrees offset clockwise. |
| `x_axis_format` | `str \| None` | `None` | A d3 format string for the x-axis labels (e.g., ".2e" for scientific notation, "~g" for general format). If None, uses Vega-Lite's default formatting. |
| `y_axis_format` | `str \| None` | `None` | A d3 format string for the y-axis labels (e.g., ".2e" for scientific notation, "~g" for general format). If None, uses Vega-Lite's default formatting. |
| `x_axis_labels_visible` | `bool \| Literal['hidden']` | `True` | Whether the x-axis labels should be visible. Can be hidden when many x-axis labels are present. |
| `caption` | `str \| I18nData \| None` | `None` | The (optional) caption to display below the plot. |
| `sort` | `Literal['x', 'y', '-x', '-y'] \| list[str] \| None` | `None` | The sorting order of the x values, if x column is type string/category. Can be "x", "y", "-x", "-y", or list of strings that represent the order of the categories. |
| `tooltip` | `Literal['axis', 'none', 'all'] \| list[str]` | `"axis"` | The tooltip to display when hovering on a point. "axis" shows the values for the axis columns, "all" shows all column values, and "none" shows no tooltips. Can also provide a list of strings representing columns to show in the tooltip, which will be displayed along with axis values. |
| `height` | `int \| None` | `None` | The height of the plot in pixels. |
| `label` | `str \| I18nData \| None` | `None` | The (optional) label to display on the top left corner of the plot. |
| `show_label` | `bool \| None` | `None` | Whether the label should be displayed. |
| `container` | `bool` | `True` | If True, will place the component in a container - providing some extra padding around the border. |
| `scale` | `int \| None` | `None` | relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. |
| `min_width` | `int` | `160` | minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
| `every` | `Timer \| float \| None` | `None` | Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
| `inputs` | `Component \| list[Component] \| Set[Component] \| None` | `None` | Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change. |
| `visible` | `bool \| Literal['hidden']` | `True` | Whether the plot should be visible. |
| `elem_id` | `str \| None` | `None` | An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
| `elem_classes` | `list[str] \| str \| None` | `None` | An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. |
| `render` | `bool` | `True` | If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
| `buttons` | `list[Literal['fullscreen', 'export'] \| Button] \| None` | `None` | A list of buttons to show for the component. Valid options are "fullscreen", "export", or a gr.Button() instance. The "fullscreen" button allows the user to view the plot in fullscreen mode. The "export" button allows the user to export and download the current view of the plot as a PNG image. Custom gr.Button() instances will appear in the toolbar with their configured icon and/or label, and clicking them will trigger any .click() events registered on the button. By default, no buttons are shown. |
| `key` | `int \| str \| tuple[int \| str, ...] \| None` | `None` | in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render. |
| `preserved_by_key` | `list[str] \| str \| None` | `"value"` | A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor. |
### Key Concepts

`gr.LinePlot`, `gr.ScatterPlot`, and `gr.BarPlot` all share the same API. Here is a summary of the most important features. For full details and live demos, see the  and  guides.

**Basic Usage with a DataFrame**

Pass a `pd.DataFrame` as the value, and specify `x` and `y` column names. The y-axis must be numeric; the x-axis can be strings, numbers, categories, or datetimes.

```python
import gradio as gr
import pandas as pd

df = pd.DataFrame({"weight": [50, 70, 90, 60], "height": [160, 175, 180, 165]})

with gr.Blocks() as demo:
    gr.ScatterPlot(df, x="weight", y="height")
```

**Breaking Out Series by Color**

Use the `color` argument to split data into multiple series. The color column can be string/categorical or numeric. Use `color_map` to assign specific colors:

```python
gr.ScatterPlot(df, x="weight", y="height", color="gender",
               color_map={"M": "#4488FF", "F": "#FF8844"})
```

**Aggregating Values**

Use `x_bin` and `y_aggregate` to group and summarize data. For numeric x-axes, `x_bin` creates histogram-style bins. For string x-axes, strings act as category bins automatically:

```python
gr.ScatterPlot(df, x="age_group", y="height", y_aggregate="mean")
gr.ScatterPlot(df, x="weight", y="height", x_bin=10, y_aggregate="mean")
```

For time-series data, pass a string suffix (`"s"`, `"m"`, `"h"`, or `"d"`) to `x_bin`:

```python
gr.ScatterPlot(df, x="timestamp", y="value", x_bin="1h", y_aggregate="mean")
```

**Interactive Selection and Zoom**

Use the `.select` event listener to respond to region selections (click and drag). Combine with `.double_click` and `x_lim` to implement zoom in/out:

```python
with gr.Blocks() as demo:
    plot = gr.ScatterPlot(df, x="weight", y="height")

    @plot.select
    def zoom(selection: gr.SelectData):
        return gr.ScatterPlot(x_lim=[selection.index[0], selection.index[1]])

    plot.double_click(lambda: gr.ScatterPlot(x_lim=None), outputs=plot)
```

**Realtime Data**

Use `gr.Timer` to keep plots updated with live data. You can attach the timer via `every`, or wire it up manually:

```python
def get_data():
    return pd.DataFrame(...)  # fetch latest data

with gr.Blocks() as demo:
    timer = gr.Timer(5)
    plot = gr.ScatterPlot(get_data, x="weight", y="height", every=timer)
```

**Interactive Dashboards**

Plots can be driven by other components (dropdowns, sliders, etc.) to create fully interactive dashboards:

```python
with gr.Blocks() as demo:
    category = gr.Dropdown(choices=["A", "B", "C"], value="A")
    plot = gr.ScatterPlot(x="weight", y="height")

    def update(cat):
        filtered = df[df["category"] == cat]
        return gr.ScatterPlot(filtered)

    category.change(update, inputs=category, outputs=plot)
```

### Shortcuts

| Class | Interface String Shortcut | Initialization |
|-------|--------------------------|----------------|
| `gradio.ScatterPlot` | `"scatterplot"` | Uses default values |
### Demos

**scatter_plot_demo**

[See demo on Hugging Face Spaces](https://huggingface.co/spaces/gradio/scatter_plot_demo)

```python
import pandas as pd
from random import randint, random
import gradio as gr


temp_sensor_data = pd.DataFrame(
    {
        "time": pd.date_range("2021-01-01", end="2021-01-05", periods=200),
        "temperature": [randint(50 + 10 * (i % 2), 65 + 15 * (i % 2)) for i in range(200)],
        "humidity": [randint(50 + 10 * (i % 2), 65 + 15 * (i % 2)) for i in range(200)],
        "location": ["indoor", "outdoor"] * 100,
    }
)

food_rating_data = pd.DataFrame(
    {
        "cuisine": [["Italian", "Mexican", "Chinese"][i % 3] for i in range(100)],
        "rating": [random() * 4 + 0.5 * (i % 3) for i in range(100)],
        "price": [randint(10, 50) + 4 * (i % 3) for i in range(100)],
        "wait": [random() for i in range(100)],
    }
)

with gr.Blocks() as scatter_plots:
    with gr.Row():
        start = gr.DateTime("2021-01-01 00:00:00", label="Start")
        end = gr.DateTime("2021-01-05 00:00:00", label="End")
        apply_btn = gr.Button("Apply", scale=0)
    with gr.Row():
        group_by = gr.Radio(["None", "30m", "1h", "4h", "1d"], value="None", label="Group by")
        aggregate = gr.Radio(["sum", "mean", "median", "min", "max"], value="sum", label="Aggregation")

    temp_by_time = gr.ScatterPlot(
        temp_sensor_data,
        x="time",
        y="temperature",
    )
    temp_by_time_location = gr.ScatterPlot(
        temp_sensor_data,
        x="time",
        y="temperature",
        color="location",
    )

    time_graphs = [temp_by_time, temp_by_time_location]
    group_by.change(
        lambda group: [gr.ScatterPlot(x_bin=None if group == "None" else group)] * len(time_graphs),
        group_by,
        time_graphs
    )
    aggregate.change(
        lambda aggregate: [gr.ScatterPlot(y_aggregate=aggregate)] * len(time_graphs),
        aggregate,
        time_graphs
    )

    price_by_cuisine = gr.ScatterPlot(
        food_rating_data,
        x="cuisine",
        y="price",
    )
    with gr.Row():
        price_by_rating = gr.ScatterPlot(
            food_rating_data,
            x="rating",
            y="price",
            color="wait",
            buttons=["actions"],  
        )
        price_by_rating_color = gr.ScatterPlot(
            food_rating_data,
            x="rating",
            y="price",
            color="cuisine",
        )

if __name__ == "__main__":
    scatter_plots.launch()
```

### Event Listeners

#### Description

Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.

#### Supported Event Listeners

The `ScatterPlot` component supports the following event listeners:

- `ScatterPlot.select(fn, ...)`: Event listener for when the user selects or deselects the NativePlot. Uses event data gradio.SelectData to carry `value` referring to the label of the NativePlot, and `selected` to refer to state of the NativePlot. See https://www.gradio.app/main/docs/gradio/eventdata for more details.
- `ScatterPlot.double_click(fn, ...)`: Triggered when the NativePlot is double clicked.

#### Event Parameters

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `fn` | `Callable \| None \| Literal['decorator']` | `"decorator"` | the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. |
| `inputs` | `Component \| BlockContext \| list[Component \| BlockContext] \| Set[Component \| BlockContext] \| None` | `None` | List of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
| `outputs` | `Component \| BlockContext \| list[Component \| BlockContext] \| Set[Component \| BlockContext] \| None` | `None` | List of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
| `api_name` | `str \| None` | `None` | defines how the endpoint appears in the API docs. Can be a string or None. If set to a string, the endpoint will be exposed in the API docs with the given name. If None (default), the name of the function will be used as the API endpoint. |
| `api_description` | `str \| None \| Literal[False]` | `None` | Description of the API endpoint. Can be a string, None, or False. If set to a string, the endpoint will be exposed in the API docs with the given description. If None, the function's docstring will be used as the API endpoint description. If False, then no description will be displayed in the API docs. |
| `scroll_to_output` | `bool` | `False` | If True, will scroll to output component on completion |
| `show_progress` | `Literal['full', 'minimal', 'hidden']` | `"full"` | how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all |
| `show_progress_on` | `Component \| list[Component] \| None` | `None` | Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
| `queue` | `bool` | `True` | If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. |
| `batch` | `bool` | `False` | If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. |
| `max_batch_size` | `int` | `4` | Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
| `preprocess` | `bool` | `True` | If False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). |
| `postprocess` | `bool` | `True` | If False, will not run postprocessing of component data before returning 'fn' output to the browser. |
| `cancels` | `dict[str, Any] \| list[dict[str, Any]] \| None` | `None` | A list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. |
| `trigger_mode` | `Literal['once', 'multiple', 'always_last'] \| None` | `None` | If "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete. |
| `js` | `str \| Literal[True] \| None` | `None` | Optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components. |
| `concurrency_limit` | `int \| None \| Literal['default']` | `"default"` | If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). |
| `concurrency_id` | `str \| None` | `None` | If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
| `api_visibility` | `Literal['public', 'private', 'undocumented']` | `"public"` | controls the visibility and accessibility of this endpoint. Can be "public" (shown in API docs and callable by clients), "private" (hidden from API docs and not callable by the Gradio client libraries), or "undocumented" (hidden from API docs but callable by clients and via gr.load). If fn is None, api_visibility will automatically be set to "private". |
| `time_limit` | `int \| None` | `None` |  |
| `stream_every` | `float` | `0.5` |  |
| `key` | `int \| str \| tuple[int \| str, ...] \| None` | `None` | A unique key for this event listener to be used in @gr.render(). If set, this value identifies an event as identical across re-renders when the key is identical. |
| `validator` | `Callable \| None` | `None` | Optional validation function to run before the main function. If provided, this function will be executed first with queue=False, and only if it completes successfully will the main function be called. The validator receives the same inputs as the main function and should return a `gr.validate()` for each input value. |
- [Creating Plots](https://www.gradio.app/guides/creating-plots/)