dash_mp_components.BibFilter

class dash_mp_components.BibFilter(id: str | dict | None = None, className: str | None = None, format: Literal['bibjson', 'crossref'] | None = None, bibEntries: Sequence | None = None, sortField: Literal['year', 'author', 'title'] | None = None, ascending: bool | None = None, resultClassName: str | None = None, preventOpenAccessFetch: bool | None = None, **kwargs)[source]

Bases: Component

A BibFilter component. Component for rendering and filtering a list of citations in bibjson or crossref format Expects bibjson in the format output by the bibtexparser library (https://bibtexparser.readthedocs.io/en/v1.1.0/tutorial.html#) Expects crossref in the format returned by the Crossref API

Keyword arguments:

  • id (string; optional):

    The ID used to identify this component in Dash callbacks.

  • ascending (boolean; optional):

    Set to True to have the initial sorting direction be ascending @default False.

  • bibEntries (list; optional):

    List of bib objects in bibjson or crossref format Only the following bib properties are used by this component: - title - author (as a list or string) - year - doi - journal If any of those properties are missing, that property will be omitted from the bibjson result card. Any extra properties are simply ignored.

  • className (string; optional):

    Class name(s) to append to the component’s default class (mpc-bib-filter).

  • format (a value equal to: ‘bibjson’, ‘crossref’; optional):

    Format of the bibliographoc objects supplied in bibEntries @default ‘bibjson’.

  • preventOpenAccessFetch (boolean; optional):

    Set to True to prevent dynamically fetching a link to a free PDF of each reference (using the “doi” field for individual bib entry). NOTE: the open access URL can also be included in a bib entry in the “openAccessUrl” property. If set, the URL will not be fetched. @default False.

  • resultClassName (string; optional):

    Class name(s) to append to individual result cards’ default class (mpc-bib-card).

  • sortField (a value equal to: ‘year’, ‘author’, ‘title’; optional):

    Name of property to initially sort entries by @default ‘year’.

__init__(id: str | dict | None = None, className: str | None = None, format: Literal['bibjson', 'crossref'] | None = None, bibEntries: Sequence | None = None, sortField: Literal['year', 'author', 'title'] | None = None, ascending: bool | None = None, resultClassName: str | None = None, preventOpenAccessFetch: bool | None = None, **kwargs)

Methods

__init__([id, className, format, ...])

to_plotly_json()

Attributes

REQUIRED

UNDEFINED

available_wildcard_properties