************************************ ``dash`` module ************************************ The dash module in the ``visualization_toolkit`` contains common abstractions to launch dash apps with best practices. The functions can assist with generating queries, caching results, tracking user interactions and more. Many components offered in the dash module are built with ``yipit-dash-mui-components``. Core Component Functions =================================== Functions that generate Dash components that are commonly needed in building data apps. .. autoapifunction:: visualization_toolkit.helpers.dash.chart_component .. autoapifunction:: visualization_toolkit.helpers.dash.custom_tooltip_callback Core Dash Functions =================================== Functions that are generic utilities for working with Dash apps. .. autoapifunction:: visualization_toolkit.helpers.dash.initialize_app .. autoapifunction:: visualization_toolkit.helpers.dash.get_triggered_id .. autoapifunction:: visualization_toolkit.helpers.dash.resolve_html_id Core Databricks Functions =================================== Functions to handle connecting to Databricks to execute queries and other spark interactions. .. autoapifunction:: visualization_toolkit.helpers.dash.execute_query .. autoapifunction:: visualization_toolkit.helpers.dash.get_spark_session Core Query Template Functions =================================== Functions to templatize queries via Jinja2. These can be useful to make query logic more dynamic in data apps. .. autoapifunction:: visualization_toolkit.helpers.dash.sql_query_from_template Core Export Functions =================================== Functions to enable file downloads of data components, including charts and tables. .. autoapifunction:: visualization_toolkit.helpers.dash.export_chart_button_component .. autoapifunction:: visualization_toolkit.helpers.dash.setup_chart_exports Core Analytics Functions =================================== Functions to track user activity within the dash app. These can augment dash components to track when elements are visible, clicked on, and more. Most of these actions are tracked on the browser through dash client-side callbacks. Most of these functions will require enabling a ``user_store`` and ``visibility_store`` in addition to initializing a pendo client via ``pendo_initialize_callback``. .. autoapifunction:: visualization_toolkit.helpers.dash.user_store .. autoapifunction:: visualization_toolkit.helpers.dash.visibility_store .. autoapifunction:: visualization_toolkit.helpers.dash.control_store .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_initialize_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_click_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_input_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_select_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_select_range_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_visible_elements_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_table_sort_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_table_filter_callback .. autoapifunction:: visualization_toolkit.helpers.dash.pendo_track_page_load_callback Core Celery Functions =================================== Helper functions to integrate dash applications with celery. Commonly used in production deployments of dash. .. autoapifunction:: visualization_toolkit.helpers.dash.setup_celery_app Core System Monitoring Functions =================================== Helper functions to setup production monitoring of a dash app. These will be necesary for deployments in the Cloud. .. autoapifunction:: visualization_toolkit.helpers.dash.setup_sentry .. autoapifunction:: visualization_toolkit.helpers.dash.setup_datadog .. autoapifunction:: visualization_toolkit.helpers.dash.setup_healthcheck