dash_mp_components.DownloadButton

class dash_mp_components.DownloadButton(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: str | None = None, data: Any | None = None, filename: str | None = None, filetype: Literal['json', 'csv', 'xlsx'] | None = None, tooltip: str | None = None, **kwargs)[source]

Bases: Component

A DownloadButton component. Button for exporting arrays or objects to files

Keyword arguments:

  • children (a list of or a singular dash component, string or number; optional):

    Use the children prop to set the button content This can be simple text or a component.

  • id (string; optional):

    The ID used to identify this component in Dash callbacks.

  • className (string; optional):

    Class(es) to add to the top-level element of the component Note: the class “mpc-download-button” is always added.

  • data (optional):

    Array or object (list or dictionary) to be downloaded If downloading as csv or xlsx, data must be an array/list.

  • filename (string; optional):

    Name of the file WITHOUT the extension (default: “export”).

  • filetype (a value equal to: ‘json’, ‘csv’, ‘xlsx’; optional):

    File type to be downloaded This is also the extension that will be appended to the filename (default: “json”).

  • tooltip (string; optional):

    Optional tooltip to display above the button on hover.

__init__(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: str | None = None, data: Any | None = None, filename: str | None = None, filetype: Literal['json', 'csv', 'xlsx'] | None = None, tooltip: str | None = None, **kwargs)

Methods

__init__([children, id, className, data, ...])

to_plotly_json()

Attributes

REQUIRED

UNDEFINED

available_wildcard_properties