dash_mp_components.SearchUIContainer

class dash_mp_components.SearchUIContainer(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: str | None = None, columns: Sequence | None = None, filterGroups: Sequence | None = None, apiEndpoint: str | None = None, apiEndpointParams: dict | None = None, autocompleteFormulaUrl: str | None = None, apiKey: str | None = None, resultLabel: str | None = None, hasSortMenu: bool | None = None, sortFields: Sequence[str] | None = None, sortKey: str | None = None, skipKey: str | None = None, limitKey: str | None = None, totalKey: str | None = None, fieldsKey: str | None = None, conditionalRowStyles: Sequence | None = None, selectableRows: bool | None = None, selectedRows: Sequence | None = None, view: Literal['table', 'synthesis'] | None = None, disableRichColumnHeaders: bool | None = None, results: Sequence | None = None, lastClickedCell: dict | None = None, popoverContent: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, **kwargs)[source]

Bases: Component

A SearchUIContainer component. A component that can wrap around sub-components of SearchUI and ensure they are all hooked up to the same context. This allows you to use the state management functionality of SearchUI with the ability to customize the inner layout and components.

Keyword arguments:

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

  • id (string; optional)

  • apiEndpoint (string; optional)

  • apiEndpointParams (dict; optional)

  • apiKey (string; optional)

  • autocompleteFormulaUrl (string; optional)

  • className (string; optional)

  • columns (list; optional)

  • conditionalRowStyles (list; optional)

  • disableRichColumnHeaders (boolean; optional)

  • fieldsKey (string; optional)

  • filterGroups (list; optional)

  • hasSortMenu (boolean; optional)

  • lastClickedCell (dict; optional):

    Set automatically by the SearchUI when a LINK_POPOVER cell is clicked. Shape: {selector, value, row, ts}. Used as a Dash callback Input to trigger server-side resolution that populates popoverContent.

  • limitKey (string; optional)

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

    Renderable content (Dash component tree) shown inside the popover for the most recently clicked LINK_POPOVER cell. Typically set by a Dash callback responding to lastClickedCell.

  • resultLabel (string; optional)

  • results (list; optional)

  • selectableRows (boolean; optional)

  • selectedRows (list; optional)

  • skipKey (string; optional)

  • sortFields (list of strings; optional)

  • sortKey (string; optional)

  • totalKey (string; optional)

  • view (a value equal to: ‘table’, ‘synthesis’; optional)

__init__(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: str | None = None, columns: Sequence | None = None, filterGroups: Sequence | None = None, apiEndpoint: str | None = None, apiEndpointParams: dict | None = None, autocompleteFormulaUrl: str | None = None, apiKey: str | None = None, resultLabel: str | None = None, hasSortMenu: bool | None = None, sortFields: Sequence[str] | None = None, sortKey: str | None = None, skipKey: str | None = None, limitKey: str | None = None, totalKey: str | None = None, fieldsKey: str | None = None, conditionalRowStyles: Sequence | None = None, selectableRows: bool | None = None, selectedRows: Sequence | None = None, view: Literal['table', 'synthesis'] | None = None, disableRichColumnHeaders: bool | None = None, results: Sequence | None = None, lastClickedCell: dict | None = None, popoverContent: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, **kwargs)

Methods

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

to_plotly_json()

Attributes

REQUIRED

UNDEFINED

available_wildcard_properties