Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.82 KB

getdata.rst

File metadata and controls

70 lines (48 loc) · 2.82 KB
Raw

Getting summary / underlying data

Summary and underlying data can be retrieved as list of dicts from tableau dashboards using the :py:meth:`~client_code.model.proxies.Worksheet.get_underlying_data` and :py:meth:`~client_code.model.proxies.Worksheet.get_summary_data` methods of a :class:`~client_code.model.proxies.Worksheet` object.

from ._anvil_designer import MainTemplate
from anvil import *
from trexjacket.api import get_dashboard

class Main(MainTemplate):
  def __init__(self, **properties):
    self.init_components(**properties)
    self.dashboard = get_dashboard()
    self.chart = self.dashboard.get_worksheet('Viz')
    print(self.chart.get_underlying_data())
    print(self.chart.get_summary_data())

  def primary_button_1_click(self, **event_args):
    """This method is called when the button is clicked"""
    print(self.chart.get_underlying_data())  # note that this is a lot of output
    print(self.chart.get_summary_data())
    self.text_area_1.text = self.chart.get_summary_data()

After reloading the extension and clicking the "Show data" button, you should see this output in the Anvil "Tableau" pane (screenshot of the Viz worksheet for reference).

https://extension-documentation.s3.amazonaws.com/guides/get_data/static_image.PNG

# printed output from .get_underlying_data()
# and .get_summary_data()

[
  ...
  {'Ship Mode': 'Second Class', 'Sales': 120.768},
  {'Ship Mode': 'First Class', 'Sales': 25.92},
  {'Ship Mode': 'First Class', 'Sales': 34.65000000000001},
  ...
]

[
  {'Ship Mode': 'Same Day', 'SUM(Sales)': 128363.125},
  {'Ship Mode': 'First Class', 'SUM(Sales)': 351428.4229000002},
  {'Ship Mode': 'Second Class', 'SUM(Sales)': 459193.5693999998},
  {'Ship Mode': 'Standard Class', 'SUM(Sales)': 1358215.742999983}
]
.. dropdown:: This gif shows binding the result of :py:meth:`~client_code.model.proxies.Worksheet.get_summary_data` to the text property of a Text Area component
    :open:

    .. image:: https://extension-documentation.s3.amazonaws.com/guides/get_data/demo.gif

If you aren't familiar with how to bind an Anvil component to a Tableau component, see :doc:`../binding_components/binding_components`.

.. button-link:: https://anvil.works/build#clone:XRNVUO5QWET5N2E3=OIJ63TP3YQTT4PPDLNNVNXHW
   :color: primary
   :shadow:

   Click here to clone the Anvil App

And :download:`here <https://extension-documentation.s3.amazonaws.com/guides/get_data/underlying_data.twb>` for the Tableau workbook