Notes

Defines the notes component for the Qimchi Dash app.

qimchi.components.notes.notes_viewer() Div[source]

Notes viewer

Returns:

Div element containing a textarea for notes and a collapsible markdown viewer

Return type:

dash.html.Div

qimchi.components.notes.show_hide_preview(n_clicks: int) tuple[source]

Callback to show or hide the markdown preview

Parameters:

n_clicks (int) – Number of times the button has been clicked

Returns:

Style to display the markdown preview and the button icon

Return type:

tuple

qimchi.components.notes.update_output(sess_id: str, new_notes: str) str[source]

Callback to update the markdown preview

Parameters:
  • sess_id (str) – Session ID to load the state for

  • new_notes (str) – Value of the notes textarea

Returns:

Markdown preview to be displayed

Return type:

str

qimchi.components.notes.update_notes(sess_id: str, sig: int) str[source]

Callback to update notes & preview

Parameters:
  • sess_id (str) – Session ID to load the state for

  • sig (int) – Signal to indicate that data has been updated

Returns:

Notes to be displayed

Return type:

str

qimchi.components.notes.show_hide_notes(n_clicks: int) tuple[source]

Callback to show or hide the notes viewer

Parameters:

n_clicks (int) – Number of times the button has been clicked

Returns:

className to display the notes viewer and the updated button icon

Return type:

tuple