8000 fixed typos and links · SnarkyPapi/server-client-python@e1222d1 · GitHub
[go: up one dir, main page]

Skip to content

Commit e1222d1

Browse files
author
Chris Shin
committed
fixed typos and links
1 parent 51883e9 commit e1222d1

File tree

1 file changed

+7
-24
lines changed

1 file changed

+7
-24
lines changed

docs/api-ref.md

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3030,13 +3030,13 @@ Source file: models/view_item.py
30303030
Name | Description
30313031
:--- | :---
30323032
`content_url` | The name of the view as it would appear in a URL.
3033-
`csv` | The CSV data of the view. You must first call the [views.populate_csv](#views.populate_csv) method to access the CSV data.
3033+
`csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data.
30343034
`id` | The identifier of the view item.
3035-
`image` | The image of the view. You must first call the [views.populate_image](#views.populate_image) method to access the image.
3035+
`image` | The image of the view. You must first call the `views.populate_image`method to access the image.
30363036
`name` | The name of the view.
30373037
`owner_id` | The ID for the owner of the view.
3038-
`pdf` | The PDF of the view. You must first call the [views.populate_pdf](#views.populate_pdf) method to access the PDF content.
3039-
`preview_image` | The thumbnail image for the view. You must first call the [views.populate_preview_image](#views.populate_preview_image) method to access the preview image.
3038+
`pdf` | The PDF of the view. You must first call the `views.populate_pdf` method to access the PDF content.
3039+
`preview_image` | The thumbnail image for the view. You must first call the `views.populate_preview_image` method to access the preview image.
30403040
`project_id` | The ID of the project that contains the view.
30413041
`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at.
30423042
`workbook_id` | The ID of the workbook associated with the view.
@@ -3128,7 +3128,7 @@ This endpoint is available with REST API version 2.0 and up.
31283128

31293129
Name | Description
31303130
:--- | :---
3131-
`view_item` | Specified the view to populate.
3131+
`view_item` | Specifies the view to populate.
31323132

31333133

31343134
**Exceptions**
@@ -3169,7 +3169,7 @@ This endpoint is available with REST API version 2.5 and up.
31693169
Name | description
31703170
:--- | :---
31713171
`view_item` | Specifies the view to populate.
3172-
`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution.
3172+
`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. See [ImageRequestOptions class](#imagerequestoptions-class)
31733173

31743174
**Exceptions**
31753175

@@ -3181,14 +3181,6 @@ Error | Description
31813181

31823182
None. The image is added to the `view_item` and can be accessed by its `image` field.
31833183

3184-
**Example**
3185-
3186-
Creating a request option for high resolution image:
3187-
```py
3188-
req_options = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High)
3189-
server.views.populate_image(view_item, req_options=req_options)
3190-
```
3191-
31923184
See [ViewItem class](#viewitem-class)
31933185

31943186
<br>
@@ -3250,7 +3242,7 @@ This endpoint is available with REST API version 2.7 and up.
32503242
Name | description
32513243
:--- | :---
32523244
`view_item` | Specifies the view to populate.
3253-
`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation.
3245+
`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. See [PDFRequestOptions class](#pdfrequestoptions-class)
32543246

32553247
**Exceptions**
32563248

@@ -3262,15 +3254,6 @@ Error | Description
32623254

32633255
None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field.
32643256

3265-
**Example**
3266-
3267-
Creating a request option for page type and orientation:
3268-
```py
3269-
req_options = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A5,
3270-
orientation=TSC.PDFRequestOptions.Orientation.Landscape)
3271-
server.views.populate_pdf(view_item, req_options=req_options)
3272-
```
3273-
32743257
See [ViewItem class](#viewitem-class)
32753258

32763259
<br>

0 commit comments

Comments
 (0)
0