Skip to content

Commit 37d2c42

Browse files
committed
Update documentation
1 parent f9d1380 commit 37d2c42

3 files changed

Lines changed: 28 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 012 (December 2023)
2+
* Add new worksheet class
3+
* Add worksheet items attribute to workbook class
4+
15
## 011 (November 2022)
26
* Remove extraneous debug print statements
37

docs/docs/api-ref.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,35 @@ Saves any changes to the workbook to a new file specified by the `new_file` para
3434

3535
`self.worksheets:` Returns a list of worksheets found in the workbook.
3636

37+
`self.worksheet_items:` Returns a list of Worksheet objects found in the workbook.
38+
3739
`self.datasources:` Returns a list of Datasource objects found in the workbook.
3840

3941
`self.filename:` Returns the filename of the workbook.
4042

4143
`self.shapes` Returns a list of strings with the names of shapes found in the workbook.
4244

45+
## Worksheets
46+
```python
47+
class Worksheet(wsxml):
48+
```
49+
50+
The Worksheet class represents the worksheets found in a Tableau Workbook. The library will access key attributes of each worksheet it finds.
51+
52+
**Properties:**
53+
54+
`self.name`: Returns the name of the worksheet.
55+
56+
`self.datasources`: Returns list of the Datasource objects that are used in the worksheet.
57+
58+
`self.fields`: Returns list of Field objects that are used somewhere within the sheet.
59+
60+
`self.rows`: Returns list of Field objects present on the rows shelf. Certain items will return a string value, such as "Measure Names" which is not a field.
61+
62+
`self.cols`: Returns list of Field objects present on the columns shelf. Certain items will return a string value, such as "Measure Names" which is not a field.
63+
64+
`self.filter_fields`: Returns list of Field objects that are present on the Filter pane. Certain items will return a string value, such as Filter Actions.
65+
4366
## Datasources
4467
```python
4568
class Datasource(dsxml, filename=None)

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name='tableaudocumentapi',
5-
version='0.11',
5+
version='0.12',
66
author='Tableau',
77
author_email='github@tableau.com',
88
url='https://github.com/tableau/document-api-python',

0 commit comments

Comments
 (0)