Skip to content

Commit 9300080

Browse files
authored
Merge pull request #602 from d45/d45/fix_icons_known_issues
fixing typo, wording, and api index
2 parents 7b22c79 + ec6015d commit 9300080

File tree

3 files changed

+3
-4
lines changed

3 files changed

+3
-4
lines changed

website/docs/vizext/trex_viz_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ This example illustrates some of the components that are common need to include
298298

299299
This is the code that draws the viz based on the current encodings and data. This example is extremely simplified and just uses the method called to retrieve the encoding, `worksheet.getVisualSpecificationAsync()`. From the `visualSpec`, the list of encodings is collected from the Marks card. The HelloVizExtensions example just has one encoding tile labeled "Drop..." The list of fields that are dropped on the tile are displayed in the content area of the worksheet. In real life, you would use multiple encodings that would correspond to the coordinates in your visualization (for example, x, y, and r).
300300

301-
The other missing piece from this code example is the data. To retrieve the data from the worksheet, you call the `worksheet.getSummaryDataReaderAsync()` method. This method returns a `DataTableReader`, which you use to page through the summary data in the worksheet, to extract the rows of data. See the conncecteScatterplot viz extension sample to see an example of how this is done.
301+
The other missing piece from this code example is the data. To retrieve the data from the worksheet, you call the `worksheet.getSummaryDataReaderAsync()` method. This method returns a `DataTableReader`, which you use to page through the summary data in the worksheet, to extract the rows of data. See the ConnectedScatterplot viz extension sample to see an example of how this is done.
302302

303303
Finally, after you have the data and the map of encodings to fields you can pass this to code that can generate a scatterplot, a Sankey diagram, or network visualization. This example just prints the fields to the content area of the worksheet. But it's a start.
304304

@@ -318,7 +318,7 @@ Our sample code follows the [Semi-Standard Style](https://github.com/Flet/semist
318318

319319
## What's next?
320320

321-
- For more information about how you can use the Extensions API, go look at the [Samples](https://github.com/tableau/extensions-api/tree/main/Samples/). Study the sample, connectedScatterPlot, to see a full implementation of a viz extension.
321+
- For more information about how you can use the Extensions API, go look at the [Samples](https://github.com/tableau/extensions-api/tree/main/Samples/). Study the sample, ConnectedScatterPlot, to see a full implementation of a viz extension.
322322

323323
- Get familiar with the programming interface of the Extensions API, see [API Reference](pathname:///api/).
324324

website/docs/vizext/trex_viz_manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The versioning of the manifest is designed to be semantically simple and support
1515

1616
:::note
1717

18-
Each extension must be uniquely identified. If multiple extensions in a workbook share the same combination of URL, ID, and version number, the extension zones will not load properly. As a best practice, use unique identifiers for each viz or dashboard extension when creating the manifest file (.trex). For example, for viz extensions, make sure that the same `<worksheet-extension>` `id` and `extension-version`, and the `<source-location>` `url` aren't all used in other extensions.
18+
Each extension must be uniquely identified. If multiple extensions in a workbook share the same combination of URL, ID, and version number, the extension zones will not load properly. As a best practice, use unique identifiers for each viz or dashboard extension when creating the manifest file (.trex). For example, for viz extensions, make sure that the same `<worksheet-extension>` `id` and `extension-version`, and the `<source-location>` `url` aren't all used together in other extensions.
1919

2020
:::
2121

website/static/api/index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ <h2>Viz extensions (available in beta only)</h2>
134134
</style>
135135
<p class="copyRight">&copy; Copyright <script>document.write(new Date().getFullYear())</script> Salesforce, Inc. <a href="https://www.salesforce.com/company/legal/tmcusageguidelines/">All rights reserved.</a> Various trademarks held by their respective owners.
136136
Salesforce, Inc. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States</p>
137-
<p><sub>Documentation last generated on: <script>document.write(new Date().toLocaleString())</script></sub></p>
138137
</div>
139138
</div>
140139
</div>

0 commit comments

Comments
 (0)