Skip to content

Commit 977a2fa

Browse files
committed
Added missing enums
1 parent af7e724 commit 977a2fa

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

docs/trex_release-notes.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,38 +29,35 @@ This release contains updates for [Tableau Viz]({{site.baseurl}}/docs/trex_table
2929

3030
* Added support for setting the size of a bar mark to be manual or fixed. You can also set the mark’s size and alignment.
3131

32-
* Added support for sorting. You can sort a field (continuous or discrete). Supports sorting by ascending or descending values for continuous fields and discrete fields (`VizImageSortDirectionType.Ascending`, `VizImageSortDirectionType.Descending`).
32+
* Added support for sorting. You can sort a field (continuous or discrete) by ascending or descending values (`VizImageSortDirectionType.Ascending`, `VizImageSortDirectionType.Descending`).
3333

3434
```javascript
3535
sort: { field: "Category", sortby: "Weather", direction: tableau.VizImageSortDirectionType.Ascending }
3636
```
3737

38-
* For continuous fields, you can set the color palette to a custom diverging or custom sequential color palette and not just a Tableau defined palate, such as, `green_blue_white_diverging_10_0`.
38+
* For continuous fields, you can set the color palette to a custom-diverging, or custom-sequential color palette. You are not restricted to using only a Tableau defined palate, such as, `green_blue_white_diverging_10_0`.
3939
For example, you could set the custom palette as shown in the following examples:
4040

41-
4241
```javascript
4342
44-
palette: "custom-diverging", start: "#FFB6C1", end: "#90ee90"
43+
palette: tableau.VizImagePaletteType.CustomDiverging, start: "#FFB6C1", end: "#90ee90"
4544
4645
```
4746

4847
Or
4948

5049
```javascript
5150
52-
palette: "custom-sequential", end: "#FFB6C1"
51+
palette: tableau.VizImagePaletteType.CustomSequential, end: "#FFB6C1"
5352
5453
```
5554

5655
* Added support to show or hide grid lines in the view for rows or columns, or both.
5756

58-
* Starting with the v1.8 release of the Dashboard Extensions API library and Tableau 2021.4, Tableau Viz now uses the Tableau fonts as the default font for text in the output SVG image.
59-
57+
* Starting with the v1.8 release of the Dashboard Extensions API library and Tableau 2021.4, Tableau Viz now uses Tableau fonts as the default font for text in the output SVG image.
6058

6159
For more information, see [Tableau Viz Reference]({{site.baseurl}}/docs/trex_tableau_viz_ref.html){:target="_blank"}
6260

63-
6461
----
6562

6663
### Tableau Dashboard Extensions API version 1.7

docs/trex_tableau_viz_ref.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -177,23 +177,23 @@ Specifies the size encoding of the mark. The `size` property corresponds to the
177177
| `size` Property | Value |
178178
|:--- |:--- |
179179
|`field` | The name of the field to encode. |
180-
|`type`| The way the data is distributed in the view (`discrete` or `continuous`).|
181-
|`setting` | For continuous fields of the bar mark type, specifies the size and alignment properties of a mark. The options are `manual` or `fixed` size. For `manual`, you can specify a `size` value from `0` to `2`. For `fixed` you can set the alignment and width in axis units. See the `setting` properties for more information. |
180+
|`type`| The way the data is distributed in the view (discrete or continuous).|
181+
|`setting` | For continuous fields of the bar mark type, specifies the size and alignment properties of a mark. The options are manual (`tableau.VizImageSizeSettingType.Manual`) or fixed size (`tableau.VizImageSizeSettingType.Fixed`). For manual, you can specify a `size` value from `0` to `2`. For fixed, you can set the alignment and width in axis units. See the `setting` properties for more information. |
182182
|`showlegend` | Boolean (`true`, `false`). Specifies whether to show or hide the color legend. |
183183

184184

185185
|`setting` Property | Value |
186186
|:--- |:--- |
187-
|`fixed` | Mark size is fixed. When `fixed` is selected, you can set the `alignment` to `right`, `left`, or `center`. You can set the `width_in_axis_units` to a fixed number of units (floating point values accepted). |
188-
|`manual` | Specifies that the mark size type is manual. When this is selected, set the `marksize` value (from 0 to 2, floating point values accepted). |
187+
|`tableau.VizImageSizeSettingType.Fixed` | Mark size is fixed. When `Fixed` is selected, you can set the `alignment` to `tableau.VizImageSizeSettingAlignmentType.Right`, `tableau.VizImageSizeSettingAlignmentType.Left`, or `tableau.VizImageSizeSettingAlignmentType.Center`. You can set the `width_in_axis_units` to a fixed number of units (floating point values accepted). |
188+
|`tableau.VizImageSizeSettingType.Manual` | Specifies that the mark size type is manual. When this is selected, set the `marksize` value (from 0 to 2, floating point values accepted). |
189189

190190
Example of fixed sized type:
191191

192192
```javascript
193193

194194
encoding: {
195195
...
196-
size: {field: "Age", setting: "fixed", alignment: "right", width_in_axis_units: 3}
196+
size: {field: "Age", setting: tableau.VizImageSizeSettingType.Fixed, alignment: tableau.VizImageSizeSettingAlignmentType.Right, width_in_axis_units: 3}
197197

198198
}
199199
```
@@ -203,7 +203,7 @@ Example of manual sized type:
203203
```javascript
204204
encoding: {
205205
...
206-
size: {field: "Measure", type: tableau.VizImageEncodingType.Continuous, setting: "manual", marksize: 0.35}
206+
size: {field: "Measure", type: tableau.VizImageEncodingType.Continuous, setting: tableau.VizImageSizeSettingType.Manual, marksize: 0.35}
207207
}
208208
```
209209

@@ -284,23 +284,23 @@ You can set the color palette to a custom diverging or custom sequential color p
284284

285285
| Custom Palette Property | Value |
286286
|:--- |:--- |
287-
|`custom-diverging` | Defines a custom diverging palette. Specify the `start` value and an `end` value, each as a hexadecimal value. |
288-
| `custom-sequential` | Defines a custom sequential palette. Specify the `end` value as a hexadecimal value. |
287+
|`tableau.VizImagePaletteType.CustomDiverging` | Defines a custom diverging palette. Specify the `start` value and an `end` value, each as a hexadecimal value. |
288+
| `tableau.VizImagePaletteType.CustomSequential` | Defines a custom sequential palette. Specify the `end` value as a hexadecimal value. |
289289

290290

291291
For example, you could set a custom palette as shown in the following examples:
292292

293293

294294
```javascript
295295

296-
palette: "custom-diverging", start: "#FFB6C1", end: "#90ee90"
296+
palette: tableau.VizImagePaletteType.CustomDiverging, start: "#FFB6C1", end: "#90ee90"
297297

298298
```
299299

300300
Or
301301

302302
```javascript
303303

304-
palette: "custom-sequential", end: "#FFB6C1"
304+
palette: tableau.VizImagePaletteType.CustomSequential, end: "#FFB6C1"
305305

306306
```

0 commit comments

Comments
 (0)