Skip to content

Commit

Permalink
update Python docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Patrick Kyle committed Aug 1, 2020
1 parent 9614556 commit 8dfae3f
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions dash_pivottable/PivotTable.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,31 @@

class PivotTable(Component):
"""A PivotTable component.
...
Pivot tables are useful for interactive presentation of
summary statistics computed for data contained in another table.
The `dashPivottable` function provides a convenient Dash interface
to the `react-pivottable` component, which makes it easy to embed
pivot tables into Dash for R applications.
Within React, the interactive component provided by `react-pivottable`
is `PivotTableUI`, but output rendering is delegated to the non-interactive
`PivotTable` component, which accepts a subset of its properties.
`PivotTable` in turn delegates to a specific renderer component, such as
the default `TableRenderer`, which accepts a subset of the same properties.
Finally, most renderers will create non-React PivotData objects to handle
the actual computations, which also accept a subset of the same properties
as the rest of the stack.
The arguments for `dashPivottable` corresepond to properties of the component;
a full list is provided below.
`react-pivottable` was developed by Nicolas Kruchten; source
for this component is available from https://github.com/plotly/react-pivottable.
Keyword arguments:
- id (string; optional): The ID used to identify this component in Dash callbacks
- data (list; optional): The input data
- data (list; optional): data to be summarized
- hiddenAttributes (list; optional): contains attribute names to omit from the UI
- hiddenFromAggregators (list; optional): contains attribute names to omit from the aggregator arguments dropdowns
- hiddenFromDragDrop (list; optional): contains attribute names to omit from the drag'n'drop portion of the UI
Expand Down

0 comments on commit 8dfae3f

Please sign in to comment.