${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r
diff --git a/website/static/api/enums/AnnotationType.html b/website/static/api/enums/AnnotationType.html
new file mode 100644
index 00000000..4c593eb1
--- /dev/null
+++ b/website/static/api/enums/AnnotationType.html
@@ -0,0 +1,28 @@
+
diff --git a/website/static/api/enums/ClassNameKey.html b/website/static/api/enums/ClassNameKey.html
new file mode 100644
index 00000000..b735b06b
--- /dev/null
+++ b/website/static/api/enums/ClassNameKey.html
@@ -0,0 +1,33 @@
+
Enumeration ClassNameKey
Index
Enumeration Members
Enumeration Members
Column
ColumnDividers: "tableau-column-dividers"
Dashboard
DashboardTitle: "tableau-dashboard-title"
Pane
Pane: "tableau-pane"
Row
RowDividers: "tableau-row-dividers"
Story
StoryTitle: "tableau-story-title"
Tooltip
Tooltip: "tableau-tooltip"
Worksheet
Worksheet: "tableau-worksheet"
Worksheet
WorksheetTitle: "tableau-worksheet-title"
Enumeration ColumnType
Index
Enumeration Members
Enumeration DashboardLayoutChange
Index
Enumeration Members
Enumeration Members
Added
Added: "added"
A dashboard object was added
+Dashboard
DashboardChanged: "dashboard-changed"
Navigate to another dashboard
+Deselected
Deselected: "deselected"
A dashboard object is deselected
+Is
IsFloatingChanged: "is-floating-changed"
A dashboard object's floating state changed
+Is
IsVisibleChanged: "is-visible-changed"
A dashboard object's visibility changed
+Name
NameChanged: "name-changed"
A dashboard object was renamed
+Position
PositionChanged: "position-changed"
A dashboard object's position changed
+Removed
Removed: "removed"
A dashboard object was removed
+Selected
Selected: "selected"
A dashboard object is selected
+Size
SizeChanged: "size-changed"
A dashboard object's size changed
+Enumeration DashboardObjectType
What the object represents in a dashboard.
+Index
Enumeration Members
Blank
+Extension
+Image
+Legend
+Page
Enumeration Members
Blank
Blank: "blank"
Extension
Extension: "extension"
Image
Image: "image"
Legend
Legend: "legend"
Page
PageFilter: "page-filter"
Parameter
ParameterControl: "parameter-control"
Quick
QuickFilter: "quick-filter"
Text
Text: "text"
Title
Title: "title"
Web
WebPage: "web-page"
Worksheet
Worksheet: "worksheet"
Enumeration DashboardObjectVisibilityType
Enum that represents the visibility state of a dashboard object.
+Enumeration DataFormatType
Index
Enumeration Members
Enumeration Members
Auto
AutoFormat: "auto-format"
Custom
Custom: "custom"
Custom
CustomCurrency: "custom-currency"
Custom
CustomNumber: "custom-number"
Custom
CustomPercentage: "custom-percentage"
Custom
CustomScientific: "custom-scientific"
System
SystemCurrency: "system-currency"
System
SystemLongDate: "system-long-date"
System
SystemNumber: "system-number"
System
SystemShortDate: "system-short-date"
System
SystemTime: "system-time"
Enumeration DataType
The different types of data a value can have
+
diff --git a/website/static/api/enums/DialogStyle.html b/website/static/api/enums/DialogStyle.html
new file mode 100644
index 00000000..16785dc2
--- /dev/null
+++ b/website/static/api/enums/DialogStyle.html
@@ -0,0 +1,29 @@
+
diff --git a/website/static/api/enums/EncodingType.html b/website/static/api/enums/EncodingType.html
new file mode 100644
index 00000000..88a5dd0e
--- /dev/null
+++ b/website/static/api/enums/EncodingType.html
@@ -0,0 +1,41 @@
+
Enumeration EncodingType
Enumeration Members
Angle
Angle: "angle"
Color
Color: "color"
Column
Column: "column"
Custom
Custom: "custom"
Detail
Detail: "detail"
Filter
Filter: "filter"
Geometry
Geometry: "geometry"
Label
Label: "label"
Marks
MarksType: "marks-type"
Measure
MeasureValues: "measure-values"
Page
Page: "page"
Path
Path: "path"
Row
Row: "row"
Shape
Shape: "shape"
Size
Size: "size"
Tooltip
Tooltip: "tooltip"
Enumeration ErrorCodes
All error codes used by the Extensions API.
+Enumeration Members
API
APINotInitialized: "api-not-initialized"
Thrown when caller attempts to execute command before initialization has completed.
+Dialog
DialogAlreadyOpen: "dialog-already-open"
Only one dialog can be opened at time with the UI namespace functionality.
+Dialog
DialogClosedByUser: "dialog-closed-by-user"
The open dialog was closed by the user.
+Internal
InternalError: "internal-error"
An error occurred within the Tableau Extensions API. Contact Tableau Support.
+Invalid
InvalidDomainDialog: "invalid-dialog-domain"
A dialog must start on the same domain as the parent extension.
+Invalid
InvalidParameter: "invalid-parameter"
A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.
+Missing
MissingFilter: "missing-filter"
Can occur if the extension interacts with a filter that has been removed from the worksheet.
+Missing
MissingParameter: "missing-parameter"
Can occur if the extension interacts with a parameter that has been removed from the worksheet.
+Server
ServerError: "server-error"
Internal Server Error
+Setting
SettingSaveInProgress: "setting-save-in-progress"
Developer cannot save settings while another save is still in progress.
+Unsupported
UnsupportedEventName: "unsupported-event-name"
An unknown event name was specified in the call to addEventListener or removeEventListener.
Unsupported
UnsupportedMethodForDataSourceType: "unsupported-method-for-data-source-type"
A method was used for a type of data source that doesn't support that method (see getActiveTablesAsync for an example)
+Visibility
VisibilityError: "visibility-error"
Thrown when caller attempts to execute command while extension is not visible.
+Enumeration ExtensionContext
The context in which the Extensions is currently running.
+Index
Enumeration Members
diff --git a/website/static/api/enums/FieldAggregationType.html b/website/static/api/enums/FieldAggregationType.html
new file mode 100644
index 00000000..99ee5159
--- /dev/null
+++ b/website/static/api/enums/FieldAggregationType.html
@@ -0,0 +1,66 @@
+
Enumeration FieldAggregationType
Type of aggregation on a field.
+Index
Enumeration Members
Attr
+Avg
+Collect
+Count
+Countd
+Day
+End
+Hour
+In
Enumeration Members
Attr
Attr: "attr"
Avg
Avg: "avg"
Collect
Collect: "collect"
Count
Count: "count"
Countd
Countd: "countd"
Day
Day: "day"
End
End: "end"
Hour
Hour: "hour"
In
InOut: "in-out"
Kurtosis
Kurtosis: "kurtosis"
Max
Max: "max"
Mdy
Mdy: "mdy"
Median
Median: "median"
Min
Min: "min"
Minute
Minute: "minute"
Month
Month: "month"
Month
MonthYear: "month-year"
None
None: "none"
Qtr
Qtr: "qtr"
Quart1
Quart1: "quart1"
Quart3
Quart3: "quart3"
Second
Second: "second"
Skewness
Skewness: "skewness"
Stdev
Stdev: "stdev"
Stdevp
Stdevp: "stdevp"
Sum
Sum: "sum"
Trunc
TruncDay: "trunc-day"
Trunc
TruncHour: "trunc-hour"
Trunc
TruncMinute: "trunc-minute"
Trunc
TruncMonth: "trunc-month"
Trunc
TruncQtr: "trunc-qtr"
Trunc
TruncSecond: "trunc-second"
Trunc
TruncWeek: "trunc-week"
Trunc
TruncYear: "trunc-year"
User
User: "user"
Var
Var: "var"
Varp
Varp: "varp"
Week
Week: "week"
Weekday
Weekday: "weekday"
Year
Year: "year"
diff --git a/website/static/api/enums/FilterDomainType.html b/website/static/api/enums/FilterDomainType.html
new file mode 100644
index 00000000..56aa885e
--- /dev/null
+++ b/website/static/api/enums/FilterDomainType.html
@@ -0,0 +1,31 @@
+
Enumeration FilterDomainType
The domain type for a filter
+Enumeration FilterNullOption
The option for specifying which values to include for filtering +Indicates what to do with null values for a given filter or mark selection call.
+Index
Enumeration Members
Enumeration FilterType
An enumeration of the valid types of filters that can be applied.
+Index
Enumeration Members
diff --git a/website/static/api/enums/HierarchicalLevelSelectionState.html b/website/static/api/enums/HierarchicalLevelSelectionState.html
new file mode 100644
index 00000000..adfbdd25
--- /dev/null
+++ b/website/static/api/enums/HierarchicalLevelSelectionState.html
@@ -0,0 +1,31 @@
+
Enumeration HierarchicalLevelSelectionState
Enum that represents the selection state of a level in a hierarchical filter
+Index
Enumeration Members
Enumeration IncludeDataValuesOption
Enum that serves as a filter on the DataValues returned from getSummaryDataReaderAsync,
+getUnderlyingTableDataReaderAsync and getLogicalTableDataReaderAsync.
+This is an optimization of returned data values only. Tableau versions prior to 2021.2
+will pass the data across and populate the DataValue properties.
+Please note that all properties not requested will be undefined in the DataValue results.
Index
Enumeration Members
Enumeration Members
All
AllValues: "all-values"
DataValues will include all properties.
+Only
OnlyFormattedValues: "only-formatted-values"
DataValues will only include formattedValue properties.
+Only
OnlyNativeValues: "only-native-values"
DataValues will only include value and nativeValue properties.
+Enumeration MarkType
Type of mark for a given marks card in a viz.
+Enumeration NegativeNumberFormat
Index
Enumeration Members
Enumeration NumberFormatUnits
Index
Enumeration Members
diff --git a/website/static/api/enums/PeriodType.html b/website/static/api/enums/PeriodType.html
new file mode 100644
index 00000000..9412c1d8
--- /dev/null
+++ b/website/static/api/enums/PeriodType.html
@@ -0,0 +1,37 @@
+
Enumeration PeriodType
Date period used in filters and in parameters.
+Enumeration QuickTableCalcType
Index
Enumeration Members
Enumeration Members
Compound
CompoundGrowthRate: "compound-growth-rate"
Difference
Difference: "difference"
Moving
MovingAverage: "moving-average"
Percent
PercentDifference: "percent-difference"
Percentile
Percentile: "percentile"
Percent
PercentOfTotal: "percent-of-total"
Rank
Rank: "rank"
Running
RunningTotal: "running-total"
Undefined
Undefined: "undefined"
Year
YearOverYearGrowth: "year-over-year-growth"
YTD
YTDGrowth: "ytd-growth"
YTD
YTDTotal: "ytd-total"
Enumeration ReplaySpeedType
Enum that represents the replay speed of an animation.
+Enumeration SelectOptions
Enum for specifying the select option for the extensions.Worksheet.selectTuplesAsync method.
diff --git a/website/static/api/enums/SharedErrorCodes.html b/website/static/api/enums/SharedErrorCodes.html
new file mode 100644
index 00000000..a632b7e8
--- /dev/null
+++ b/website/static/api/enums/SharedErrorCodes.html
@@ -0,0 +1,62 @@
+
Enumeration SharedErrorCodes
Index
Enumeration Members
Api
Enumeration Members
Api
ApiExecutionError: "api-execution-error"
Can occur when two incompatible calls are triggered together.
+Crosstab
CrosstabCreationError: "crosstab-creation-error"
A CSV or Excel file failed to be created in Viz.exportCrosstabAsync().
+Data
DataCreationError: "data-creation-error"
A CSV file failed to be created in Viz.exportDataAsync().
+Implementation
ImplementationError: "wrong-implementation"
Property or Function is not supported within the Tableau API.
+Internal
InternalError: "internal-error"
An error occurred within the Tableau API. Contact Tableau Support.
+Invalid
InvalidAggregationFieldName: "invalid-aggregation-field-name"
An invalid aggregation was specified for the filter, such as setting a range filter to "SUM(Sales)" instead of +"Sales".
+Invalid
InvalidFilterFieldName: "invalid-filter-name"
A filter operation was attempted on a field that does not exist in the data source.
+Invalid
InvalidFilterFieldValue: "invalid-filter-fieldValue"
A filter operation was attempted using a value that is the wrong data type or format.
+Invalid
InvalidParameter: "invalid-parameter"
A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.
+Invalid
InvalidSelectionDate: "invalid-selection-date"
An invalid date value was specified in a Sheet.selectMarksAsync() call for a date field.
+Invalid
InvalidSelectionFieldName: "invalid-selection-fieldName"
A field was specified in a Sheet.selectMarksAsync() call that does not exist in the data source.
+Invalid
InvalidSelectionSheet: "invalid-selection-sheet"
A parameter did not include a valid sheet selection for exporting.
+Invalid
InvalidSelectionValue: "invalid-selection-value"
An invalid value was specified in a Sheet.selectMarksAsync() call.
+Not
NotActiveSheet: "not-active-sheet"
An operation was attempted on a sheet that is not active or embedded within the active dashboard.
+PDF
PDFCreationError: "pdf-creation-error"
A PDF file failed to be created in Viz.exportPDFAsync().
+Power
PowerPointCreationError: "powerpoint-creation-error"
A PowerPoint file failed to be created in Viz.exportPowerPointAsync().
+Server
ServerError: "server-error"
A general-purpose server error occurred. Details are contained in the Error object.
+Timeout
Timeout: "timeout"
Can occur when an api call times out.
+
diff --git a/website/static/api/enums/SortDirection.html b/website/static/api/enums/SortDirection.html
new file mode 100644
index 00000000..7dae2bd7
--- /dev/null
+++ b/website/static/api/enums/SortDirection.html
@@ -0,0 +1,27 @@
+
Enumeration SortDirection
Index
Enumeration Members
Enumeration TableauEventType
Represents the type of event that can be listened for.
+Index
Enumeration Members - All Extensions
Enumeration Members - Dashboard Extensions
Enumeration Members - Viz Extensions
Enumeration Members - All Extensions
ExperimentalDialog
DialogMessageReceived: "dialog-message-received"
Raised when a message is received that was sent by a dialog or extension via sendDialogMessageAsync.
Filter
FilterChanged: "filter-changed"
Raised when any filter has changed state. You can use this event type with Worksheet objects.
+Mark
MarkSelectionChanged: "mark-selection-changed"
The selected marks on a visualization has changed. +You can use this event type with Worksheet objects.
+Parameter
ParameterChanged: "parameter-changed"
A parameter has had its value modified. You can use this event type with Parameter objects.
+Settings
SettingsChanged: "settings-changed"
Settings have been changed for this extension. You can use this event type with Settings objects.
+Summary
SummaryDataChanged: "summary-data-changed"
The summary data backing a worksheet has changed +You can use this event type with Worksheet objects.
+Enumeration TrendLineModelType
Index
Enumeration Members
Enumeration VizImageEncodingType
Enum that represents the data type of encodings for createVizImageAsync.
+Index
Enumeration Members
Enumeration VizImagePaletteType
Enum that represents the palette type for createVizImageAsync.
+Index
Enumeration Members
diff --git a/website/static/api/enums/VizImageSizeSettingType.html b/website/static/api/enums/VizImageSizeSettingType.html
new file mode 100644
index 00000000..93abc66a
--- /dev/null
+++ b/website/static/api/enums/VizImageSizeSettingType.html
@@ -0,0 +1,29 @@
+
diff --git a/website/static/api/enums/VizImageSortDirectionType.html b/website/static/api/enums/VizImageSortDirectionType.html
new file mode 100644
index 00000000..c0f37fac
--- /dev/null
+++ b/website/static/api/enums/VizImageSortDirectionType.html
@@ -0,0 +1,29 @@
+
Enumeration VizImageSortDirectionType
Enum that represents the sort direction for createVizImageAsync.
+Index
Enumeration Members
-
-
-
-
- Enumeration SharedErrorCodes
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.analyticsobjecttype.html b/website/static/api/enums/tableau.analyticsobjecttype.html
deleted file mode 100644
index c1c2f78b..00000000
--- a/website/static/api/enums/tableau.analyticsobjecttype.html
+++ /dev/null
@@ -1,228 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Api
-
-
-
-
-
- Crosstab
-
-
-
-
-
- Data
-
-
-
-
-
- Implementation
-
-
-
-
-
- Internal
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Not
-
-
-
-
-
- PDFCreation
-
-
-
-
-
- Power
-
-
-
-
-
- Server
-
-
-
-
-
-
-
-
-
- Index
-
-
-
-
- Enumeration members
--
-
- Api
Execution Error
- - Crosstab
Creation Error
- - Data
Creation Error
- - Implementation
Error
- - Internal
Error
- - Invalid
Aggregation Field Name
- - Invalid
Filter Field Name
- - Invalid
Filter Field Value
- - Invalid
Parameter
- - Invalid
Selection Date
- - Invalid
Selection Field Name
- - Invalid
Selection Sheet
- - Invalid
Selection Value
- - Not
Active Sheet
- - PDFCreation
Error
- - Power
Point Creation Error
- - Server
Error
- - Timeout -
Enumeration members
-ApiExecutionError
-
-
-
-
-
-
- Can occur when two incompatible calls are triggered together.
-CrosstabCreationError
-
-
-
-
-
-
- A CSV or Excel file failed to be created in Viz.exportCrosstabAsync().
-DataCreationError
-
-
-
-
-
-
- A CSV file failed to be created in Viz.exportDataAsync().
-ImplementationError
-
-
-
-
-
-
- Property or Function is not supported within the Tableau API.
-InternalError
-
-
-
-
-
-
- An error occurred within the Tableau API. Contact Tableau Support.
-InvalidAggregationFieldName
-
-
-
-
-
-
- An invalid aggregation was specified for the filter, such as setting a range filter to "SUM(Sales)" instead of - "Sales".
-InvalidFilterFieldName
-
-
-
-
-
-
- A filter operation was attempted on a field that does not exist in the data source.
-InvalidFilterFieldValue
-
-
-
-
-
-
- A filter operation was attempted using a value that is the wrong data type or format.
-InvalidParameter
-
-
-
-
-
-
- A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.
-InvalidSelectionDate
-
-
-
-
-
-
- An invalid date value was specified in a Sheet.selectMarksAsync() call for a date field.
-InvalidSelectionFieldName
-
-
-
-
-
-
- A field was specified in a Sheet.selectMarksAsync() call that does not exist in the data source.
-InvalidSelectionSheet
-
-
-
-
-
-
- A parameter did not include a valid sheet selection for exporting.
-InvalidSelectionValue
-
-
-
-
-
-
- An invalid value was specified in a Sheet.selectMarksAsync() call.
-NotActiveSheet
-
-
-
-
-
-
- An operation was attempted on a sheet that is not active or embedded within the active dashboard.
-PDFCreationError
-
-
-
-
-
-
- A PDF file failed to be created in Viz.exportPDFAsync().
-PowerPointCreationError
-
-
-
-
-
-
- A PowerPoint file failed to be created in Viz.exportPowerPointAsync().
-ServerError
-
-
-
-
-
-
- A general-purpose server error occurred. Details are contained in the Error object.
-Timeout
- - -
-
-
-
- Can occur when an api call times out.
-
-
-
-
-
- Enumeration AnalyticsObjectType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.annotationtype.html b/website/static/api/enums/tableau.annotationtype.html
deleted file mode 100644
index 92f78b15..00000000
--- a/website/static/api/enums/tableau.annotationtype.html
+++ /dev/null
@@ -1,228 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration AnnotationType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.classnamekey.html b/website/static/api/enums/tableau.classnamekey.html
deleted file mode 100644
index 74d45799..00000000
--- a/website/static/api/enums/tableau.classnamekey.html
+++ /dev/null
@@ -1,298 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration ClassNameKey
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.columntype.html b/website/static/api/enums/tableau.columntype.html
deleted file mode 100644
index ca6fc98a..00000000
--- a/website/static/api/enums/tableau.columntype.html
+++ /dev/null
@@ -1,228 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Column
-
-
-
-
-
- Dashboard
-
-
-
-
-
-
-
-
- Row
-
-
-
-
-
- Story
-
-
-
-
-
-
-
-
-
-
-
- Worksheet
-
-
-
-
-
-
- Index
-
-
-
-
- Enumeration members
--
-
- Column
Dividers
- - Dashboard
Title
- - Pane -
- Row
Dividers
- - Story
Title
- - Tooltip -
- Worksheet -
- Worksheet
Title
-
Enumeration members
-ColumnDividers
-
-
- DashboardTitle
-
-
- Pane
- - -RowDividers
-
-
- StoryTitle
-
-
- Tooltip
- - -Worksheet
- - -WorksheetTitle
-
-
-
-
-
-
-
- Enumeration ColumnType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.dashboardlayoutchange.html b/website/static/api/enums/tableau.dashboardlayoutchange.html
deleted file mode 100644
index 23564e65..00000000
--- a/website/static/api/enums/tableau.dashboardlayoutchange.html
+++ /dev/null
@@ -1,383 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Index
-
-
-
-
- Enumeration members
--
-
- Continuous -
- Discrete -
- Unknown -
Enumeration members
-Continuous
- - -Discrete
- - -Unknown
- - -
-
-
-
-
- Enumeration DashboardLayoutChange
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.dashboardobjecttype.html b/website/static/api/enums/tableau.dashboardobjecttype.html
deleted file mode 100644
index 3cec4131..00000000
--- a/website/static/api/enums/tableau.dashboardobjecttype.html
+++ /dev/null
@@ -1,347 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Dashboard
-
-
-
-
-
-
-
-
- Is
-
-
-
-
-
- Is
-
-
-
-
-
- Name
-
-
-
-
-
- Position
-
-
-
-
-
-
-
-
-
-
-
- Size
-
-
-
-
-
-
-
-
-
-
- Enum that represents the changes that occur to a dashboard object.
-Index
-
-
-
-
- Enumeration members
--
-
- Added -
- Dashboard
Changed
- - Deselected -
- Is
Floating Changed
- - Is
Visible Changed
- - Name
Changed
- - Position
Changed
- - Removed -
- Selected -
- Size
Changed
-
Enumeration members
-Added
- - -
-
-
-
- A dashboard object was added
-DashboardChanged
-
-
-
-
-
-
- Navigate to another dashboard
-Deselected
- - -
-
-
-
- A dashboard object is deselected
-IsFloatingChanged
-
-
-
-
-
-
- A dashboard object's floating state changed
-IsVisibleChanged
-
-
-
-
-
-
- A dashboard object's visibility changed
-NameChanged
-
-
-
-
-
-
- A dashboard object was renamed
-PositionChanged
-
-
-
-
-
-
- A dashboard object's position changed
-Removed
- - -
-
-
-
- A dashboard object was removed
-Selected
- - -
-
-
-
- A dashboard object is selected
-SizeChanged
-
-
-
-
-
-
- A dashboard object's size changed
-
-
-
-
-
- Enumeration DashboardObjectType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.dashboardobjectvisibilitytype.html b/website/static/api/enums/tableau.dashboardobjectvisibilitytype.html
deleted file mode 100644
index 88a24760..00000000
--- a/website/static/api/enums/tableau.dashboardobjectvisibilitytype.html
+++ /dev/null
@@ -1,236 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Page
-
-
-
-
-
- Parameter
-
-
-
-
-
- Quick
-
-
-
-
-
-
-
-
-
-
-
- Web
-
-
-
-
-
-
-
-
-
-
-
-
-
- What the object represents in a dashboard.
-Index
-
-
-
-
- Enumeration members
--
-
- Blank -
- Extension -
- Image -
- Legend -
- Page
Filter
- - Parameter
Control
- - Quick
Filter
- - Text -
- Title -
- Web
Page
- - Worksheet -
Enumeration members
-Blank
- - -Extension
- - -Image
- - -Legend
- - -PageFilter
-
-
- ParameterControl
-
-
- QuickFilter
-
-
- Text
- - -Title
- - -WebPage
-
-
- Worksheet
- - -
-
-
-
-
- Enumeration DashboardObjectVisibilityType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.datatype.html b/website/static/api/enums/tableau.datatype.html
deleted file mode 100644
index 2357c756..00000000
--- a/website/static/api/enums/tableau.datatype.html
+++ /dev/null
@@ -1,305 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enumeration DataType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.daterangetype.html b/website/static/api/enums/tableau.daterangetype.html
deleted file mode 100644
index f791bb11..00000000
--- a/website/static/api/enums/tableau.daterangetype.html
+++ /dev/null
@@ -1,277 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration DateRangeType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.dialogstyle.html b/website/static/api/enums/tableau.dialogstyle.html
deleted file mode 100644
index e4d55c61..00000000
--- a/website/static/api/enums/tableau.dialogstyle.html
+++ /dev/null
@@ -1,235 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enumeration DialogStyle
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.encodingtype.html b/website/static/api/enums/tableau.encodingtype.html
deleted file mode 100644
index 93ba3dbf..00000000
--- a/website/static/api/enums/tableau.encodingtype.html
+++ /dev/null
@@ -1,410 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration EncodingType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.errorcodes.html b/website/static/api/enums/tableau.errorcodes.html
deleted file mode 100644
index 163ccc79..00000000
--- a/website/static/api/enums/tableau.errorcodes.html
+++ /dev/null
@@ -1,440 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Marks
-
-
-
-
-
- Measure
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Index
-Enumeration members
-Angle
- - -Color
- - -Column
- - -Custom
- - -Detail
- - -Filter
- - -Geometry
- - -Label
- - -MarksType
-
-
- MeasureValues
-
-
- Page
- - -Path
- - -Row
- - -Shape
- - -Size
- - -Tooltip
- - -
-
-
-
-
- Enumeration ErrorCodes
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.extensioncontext.html b/website/static/api/enums/tableau.extensioncontext.html
deleted file mode 100644
index c7549640..00000000
--- a/website/static/api/enums/tableau.extensioncontext.html
+++ /dev/null
@@ -1,263 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- APINot
-
-
-
-
-
- Dialog
-
-
-
-
-
- Dialog
-
-
-
-
-
- Internal
-
-
-
-
-
- Invalid
-
-
-
-
-
- Invalid
-
-
-
-
-
- Missing
-
-
-
-
-
- Missing
-
-
-
-
-
- Server
-
-
-
-
-
- Setting
-
-
-
-
-
- Unsupported
-
-
-
-
-
- Unsupported
-
-
-
-
-
- Visibility
-
-
-
-
-
-
-
-
-
-
- All error codes used by the Extensions API.
-Index
-
-
-
-
- Enumeration members
- -Enumeration members
-APINotInitialized
-
-
-
-
-
-
- Thrown when caller attempts to execute command before initialization has completed.
-DialogAlreadyOpen
-
-
-
-
-
-
- Only one dialog can be opened at time with the UI namespace functionality.
-DialogClosedByUser
-
-
-
-
-
-
- The open dialog was closed by the user.
-InternalError
-
-
-
-
-
-
- An error occurred within the Tableau Extensions API. Contact Tableau Support.
-InvalidDomainDialog
-
-
-
-
-
-
- A dialog must start on the same domain as the parent extenion.
-InvalidParameter
-
-
-
-
-
-
- A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.
-MissingFilter
-
-
-
-
-
-
- Can occur if the extension interacts with a filter that has been removed from the worksheet.
-MissingParameter
-
-
-
-
-
-
- Can occur if the extension interacts with a parameter that has been removed from the worksheet.
-ServerError
-
-
-
-
-
-
- Internal Server Error
-SettingSaveInProgress
-
-
-
-
-
-
- Developer cannot save settings while another save is still in progress.
-UnsupportedEventName
-
-
-
-
-
-
- An unknown event name was specified in the call to addEventListener or removeEventListener.
UnsupportedMethodForDataSourceType
-
-
-
-
-
-
- A method was used for a type of data source that doesn't support that method (see getActiveTablesAsync for an example)
-VisibilityError
-
-
-
-
-
-
- Thrown when caller attempts to execute command while extension is not visible.
-
-
-
-
-
- Enumeration ExtensionContext
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.extensionmode.html b/website/static/api/enums/tableau.extensionmode.html
deleted file mode 100644
index abecee26..00000000
--- a/website/static/api/enums/tableau.extensionmode.html
+++ /dev/null
@@ -1,221 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Public
-
-
-
-
-
- Public
-
-
-
-
-
-
-
-
-
-
-
-
-
- The context in which the Extensions is currently running.
-Index
-
-
-
-
- Enumeration members
--
-
- Cloud -
- Desktop -
- Public
Desktop
- - Public
Web
- - Server -
Enumeration members
-Cloud
- - -Desktop
- - -PublicDesktop
-
-
- PublicWeb
-
-
- Server
- - -
-
-
-
-
- Enumeration ExtensionMode
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.fieldaggregationtype.html b/website/static/api/enums/tableau.fieldaggregationtype.html
deleted file mode 100644
index 0fcf19ea..00000000
--- a/website/static/api/enums/tableau.fieldaggregationtype.html
+++ /dev/null
@@ -1,753 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration FieldAggregationType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.fieldroletype.html b/website/static/api/enums/tableau.fieldroletype.html
deleted file mode 100644
index 0d8bfa04..00000000
--- a/website/static/api/enums/tableau.fieldroletype.html
+++ /dev/null
@@ -1,235 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- In
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Month
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
- Trunc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Type of aggregation on a field.
-Index
-
-
-
-
- Enumeration members
--
-
- Attr -
- Avg -
- Collect -
- Count -
- Countd -
- Day -
- End -
- Hour -
- In
Out
- - Kurtosis -
- Max -
- Mdy -
- Median -
- Min -
- Minute -
- Month -
- Month
Year
- - None -
- Qtr -
- Quart1 -
- Quart3 -
- Second -
- Skewness -
- Stdev -
- Stdevp -
- Sum -
- Trunc
Day
- - Trunc
Hour
- - Trunc
Minute
- - Trunc
Month
- - Trunc
Qtr
- - Trunc
Second
- - Trunc
Week
- - Trunc
Year
- - User -
- Var -
- Varp -
- Week -
- Weekday -
- Year -
Enumeration members
-Attr
- - -Avg
- - -Collect
- - -Count
- - -Countd
- - -Day
- - -End
- - -Hour
- - -InOut
-
-
- Kurtosis
- - -Max
- - -Mdy
- - -Median
- - -Min
- - -Minute
- - -Month
- - -MonthYear
-
-
- None
- - -Qtr
- - -Quart1
- - -Quart3
- - -Second
- - -Skewness
- - -Stdev
- - -Stdevp
- - -Sum
- - -TruncDay
-
-
- TruncHour
-
-
- TruncMinute
-
-
- TruncMonth
-
-
- TruncQtr
-
-
- TruncSecond
-
-
- TruncWeek
-
-
- TruncYear
-
-
- User
- - -Var
- - -Varp
- - -Week
- - -Weekday
- - -Year
- - -
-
-
-
-
- Enumeration FieldRoleType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.filterdomaintype.html b/website/static/api/enums/tableau.filterdomaintype.html
deleted file mode 100644
index ce6fba61..00000000
--- a/website/static/api/enums/tableau.filterdomaintype.html
+++ /dev/null
@@ -1,232 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration FilterDomainType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.filternulloption.html b/website/static/api/enums/tableau.filternulloption.html
deleted file mode 100644
index 45cf332c..00000000
--- a/website/static/api/enums/tableau.filternulloption.html
+++ /dev/null
@@ -1,236 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The domain type for a filter
-Index
-Enumeration members
-Database
- - -
-
-
-
- list of all possible domain values from database
-Relevant
- - -
-
-
-
- The domain values that are relevant to the specified filter - i.e. the domain is restricted by a previous filter
-
-
-
-
-
- Enumeration FilterNullOption
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.filtertype.html b/website/static/api/enums/tableau.filtertype.html
deleted file mode 100644
index ddc95ab9..00000000
--- a/website/static/api/enums/tableau.filtertype.html
+++ /dev/null
@@ -1,249 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- All
-
-
-
-
-
- Non
-
-
-
-
-
- Null
-
-
-
-
-
-
-
-
-
-
- The option for specifying which values to include for filtering - Indicates what to do with null values for a given filter or mark selection call.
-Index
-
-
-
-
- Enumeration members
--
-
- All
Values
- - Non
Null Values
- - Null
Values
-
Enumeration members
-AllValues
-
-
- NonNullValues
-
-
- NullValues
-
-
-
-
-
-
-
- Enumeration FilterType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.filterupdatetype.html b/website/static/api/enums/tableau.filterupdatetype.html
deleted file mode 100644
index ec5d612a..00000000
--- a/website/static/api/enums/tableau.filterupdatetype.html
+++ /dev/null
@@ -1,249 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Relative
-
-
-
-
-
-
-
-
-
-
- An enumeration of the valid types of filters that can be applied.
-Index
-
-
-
-
- Enumeration members
--
-
- Categorical -
- Hierarchical -
- Range -
- Relative
Date
-
Enumeration members
-Categorical
- - -Hierarchical
- - -Range
- - -RelativeDate
-
-
-
-
-
-
-
- Enumeration FilterUpdateType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.hierarchicallevelselectionstate.html b/website/static/api/enums/tableau.hierarchicallevelselectionstate.html
deleted file mode 100644
index 9d9b0468..00000000
--- a/website/static/api/enums/tableau.hierarchicallevelselectionstate.html
+++ /dev/null
@@ -1,254 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration HierarchicalLevelSelectionState
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.includedatavaluesoption.html b/website/static/api/enums/tableau.includedatavaluesoption.html
deleted file mode 100644
index fce45569..00000000
--- a/website/static/api/enums/tableau.includedatavaluesoption.html
+++ /dev/null
@@ -1,259 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- All
-
-
-
-
-
- None
-
-
-
-
-
- Some
-
-
-
-
-
- Unknown
-
-
-
-
-
-
-
-
-
-
-
- Enum that represents the selection state of a level in a hierarchical filter
-Index
-
-
-
-
- Enumeration members
--
-
- All
Selected
- - None
Selected
- - Some
Selected
- - Unknown
Selected
-
Enumeration members
-AllSelected
-
-
- NoneSelected
-
-
- SomeSelected
-
-
- UnknownSelected
-
-
-
-
-
-
-
- Enumeration IncludeDataValuesOption
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.marktype.html b/website/static/api/enums/tableau.marktype.html
deleted file mode 100644
index e316ff2f..00000000
--- a/website/static/api/enums/tableau.marktype.html
+++ /dev/null
@@ -1,375 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- All
-
-
-
-
-
- Only
-
-
-
-
-
- Only
-
-
-
-
-
-
-
-
-
-
-
- Enum that serves as a filter on the DataValues returned from getSummaryDataReaderAsync,
- getUnderlyingTableDataReaderAsync and getLogicalTableDataReaderAsync.
- This is an optimization of returned data values only. Tableau versions prior to 2021.2
- will pass the data across and populate the DataValue properties.
- Please note that all properties not requested will be undefined in the DataValue results.
Index
-
-
-
-
- Enumeration members
- -Enumeration members
-AllValues
-
-
-
-
-
-
- DataValues will include all properties.
-OnlyFormattedValues
-
-
-
-
-
-
- DataValues will only include formattedValue properties.
-OnlyNativeValues
-
-
-
-
-
-
- DataValues will only include value and nativeValue properties.
-
-
-
-
-
- Enumeration MarkType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.parametervaluetype.html b/website/static/api/enums/tableau.parametervaluetype.html
deleted file mode 100644
index d7cc92fa..00000000
--- a/website/static/api/enums/tableau.parametervaluetype.html
+++ /dev/null
@@ -1,236 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gantt
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Viz
-
-
-
-
-
-
-
-
-
-
- Type of mark for a given marks card in a viz.
-Index
-Enumeration members
-Area
- - -Bar
- - -Circle
- - -GanttBar
-
-
- Heatmap
- - -Line
- - -Map
- - -Pie
- - -Polygon
- - -Shape
- - -Square
- - -Text
- - -VizExtension
-
-
-
-
-
-
-
- Enumeration ParameterValueType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.periodtype.html b/website/static/api/enums/tableau.periodtype.html
deleted file mode 100644
index 0c327836..00000000
--- a/website/static/api/enums/tableau.periodtype.html
+++ /dev/null
@@ -1,347 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration PeriodType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.quicktablecalctype.html b/website/static/api/enums/tableau.quicktablecalctype.html
deleted file mode 100644
index 15de213b..00000000
--- a/website/static/api/enums/tableau.quicktablecalctype.html
+++ /dev/null
@@ -1,354 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Iso
-
-
-
-
-
- Iso
-
-
-
-
-
- Iso
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Date period used in filters and in parameters.
-Index
-Enumeration members
-Days
- - -Hours
- - -IsoQuarters
-
-
- IsoWeeks
-
-
- IsoYears
-
-
- Minutes
- - -Months
- - -Quarters
- - -Seconds
- - -Weeks
- - -Years
- - -
-
-
-
-
- Enumeration QuickTableCalcType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.replayspeedtype.html b/website/static/api/enums/tableau.replayspeedtype.html
deleted file mode 100644
index e8520c7d..00000000
--- a/website/static/api/enums/tableau.replayspeedtype.html
+++ /dev/null
@@ -1,255 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Compound
-
-
-
-
-
-
-
-
- Moving
-
-
-
-
-
- Percent
-
-
-
-
-
- Percent
-
-
-
-
-
-
-
-
-
-
-
- Running
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Year
-
-
-
-
-
-
- Index
-
-
-
-
- Enumeration members
--
-
- Compound
Growth Rate
- - Difference -
- Moving
Average
- - Percent
Difference
- - Percent
OfTotal
- - Percentile -
- Rank -
- Running
Total
- - Undefined -
- YTDGrowth -
- YTDTotal -
- Year
Over Year Growth
-
Enumeration members
-CompoundGrowthRate
-
-
- Difference
- - -MovingAverage
-
-
- PercentDifference
-
-
- PercentOfTotal
-
-
- Percentile
- - -Rank
- - -RunningTotal
-
-
- Undefined
- - -YTDGrowth
- - -YTDTotal
- - -YearOverYearGrowth
-
-
-
-
-
-
-
- Enumeration ReplaySpeedType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.selectionupdatetype.html b/website/static/api/enums/tableau.selectionupdatetype.html
deleted file mode 100644
index 006866cc..00000000
--- a/website/static/api/enums/tableau.selectionupdatetype.html
+++ /dev/null
@@ -1,235 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enum that represents the replay speed of an animation.
-Index
-Enumeration members
-Fast
- - -
-
-
-
- Used for setting the replay speed of an animation to 2.0x.
-Normal
- - -
-
-
-
- Used for setting the replay speed of an animation to 1.0x.
-Slow
- - -
-
-
-
- Used for setting the replay speed of an animation to 0.5x.
-
-
-
-
-
- Enumeration SelectionUpdateType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.selectoptions.html b/website/static/api/enums/tableau.selectoptions.html
deleted file mode 100644
index 4745fa0b..00000000
--- a/website/static/api/enums/tableau.selectoptions.html
+++ /dev/null
@@ -1,231 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration SelectOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.sheettype.html b/website/static/api/enums/tableau.sheettype.html
deleted file mode 100644
index a87088b7..00000000
--- a/website/static/api/enums/tableau.sheettype.html
+++ /dev/null
@@ -1,235 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enum for specifying the select option for the extensions.Worksheet.selectTuplesAsync method.
Index
-Enumeration members
-Simple
- - -
-
-
-
- Clears existing selection before selecting the tuples specified
-Toggle
- - -
-
-
-
- Adds specified tuples to the existing selection
-
-
-
-
-
- Enumeration SheetType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.sortdirection.html b/website/static/api/enums/tableau.sortdirection.html
deleted file mode 100644
index 166d5713..00000000
--- a/website/static/api/enums/tableau.sortdirection.html
+++ /dev/null
@@ -1,214 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration SortDirection
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.tableaueventtype.html b/website/static/api/enums/tableau.tableaueventtype.html
deleted file mode 100644
index 131b8cff..00000000
--- a/website/static/api/enums/tableau.tableaueventtype.html
+++ /dev/null
@@ -1,380 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Index
-
-
-
-
- Enumeration members
--
-
- Decreasing -
- Increasing -
Enumeration members
-Decreasing
- - -Increasing
- - -
-
-
-
-
- Enumeration TableauEventType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.trendlinemodeltype.html b/website/static/api/enums/tableau.trendlinemodeltype.html
deleted file mode 100644
index 677d5209..00000000
--- a/website/static/api/enums/tableau.trendlinemodeltype.html
+++ /dev/null
@@ -1,242 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Dialog
-
-
-
-
-
- Filter
-
-
-
-
-
- Mark
-
-
-
-
-
- Parameter
-
-
-
-
-
- Settings
-
-
-
-
-
- Summary
-
-
-
-
-
-
-
- Dashboard
-
-
-
-
-
- Workbook
-
-
-
-
-
-
-
- Worksheet
-
-
-
-
-
-
-
-
-
-
- Represents the type of event that can be listened for.
-Index
-
-
-
-
- All Extensions Enumeration members
--
-
- Dialog
Message Received
- - Filter
Changed
- - Mark
Selection Changed
- - Parameter
Changed
- - Settings
Changed
- - Summary
Data Changed
-
Dashboard Extensions Enumeration members
- -Viz Extensions Enumeration members
- -All Extensions Enumeration members
-DialogMessageReceived
-
-
-
-
-
- FilterChanged
-
-
-
-
-
-
- Raised when any filter has changed state. You can use this event type with Worksheet objects.
-MarkSelectionChanged
-
-
-
-
-
-
- The selected marks on a visualization has changed. - You can use this event type with Worksheet objects.
-ParameterChanged
-
-
-
-
-
-
- A parameter has had its value modified. You can use this event type with Parameter objects.
-SettingsChanged
-
-
-
-
-
-
- Settings have been changed for this extension. You can use this event type with Settings objects.
-SummaryDataChanged
-
-
-
-
-
-
- The summary data backing a worksheet has changed - You can use this event type with Worksheet objects.
-Dashboard Extensions Enumeration members
-DashboardLayoutChanged
-
-
-
-
-
-
- The dashboard layout has changed
-WorkbookFormattingChanged
-
-
-
-
-
-
- The workbook formatting has changed
-Viz Extensions Enumeration members
-WorksheetFormattingChanged
-
-
-
-
-
-
- The worksheet formatting has changed
-
-
-
-
-
- Enumeration TrendLineModelType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.vizimageencodingtype.html b/website/static/api/enums/tableau.vizimageencodingtype.html
deleted file mode 100644
index ed5bef27..00000000
--- a/website/static/api/enums/tableau.vizimageencodingtype.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Index
-
-
-
-
- Enumeration members
--
-
- Exponential -
- Linear -
- Logarithmic -
- Polynomial -
Enumeration members
-Exponential
- - -Linear
- - -Logarithmic
- - -Polynomial
- - -
-
-
-
-
- Enumeration VizImageEncodingType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.vizimagepalettetype.html b/website/static/api/enums/tableau.vizimagepalettetype.html
deleted file mode 100644
index 86c4d112..00000000
--- a/website/static/api/enums/tableau.vizimagepalettetype.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enum that represents the data type of encodings for createVizImageAsync.
-Index
-
-
-
-
- Enumeration members
--
-
- Continuous -
- Discrete -
Enumeration members
-Continuous
- - -Discrete
- - -
-
-
-
-
- Enumeration VizImagePaletteType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html b/website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html
deleted file mode 100644
index 4813be2b..00000000
--- a/website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html
+++ /dev/null
@@ -1,240 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration VizImageSizeSettingAlignmentType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.vizimagesizesettingtype.html b/website/static/api/enums/tableau.vizimagesizesettingtype.html
deleted file mode 100644
index 7480ef4a..00000000
--- a/website/static/api/enums/tableau.vizimagesizesettingtype.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration VizImageSizeSettingType
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/enums/tableau.vizimagesortdirectiontype.html b/website/static/api/enums/tableau.vizimagesortdirectiontype.html
deleted file mode 100644
index e2021537..00000000
--- a/website/static/api/enums/tableau.vizimagesortdirectiontype.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Enumeration VizImageSortDirectionType
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/globals.html b/website/static/api/globals.html
deleted file mode 100644
index d5fefec5..00000000
--- a/website/static/api/globals.html
+++ /dev/null
@@ -1,673 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enum that represents the sort direction for createVizImageAsync.
-Index
-
-
-
-
- Enumeration members
--
-
- Ascending -
- Descending -
Enumeration members
-Ascending
- - -Descending
- - -
-
-
-
-
- Tableau Extensions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/hierarchy.html b/website/static/api/hierarchy.html
new file mode 100644
index 00000000..34678c17
--- /dev/null
+++ b/website/static/api/hierarchy.html
@@ -0,0 +1,25 @@
+
-
-
-
-
-
-
-
-
-
- Categorical
-
-
-
-
-
- Tableau
-
-
-
-
-
- Tableau
-
-
-
-
-
- Worksheet
-
-
-
-
-
-
-
- Dashboard
-
-
-
-
-
- Dashboard
-
-
-
-
-
- Dashboard
-
-
-
-
-
- Zone
-
-
-
-
-
-
- Index
-
-
-
-
-
-
-
-
-
-
- Modules
--
-
- Tableau -
Enumerations
--
-
- Shared
Error Codes
-
All Extensions Interfaces
--
-
- Annotation -
- Categorical
Domain
- - Categorical
Filter
- - Column -
- Connection
Summary
- - Data
Source
- - Data
Source Underlying Data Options
- - Data
Table
- - Data
Table Reader
- - Data
Value
- - Dialog
Message Event
- - Dialog
Options
- - Encoding -
- Environment -
- Event
Listener Manager
- - Extensions -
- Field -
- Field
Instance
- - Filter -
- Filter
Changed Event
- - Filter
Options
- - Formatting
Sheet
- - Get
Summary Data Options
- - Get
Underlying Data Options
- - Hierarchical
Filter
- - Hierarchical
Filter Data Value
- - Hierarchical
Level Detail
- - Hierarchical
Levels
- - Logical
Table
- - Mark
Info
- - Marks
Collection
- - Marks
Selected Event
- - Marks
Specification
- - Parameter -
- Parameter
Changed Event
- - Parameter
Domain Restriction
- - Point -
- Range
Domain
- - Range
Filter
- - Range
Filter Options
- - Range
Value
- - Relative
Date Filter
- - Relative
Date Filter Options
- - Selection
Criteria
- - Settings -
- Settings
Changed Event
- - Sheet -
- Size -
- Summary
Data Changed Event
- - Table
Summary
- - Tableau
Error
- - Tableau
Event
- - Tableau
Sheet Event
- - Tableau
Worksheet Event
- - UI -
- Visual
Specification
- - Workbook -
- Workbook
Formatting
- - Workbook
Formatting Changed Event
- - Worksheet -
- Worksheet
Formatting Changed Event
-
Dashboard Extensions Interfaces
--
-
- Dashboard -
- Dashboard
Content
- - Dashboard
Layout Changed Event
- - Dashboard
Object
- - Dashboard
Object Position And Size Update
-
Viz Extensions Interfaces
- -All Extensions Type aliases
- -Dashboard Extensions Type aliases
- -All Extensions Type aliases
-CategoricalValue
-
-
-
-
-
-
- Categorical values for selection.
-TableauEventHandlerFn
-
-
-
-
-
-
-
- Callback function which will be invoked when an event notification is emitted.
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
event: TableauEvent
-
-
Returns void
-
- -
-
- -
-
TableauEventUnregisterFn
-
-
-
-
-
-
-
- Function which can be invoked to remove an event handler registration. This will be - returned when registering an event and makes unregistering simpler.
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Returns boolean
-
-
- -
-
WorksheetFormatting
-
-
- Dashboard Extensions Type aliases
-DashboardLayoutChangeDetails
-
-
-
-
-
-
- Map object that is used for the DashboardLayoutChangedEvent.
-DashboardObjectPositionAndSizeUpdateArray
-
-
-
-
-
-
- Array object that can be passed into moveAndResizeDashboardObjects.
-DashboardObjectVisibilityMap
-
-
-
-
-
-
- Map object that can be passed into setDashboardObjectVisibilityAsync.
-ZoneVisibilityMap
-
-
-
-
-
-
-
- Map object that can be passed into setZoneVisibilityAsync.
-Tableau Extensions API
Hierarchy Summary
-
-
-
-
- Tableau Extensions
-
- Tableau Extensions API
+
+
+
+
diff --git a/website/static/api/interfaces/Annotation.html b/website/static/api/interfaces/Annotation.html
new file mode 100644
index 00000000..b6e92528
--- /dev/null
+++ b/website/static/api/interfaces/Annotation.html
@@ -0,0 +1,36 @@
+Annotation | Tableau Extensions API
CategoricalDomain | Tableau Extensions API CategoricalFilter | Tableau Extensions API
get
get
get
set
Column | Tableau Extensions API
ConnectionSummary | Tableau Extensions API Dashboard | Tableau Extensions API
add
apply
find
get
get
get
move
remove
replay
set
set
DashboardContent | Tableau Extensions API
DashboardLayoutChangedEvent | Tableau Extensions API
DashboardObject | Tableau Extensions API DashboardObjectPositionAndSizeUpdate | Tableau Extensions API
DataFormattingOptions | Tableau Extensions API
custom
decimal
format
negative
separator
show
DataSource | Tableau Extensions API
get
get
get
get
get
refresh
DataSourceUnderlyingDataOptions | Tableau Extensions API
DataTable | Tableau Extensions API
DataTableReader | Tableau Extensions API
get
get
release
DataValue | Tableau Extensions API
DialogMessageEvent | Tableau Extensions API
DialogOptions | Tableau Extensions API
Encoding | Tableau Extensions API
Environment | Tableau Extensions API
EventListenerManager | Tableau Extensions API
add
remove
Extensions | Tableau Extensions API
dashboard
create
initialize
initialize
report
set
Field | Tableau Extensions API
FieldInstance | Tableau Extensions API
Filter | Tableau Extensions API
get
get
set
FilterChangedEvent | Tableau Extensions API
FilterOptions | Tableau Extensions API
FormattingSheet | Tableau Extensions API GetSummaryDataOptions | Tableau Extensions API
GetUnderlyingDataOptions | Tableau Extensions API
HierarchicalFilter | Tableau Extensions API
get
get
set
HierarchicalFilterDataValue | Tableau Extensions API HierarchicalLevelDetail | Tableau Extensions API
HierarchicalLevels | Tableau Extensions API LogicalTable | Tableau Extensions API MarkInfo | Tableau Extensions API MarksCollection | Tableau Extensions API
MarksSelectedEvent | Tableau Extensions API
get
MarksSpecification | Tableau Extensions API
Parameter | Tableau Extensions API
add
change
remove
ParameterChangedEvent | Tableau Extensions API
ParameterDomainRestriction | Tableau Extensions API
Point | Tableau Extensions API RangeDomain | Tableau Extensions API RangeFilter | Tableau Extensions API
get
get
get
set
RangeFilterOptions | Tableau Extensions API
RangeValue | Tableau Extensions API
RelativeDateFilter | Tableau Extensions API
get
get
set
RelativeDateFilterOptions | Tableau Extensions API
SelectionCriteria | Tableau Extensions API
Settings | Tableau Extensions API
add
get
remove
save
SettingsChangedEvent | Tableau Extensions API
Sheet | Tableau Extensions API
add
find
get
remove
Size | Tableau Extensions API SummaryDataChangedEvent | Tableau Extensions API TableSummary | Tableau Extensions API
TableauError | Tableau Extensions API TableauEvent | Tableau Extensions API
TableauSheetEvent | Tableau Extensions API TableauWorksheetEvent | Tableau Extensions API TooltipContext | Tableau Extensions API UI | Tableau Extensions API
close
display
send
send
VisualSpecification | Tableau Extensions API
Workbook | Tableau Extensions API
get
WorkbookFormatting | Tableau Extensions API WorkbookFormattingChangedEvent | Tableau Extensions API
Worksheet | Tableau Extensions API
add
annotate
apply
apply
apply
apply
clear
clear
find
get
get
get
get
get
get
get
get
get
get
get
get
get
get
remove
remove
select
get
hover
leave
select
WorksheetContent | Tableau Extensions API
WorksheetFormatting | Tableau Extensions API WorksheetFormattingChangedEvent | Tableau Extensions API
Annotation | Tableau Extensions
-
-
-
-
-
-
-
-
-CategoricalDomain | Tableau Extensions
-
-
-
-
-
-
-
-
-CategoricalFilter | Tableau Extensions
-
-
-
-
-
-
-
-
-Column | Tableau Extensions
-
-
-
-
-
-
-
-
-ConnectionSummary | Tableau Extensions
-
-
-
-
-
-
-
-
-Dashboard | Tableau Extensions
-
-
-
-
-
-
-
-
-DashboardContent | Tableau Extensions
-
-
-
-
-
-
-
-
-DashboardLayoutChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-DashboardObject | Tableau Extensions
-
-
-
-
-
-
-
-
-DashboardObjectPositionAndSizeUpdate | Tableau Extensions
-
-
-
-
-
-
-
-
-DataSource | Tableau Extensions
-
-
-
-
-
-
-
-
-DataSourceUnderlyingDataOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-DataTable | Tableau Extensions
-
-
-
-
-
-
-
-
-DataTableReader | Tableau Extensions
-
-
-
-
-
-
-
-
-DataValue | Tableau Extensions
-
-
-
-
-
-
-
-
-DialogMessageEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-DialogOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-Encoding | Tableau Extensions
-
-
-
-
-
-
-
-
-Environment | Tableau Extensions
-
-
-
-
-
-
-
-
-EventListenerManager | Tableau Extensions
-
-
-
-
-
-
-
-
-Extensions | Tableau Extensions
-
-
-
-
-
-
-
-
-Field | Tableau Extensions
-
-
-
-
-
-
-
-
-FieldInstance | Tableau Extensions
-
-
-
-
-
-
-
-
-Filter | Tableau Extensions
-
-
-
-
-
-
-
-
-FilterChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-FilterOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-FormattingSheet | Tableau Extensions
-
-
-
-
-
-
-
-
-GetSummaryDataOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-GetUnderlyingDataOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-HierarchicalFilter | Tableau Extensions
-
-
-
-
-
-
-
-
-HierarchicalFilterDataValue | Tableau Extensions
-
-
-
-
-
-
-
-
-HierarchicalLevelDetail | Tableau Extensions
-
-
-
-
-
-
-
-
-HierarchicalLevels | Tableau Extensions
-
-
-
-
-
-
-
-
-LogicalTable | Tableau Extensions
-
-
-
-
-
-
-
-
-MarkInfo | Tableau Extensions
-
-
-
-
-
-
-
-
-MarksCollection | Tableau Extensions
-
-
-
-
-
-
-
-
-MarksSelectedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-MarksSpecification | Tableau Extensions
-
-
-
-
-
-
-
-
-Parameter | Tableau Extensions
-
-
-
-
-
-
-
-
-ParameterChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-ParameterDomainRestriction | Tableau Extensions
-
-
-
-
-
-
-
-
-Point | Tableau Extensions
-
-
-
-
-
-
-
-
-RangeDomain | Tableau Extensions
-
-
-
-
-
-
-
-
-RangeFilter | Tableau Extensions
-
-
-
-
-
-
-
-
-RangeFilterOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-RangeValue | Tableau Extensions
-
-
-
-
-
-
-
-
-RelativeDateFilter | Tableau Extensions
-
-
-
-
-
-
-
-
-RelativeDateFilterOptions | Tableau Extensions
-
-
-
-
-
-
-
-
-SelectionCriteria | Tableau Extensions
-
-
-
-
-
-
-
-
-Settings | Tableau Extensions
-
-
-
-
-
-
-
-
-SettingsChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-Sheet | Tableau Extensions
-
-
-
-
-
-
-
-
-Size | Tableau Extensions
-
-
-
-
-
-
-
-
-SummaryDataChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-TableauError | Tableau Extensions
-
-
-
-
-
-
-
-
-TableauEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-TableauSheetEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-TableauWorksheetEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-TableSummary | Tableau Extensions
-
-
-
-
-
-
-
-
-TooltipContext | Tableau Extensions
-
-
-
-
-
-
-
-
-UI | Tableau Extensions
-
-
-
-
-
-
-
-
-VisualSpecification | Tableau Extensions
-
-
-
-
-
-
-
-
-Workbook | Tableau Extensions
-
-
-
-
-
-
-
-
-WorkbookFormatting | Tableau Extensions
-
-
-
-
-
-
-
-
-WorkbookFormattingChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-Worksheet | Tableau Extensions
-
-
-
-
-
-
-
-
-WorksheetContent | Tableau Extensions
-
-
-
-
-
-
-
-
-WorksheetFormattingChangedEvent | Tableau Extensions
-
-
-
-
-
-
-
-
-Tableau Extensions API
diff --git a/website/static/api/modules/tableau.html b/website/static/api/modules/tableau.html
deleted file mode 100644
index a77dbf7b..00000000
--- a/website/static/api/modules/tableau.html
+++ /dev/null
@@ -1,407 +0,0 @@
-
-
-
-
-
- Tableau | Tableau Extensions
-
-
-
-
-
-
-
-
-CategoricalValue | Tableau Extensions API DashboardLayoutChangeDetails | Tableau Extensions API DashboardObjectPositionAndSizeUpdateArray | Tableau Extensions API DashboardObjectVisibilityMap | Tableau Extensions API DataFormat | Tableau Extensions API
TableauEventHandlerFn | Tableau Extensions API TableauEventUnregisterFn | Tableau Extensions API ZoneVisibilityMap | Tableau Extensions API ZoneVisibilityType | Tableau Extensions API ZoneVisibilityType | Tableau Extensions API
-
+
-
-
-
-
-
-
-
-
-
- -
-
- Tableau Extensions API
- -Version: 1.16.0 (February 2026)
-The Tableau Extensions API is a JavaScript library that is organized into namespaces that contain - the classes and methods for communicating with Tableau components. The Tableau Extensions API - library supports both dashboard extensions and viz extensions, although not - all interfaces and methods apply to both extensions. For an overview of how the API is organized, - see Tableau Extensions API Basics.
-
- Note: To see all the methods and properties for the Extensions API interfaces, select the Inherited option in the upper-right corner of your browser window. This option shows any methods and properties inherited from base classes.
-
- | Namespace | -Description | -
|---|---|
| Tableau | -The top-level or global namespace is the tableau namespace, which has no constructs, but contains the extensions namespace. You use the tableau namespace to access the extensions. For example, you call tableau.extensions.initializeAsync() to initialize the API. |
-
| Extensions | -The extensions namespace is the namespace for Tableau extensions. A dashboard extension is one type of extension. A dashboard extension has access to the dashboardContent namespace, and all the objects and classes of the dashboard. Some namespaces, like the settings, environment, and ui are available to all extensions. |
-
| DashboardContent | -(Available to dashboard extensions only) The dashboardContent provides access to the dashboard object. When you have the dashboard object, you have access to all elements in the dashboard, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheets in a dashboard (after initialization), you might have a line of code that looks like the following: const worksheets = tableau.extensions.dashboardContent.dashboard.worksheets |
-
| WorksheetContent | -(Available to viz extensions only) The worksheetContent provides access to the worksheet object. When you have the worksheet object, you have access to all elements in the worksheet, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheet in a workbook (after initialization), you might have a line of code that looks like the following: const worksheet = tableau.extensions.worksheetContent |
-
| Settings | -The settings namespace provides methods to get and set values which will be persisted in a workbook. You can use the settings to configure an extension. |
-
| Environment | -The environment namespace provides methods to programmatically gather information about the environment in which the extension is running. |
-
| UI | -The ui namespace provides methods for an extension to display a popup dialog window. |
-
Dashboard extensions
- -The following diagram shows the relationship between the extensions namespace and the worksheets in - the dashboard. For more information, see Tableau Extensions API Basics.
-
- -
Viz extensions
- -The following diagram shows the relationship between the extensions namespace and the worksheets in - the workbook. For more information, see Tableau Extensions API Basics.
-
-
-
-
- © Copyright Salesforce, Inc. All rights reserved. Various trademarks held by their respective owners. - Salesforce, Inc. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States
-Tableau Extensions API
The Tableau Extensions API is a JavaScript library that is organized into namespaces that contain +the classes and methods for communicating with Tableau components. The Tableau Extensions API +library supports both dashboard extensions and viz extensions, although not +all interfaces and methods apply to both extensions. For an overview of how the API is organized, +see Tableau Extensions API Basics.
+
+ Note: To see all the methods and properties for the Extensions API interfaces, select the Inherited option in the upper-right corner of your browser window. This option shows any methods and properties inherited from base classes.
-
-
-
-
-
-
-
\ No newline at end of file
+| Namespace | +Description | +
|---|---|
| Tableau | +The top-level or global namespace is the tableau namespace, which has no constructs, but contains the extensions namespace. You use the tableau namespace to access the extensions. For example, you call tableau.extensions.initializeAsync() to initialize the API. |
+
| Extensions | +The extensions namespace is the namespace for Tableau extensions. A dashboard extension is one type of extension. A dashboard extension has access to the dashboardContent namespace, and all the objects and classes of the dashboard. Some namespaces, like the settings, environment, and ui are available to all extensions. |
+
| DashboardContent | +(Available to dashboard extensions only) The dashboardContent provides access to the dashboard object. When you have the dashboard object, you have access to all elements in the dashboard, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheets in a dashboard (after initialization), you might have a line of code that looks like the following: const worksheets = tableau.extensions.dashboardContent.dashboard.worksheets |
+
| WorksheetContent | +(Available to viz extensions only) The worksheetContent provides access to the worksheet object. When you have the worksheet object, you have access to all elements in the worksheet, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheet in a workbook (after initialization), you might have a line of code that looks like the following: const worksheet = tableau.extensions.worksheetContent |
+
| Settings | +The settings namespace provides methods to get and set values which will be persisted in a workbook. You can use the settings to configure an extension. |
+
| Environment | +The environment namespace provides methods to programmatically gather information about the environment in which the extension is running. |
+
| UI | +The ui namespace provides methods for an extension to display a popup dialog window. |
+
Dashboard extensions
The following diagram shows the relationship between the extensions namespace and the worksheets in +the dashboard. For more information, see Tableau Extensions API Basics.
+
+
Viz extensions
The following diagram shows the relationship between the extensions namespace and the worksheets in +the workbook. For more information, see Tableau Extensions API Basics.
+
Interface Annotation
Represents an annotation in a worksheet.
+interface Annotation {
annotationHTML: string;
annotationId: number;
annotationText: string;
annotationType: AnnotationType;
tupleId: number;
}
annotationHTML: string;
annotationId: number;
annotationText: string;
annotationType: AnnotationType;
tupleId: number;
}
Index
Properties
Interface CategoricalFilter
A Categorical Filter
+interface CategoricalFilter {
appliedValues: DataValue[];
fieldId: string;
fieldName: string;
filterType: FilterType;
isAllSelected?: boolean;
isExcludeMode: boolean;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getDomainAsync(domainType?: FilterDomainType): Promise<CategoricalDomain>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
appliedValues: DataValue[];
fieldId: string;
fieldName: string;
filterType: FilterType;
isAllSelected?: boolean;
isExcludeMode: boolean;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getDomainAsync(domainType?: FilterDomainType): Promise<CategoricalDomain>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
Hierarchy (View Summary)
- Filter
- CategoricalFilter
Index
Properties
Methods
Properties
Readonlyapplied
Readonlyfield
fieldId: string
Readonlyfield
fieldName: string
Readonlyfilter
Optional Readonlyis
isAllSelected?: boolean
Readonlyis
isExcludeMode: boolean
Readonlyworksheet
worksheetName: string
Methods
get
get
Parameters
OptionaldomainType: FilterDomainType
Returns Promise<CategoricalDomain>
a promise containing the categorical domain for the filter. Note if a filter contains +multiple fields (such as a filter action with multiple fields), the values array in the returned +CategoricalDomain (CategoricalDomain.values) will be empty. If there are multiple fields +in the filter, the results need to be represented by a table, which is not currently supported.
+
get
Returns Promise<Field>
a promise containing the field for the filter.
+
set
Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
+Parameters
- applyToWorksheets: string[]
list of worksheets to apply the filter on
+
Returns Promise<string[]>
the list of worksheet names that have the filter applied
+- applyToWorksheets: string[]
Interface Column
interface Column {
dataType: DataType;
fieldId: string;
fieldName: string;
index: number;
isReferenced: boolean;
}
dataType: DataType;
fieldId: string;
fieldName: string;
index: number;
isReferenced: boolean;
}
Index
Properties
Properties
Readonlydata
Readonlyfield
fieldId: string
Returns
The fieldId of the field in the column. In summary data, this includes the aggregation. +The fieldId is not stable across replacing data sources. +For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become +[federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].
+Readonlyfield
fieldName: string
Readonlyindex
index: number
Readonlyis
isReferenced: boolean
Interface ConnectionSummary
Represents a connection within a datasource (ex: A SQL Server connection). +A data source can be composed of one or more connections.
+interface ConnectionSummary {
id: string;
name: string;
serverURI: undefined | string;
type: string;
}
id: string;
name: string;
serverURI: undefined | string;
type: string;
}
Interface Dashboard
The Dashboard interface inherits from the Sheet interface.
interface Dashboard {
activeDashboardName: string;
activeDashboardObjectId: number;
name: string;
objects: DashboardObject[];
sheetType: SheetType;
size: Size;
worksheets: Worksheet[];
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
applyFilterAsync(
fieldName: string,
values: string[],
updateType: FilterUpdateType,
filterOptions: FilterOptions,
): Promise<string>;
findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
getDashboardObjectById(
dashboardObjectId: number,
): undefined | DashboardObject;
getFiltersAsync(): Promise<Filter[]>;
getParametersAsync(): Promise<Parameter[]>;
moveAndResizeDashboardObjectsAsync(
dashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdateArray,
): Promise<void>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
replayAnimationAsync(replaySpeed: ReplaySpeedType): Promise<void>;
setDashboardObjectVisibilityAsync(
dashboardObjectVisibilityMap: DashboardObjectVisibilityMap,
): Promise<void>;
setZoneVisibilityAsync(zoneVisibilityMap: ZoneVisibilityMap): Promise<void>;
}
activeDashboardName: string;
activeDashboardObjectId: number;
name: string;
objects: DashboardObject[];
sheetType: SheetType;
size: Size;
worksheets: Worksheet[];
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
applyFilterAsync(
fieldName: string,
values: string[],
updateType: FilterUpdateType,
filterOptions: FilterOptions,
): Promise<string>;
findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
getDashboardObjectById(
dashboardObjectId: number,
): undefined | DashboardObject;
getFiltersAsync(): Promise<Filter[]>;
getParametersAsync(): Promise<Parameter[]>;
moveAndResizeDashboardObjectsAsync(
dashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdateArray,
): Promise<void>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
replayAnimationAsync(replaySpeed: ReplaySpeedType): Promise<void>;
setDashboardObjectVisibilityAsync(
dashboardObjectVisibilityMap: DashboardObjectVisibilityMap,
): Promise<void>;
setZoneVisibilityAsync(zoneVisibilityMap: ZoneVisibilityMap): Promise<void>;
}
Hierarchy (View Summary)
- Sheet
- Dashboard
Index
Properties
Methods
Properties
Readonlyactive
activeDashboardName: string
Readonlyactive
activeDashboardObjectId: number
Readonlyname
name: string
Readonlyobjects
Readonlysheet
Readonlysize
Readonlyworksheets
This is a helper method and is equivalent to looping
+through all of the objects in a dashboard and collecting all of the objects
+whose type is worksheet. You can use this property to iterate
+through all of the worksheets in the dashboard.
Returns
The collection of worksheets contained in the dashboard.
+The following example uses the JavaScript forEach() method to traverse
+the worksheets in the dashboard.
+
let dashboard = tableau.extensions.dashboardContent.dashboard;
dashboard.worksheets.forEach(function (worksheet) {
// do something with the worksheets..
console.log("The worksheet name is " + worksheet.name)
});
+Methods
add
- addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFnAdds a new event listener to the object. If this object does not support the specified
+eventType, +the method throws an exception. +The following table shows the event types supported by objects.+ +
++ + + +object +eventType ++ +Worksheet +FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged+ +Parameter +ParameterChanged+ +Settings +SettingsChanged+ + +Dashboard +DashboardLayoutChanged,WorkbookFormattingChangedParameters
- eventType: TableauEventType
The type of event to register for. The type of event is a
+TableauEventTypeenumeration. - handler: TableauEventHandlerFn
The function which will be called when an event happens.
+
Returns TableauEventUnregisterFn
A helper function which can be called to remove this registration.
+The following example sets up a listener in a worksheet for a mark selection event (
+MarkSelectionChanged). +When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers +the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.
+ +// Add an event listener for the selection changed event on this sheet.
// Assigning the event to a variable just to make the example fit on the page here.
const markSelection = tableau.TableauEventType.MarkSelectionChanged;
//
unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
// When the selection changes, reload the data
loadSelectedMarks(worksheetName);
});
// remove the event listener when done
unregisterEventHandlerFunction();
+ - eventType: TableauEventType
apply
- applyFilterAsync(
fieldName: string,
values: string[],
updateType: FilterUpdateType,
filterOptions: FilterOptions,
): Promise<string>Applies a simple categorical filter (non-date) to the dashboard. +This method is similar to the method used for worksheets, but applies the filter to all the worksheets in the dashboard that have that same field. +Note that the filter is ignored by a worksheet if the worksheet doesn't have the relevant field in its data source.
+Parameters
- fieldName: string
The name of the field to filter on.
+ - values: string[]
The list of values to filter on.
+ - updateType: FilterUpdateType
The update type of this filter (add, all, remove, replace).
+ - filterOptions: FilterOptions
Advanced filter options (isExcludeMode).
+
Returns Promise<string>
The field name that the filter is applied on.
+ - fieldName: string
find
Searches for a parameter with the given name.
+Parameters
- parameterName: string
The name of the parameter to find.
+
Returns Promise<undefined | Parameter>
The parameter with the given name, or undefined if it does not exist.
+- parameterName: string
get
Gets the specified dashboard object by its id. If a dashboard object is not found this method returns undefined.
+Parameters
- dashboardObjectId: number
The id of an object on the dashboard.
+
Returns undefined | DashboardObject
The dashboard object with that id. Returns undefined if the dashboard object is not found.
+- dashboardObjectId: number
get
Returns Promise<Filter[]>
The collection of filters used on the dashboard
+
get
Returns Promise<Parameter[]>
A collection of all the Tableau parameters that are used in this workbook.
+
move
- moveAndResizeDashboardObjectsAsync(
dashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdateArray,
): Promise<void>Sets the position and size of one or more floating dashboard objects. +Throws an error if the dashboard object is invalid
+Parameters
- dashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdateArray
Returns Promise<void>
Empty promise that resolves when the position and size of the dashboard objects have been changed.
+Since
1.7.0 and Tableau 2021.4
+The following example shows how you can update the position and size of multiple (valid, floating) dashboard objects in a dashboard +
+
+ +let dashboardObjectPositionAndSizeUpdateArray = [];
let dashboardObjectPositionAndSizeUpdate1 = {
dashboardObjectID: 1,
x: 0,
y: 0,
width: 50,
height: 50
};
let dashboardObjectPositionAndSizeUpdate2 = {
dashboardObjectID: 2,
x: 75,
y: 75,
width: 60,
height: 60
};
dashboardObjectPositionAndSizeUpdateArray.push(dashboardObjectPositionAndSizeUpdate1, dashboardObjectPositionAndsizeUpdate2);
tableau.extensions.dashboardContent.dashboard.moveAndResizeDashboardObjectsAsync(dashboardObjectPositionAndSizeUpdateArray)
.then(() => {
console.log("done");
+
remove
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the
+addEventListenermethod. Alternatively, use the function +returned from the call toaddEventListenerto unregister the event listener. +For more information, see Events and Event Handling.Parameters
- eventType: TableauEventType
- handler: TableauEventHandlerFn
Returns boolean
Whether or not an event listener was removed.
+
replay
Replays an animation for the active sheet +Throws an error if the replay speed is invalid
+Parameters
- replaySpeed: ReplaySpeedType
Returns Promise<void>
Empty promise that resolves when the animation has been replayed.
+
set
- setDashboardObjectVisibilityAsync(
dashboardObjectVisibilityMap: DashboardObjectVisibilityMap,
): Promise<void>Sets the visibility of one or more dashboard objects. +Throws an error if the dashboard object is invalid
+Parameters
- dashboardObjectVisibilityMap: DashboardObjectVisibilityMap
A map of dashboard object ids to its desired state of visibility.
+
Returns Promise<void>
Empty promise that resolves when the visibility has been changed.
+Since
1.7.0 and Tableau 2021.4
+The following example shows how you can update the visibility of multiple valid dashboard objects +
+
+ +var dashboardObjectVisibilityMap = new Map();
dashboardObjectVisibilityMap.set(10, tableau.DashboardObjectVisibilityType.Show);
dashboardObjectVisibilityMap.set(8, tableau.DashboardObjectVisibilityType.Hide);
var dashboard = tableau.extensions.dashboardContent.dashboard;
dashboard.setDashboardObjectVisibilityAsync(dashboardObjectVisibilityMap).then(() => {
console.log("done");
});
+ - dashboardObjectVisibilityMap: DashboardObjectVisibilityMap
set
Sets the visibility of one or more floating dashboard zones. +Throws an error if the zone is invalid
+Parameters
- zoneVisibilityMap: ZoneVisibilityMap
A map of zone ids to the desired state of visibility for that zone.
+
Returns Promise<void>
Empty promise that resolves when the visibility has been changed.
+Deprecated
use setDashboardObjectVisibilityAsync
+The following example shows how you can update the visibility of multiple (valid, floating) zones in a dashboard +
+
+ +var zoneVisibilityMap = {};
zoneVisibilityMap[10] = tableau.ZoneVisibilityType.Show;
zoneVisibilityMap[8] = tableau.ZoneVisibilityType.Hide;
tableau.extensions.dashboardContent.dashboard.setZoneVisibilityAsync(zoneVisibilityMap).then(() => {
console.log("done");
});
+- zoneVisibilityMap: ZoneVisibilityMap
Interface DashboardContent
The DashboardContent namespace is the namespace associated with Dashboard Extensions.
+The DashboardContent namespace contains the Dashboard interface. Use the Dashboard Interface to
+access dashboard objects, worksheets, and parameters, and to add or remove event listeners.
Index
Properties
Interface DashboardLayoutChangedEvent
An event which is raised when the dashboard objects are modified.
+Should be listened for directly from the tableau.extensions.dashboardContent.dashboard object.
interface DashboardLayoutChangedEvent {
dashboardLayoutChangeDetails: DashboardLayoutChangeDetails;
type: TableauEventType;
}
dashboardLayoutChangeDetails: DashboardLayoutChangeDetails;
type: TableauEventType;
}
Hierarchy (View Summary)
- TableauEvent
- DashboardLayoutChangedEvent
Index
Properties
Interface DashboardObject
An object of a dashboard.
+interface DashboardObject {
dashboard: Dashboard;
fieldId: undefined | string;
id: number;
isFloating: boolean;
isVisible: boolean;
name: string;
position: Point;
size: Size;
type: DashboardObjectType;
worksheet: undefined | Worksheet;
}
dashboard: Dashboard;
fieldId: undefined | string;
id: number;
isFloating: boolean;
isVisible: boolean;
name: string;
position: Point;
size: Size;
type: DashboardObjectType;
worksheet: undefined | Worksheet;
}
Interface DashboardObjectPositionAndSizeUpdate
An object to specify a dashboard object and its new position and size in a dashboard.
+interface DashboardObjectPositionAndSizeUpdate {
dashboardObjectID: number;
height: number;
width: number;
x: number;
y: number;
}
dashboardObjectID: number;
height: number;
width: number;
x: number;
y: number;
}
Index
Properties
Interface DataFormattingOptions
interface DataFormattingOptions {
customFormatString: string;
decimalCharacter: string;
decimals: number;
formatType: DataFormatType;
locale: string;
negativeFormat: NegativeNumberFormat;
prefix: string;
separatorCharacter: string;
showSeparators: boolean;
suffix: string;
units: NumberFormatUnits;
}
customFormatString: string;
decimalCharacter: string;
decimals: number;
formatType: DataFormatType;
locale: string;
negativeFormat: NegativeNumberFormat;
prefix: string;
separatorCharacter: string;
showSeparators: boolean;
suffix: string;
units: NumberFormatUnits;
}
Index
Properties
Properties
custom
customFormatString: string
Returns
The custom format string to display for the value.
+For more information on number formats, see Format Numbers and Null Values.
+When the custom format string is used for numbers, other formatting options are ignored.
+For information on formatting dates, see Custom Date Formats.
+The custom format string is always used for dates and the other formatting options do not apply (except for the formatType and locale).
decimal
decimalCharacter: string
decimals
decimals: number
format
locale
locale: string
negative
prefix
prefix: string
separator
separatorCharacter: string
show
showSeparators: boolean
suffix
suffix: string
units
Interface DataSource
Represents the data source used by a Worksheet.
+interface DataSource {
extractUpdateTime: undefined | string;
fields: Field[];
id: string;
isExtract: boolean;
isPublished: undefined | boolean;
name: string;
getActiveTablesAsync(): Promise<TableSummary[]>;
getConnectionSummariesAsync(): Promise<ConnectionSummary[]>;
getLogicalTableDataAsync(
logicalTableId: string,
options?: DataSourceUnderlyingDataOptions,
): Promise<DataTable>;
getLogicalTablesAsync(): Promise<LogicalTable[]>;
getUnderlyingDataAsync(
options?: DataSourceUnderlyingDataOptions,
): Promise<DataTable>;
refreshAsync(): Promise<void>;
}
extractUpdateTime: undefined | string;
fields: Field[];
id: string;
isExtract: boolean;
isPublished: undefined | boolean;
name: string;
getActiveTablesAsync(): Promise<TableSummary[]>;
getConnectionSummariesAsync(): Promise<ConnectionSummary[]>;
getLogicalTableDataAsync(
logicalTableId: string,
options?: DataSourceUnderlyingDataOptions,
): Promise<DataTable>;
getLogicalTablesAsync(): Promise<LogicalTable[]>;
getUnderlyingDataAsync(
options?: DataSourceUnderlyingDataOptions,
): Promise<DataTable>;
refreshAsync(): Promise<void>;
}
Index
Properties
Readonlyextract
extractUpdateTime: undefined | string
Readonlyfields
Readonlyid
id: string
Readonlyis
isExtract: boolean
Readonlyis
isPublished: undefined | boolean
Readonlyname
name: string
Methods
get
Returns Promise<TableSummary[]>
An array of table summary objects that are currently used in the data source.
+
get
Returns Promise<ConnectionSummary[]>
An array of descriptions of the connections within this data source.
+
get
- getLogicalTableDataAsync(
logicalTableId: string,
options?: DataSourceUnderlyingDataOptions,
): Promise<DataTable>Gets the underlying data table for the given logical table id.
+Parameters
- logicalTableId: string
Optionaloptions: DataSourceUnderlyingDataOptionsCollection of options to change the behavior of the call.
+
Returns Promise<DataTable>
A data table containing the underlying data of the data source.
+See
getLogicalTableDataReaderAsync to read more than 10,000 rows.
+You can use the
+getUnderlyingDataOptions.maxRowsproperty to request the number of rows of data to return. +If unspecified (maxRows == '0'), the call togetLogicalTableDataAsyncrequests all rows in the logical table. +Note that the maximum number of rows returned from thegetLogicalTableDataAsync()method is limited +to 10,000 rows. You can use theDataTableproperty,isTotalRowCountLimited, to test whether there is +more data. A value of true indicates that the calling function requested more rows than the limit (10,000) and the +underlying data source contains more rows than can be returned.The following example shows use of the getLogicalTableDataAsync() method to get the data from a specific logical table in a data source. +The example uses the JavaScript find() method to select the workbook, and uses the getLogicalTablesAsync method to identify the logical table id.
+
+ +const dataSources = await worksheet.getDataSourcesAsync();
const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
const logicalTables = await dataSource.getLogicalTablesAsync()
const dataTable = await dataSource.getLogicalTableDataAsync(logicalTables[0].id);
console.log(dataTable); +
get
Gets the underlying logical tables used in the data source.
+Returns Promise<LogicalTable[]>
An array of logical tables that are currently used in the data source.
+The following example uses the
+getLogicalTablesAsyncmethod to print the names of the +the logical tables to the console.
+ +dataSource.getLogicalTablesAsync().then(function (logicalTables) {
// Loop through each table that was used in creating this data source
logicalTables.forEach(function (table) {
console.log(table.caption);
});
}); +
get
Parameters
Optionaloptions: DataSourceUnderlyingDataOptionsCollection of options to change the behavior of the call.
+
Returns Promise<DataTable>
Returns a promise containing a page of data from the underlying data of the data source.
+The following example shows use of the
+getUnderlyingDataAsync()method to get the underlying data from a specific data source. +The example uses the JavaScriptfind()method to select the workbook and data source.
+ +const dataSources = await worksheet.getDataSourcesAsync();
const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
const dataTable = await dataSource.getUnderlyingDataAsync();
let field = dataTable.columns.find(column => column.fieldName === "Sub-Category");
let list = [];
for (let row of dataTable.data) {
list.push(row[field.index].value);
}
let values = list.filter((el, i, arr) => arr.indexOf(el) === i);
console.log(values);
+
refresh
This call has the same functionality as clicking the Refresh option on a data source in +Tableau. This does not refresh an extract.
++NoteThe
+refreshAsync()method is intended to be used in scenarios where manual +interaction causes a need to refresh the data in the Tableau visualization. The method is not, +as currently designed, meant to support or emulate streaming or live visualizations. +Extensions that use the method to refresh aggressively or automatically +can cause issues on Tableau Server and Tableau Online and are subject to being blocked +by the Tableau Online administrator.This call does not currently support refreshing live Google Sheet data sources.
+Returns Promise<void>
Promise that resolves when the data source has finished refreshing.
+
Interface DataSourceUnderlyingDataOptions
Configuration object for fetching data from an data source object.
+interface DataSourceUnderlyingDataOptions {
columnsToInclude?: string[];
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
columnsToInclude?: string[];
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
Index
Properties
Optionalcolumns
columnsToInclude?: string[]
The columns to return specified by field name, returns all by default.
+Optionalcolumns
columnsToIncludeById?: string[]
The columns to return specified by field id, returns all by default. +Since 1.5.0, fieldId is a property of the Column object.
+Optionalignore
ignoreAliases?: boolean
Do not use aliases specified in the data source in Tableau. Default is false.
+Optionalinclude
Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
+All properties not requested will be undefined in the DataValue results.
+This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
Optionalmax
maxRows?: number
The maximum number of rows to return. 10,000 by default
+Interface DataTable
interface DataTable {
columns: Column[];
data: DataValue[][];
isSummaryData?: boolean;
isTotalRowCountLimited?: boolean;
marksInfo?: MarkInfo[];
name: string;
totalRowCount: number;
}
columns: Column[];
data: DataValue[][];
isSummaryData?: boolean;
isTotalRowCountLimited?: boolean;
marksInfo?: MarkInfo[];
name: string;
totalRowCount: number;
}
Index
Properties
Properties
Readonlycolumns
Readonlydata
Optional Readonlyis
isSummaryData?: boolean
Optional Readonlyis
isTotalRowCountLimited?: boolean
Returns
True if the rows returned have been limited to the maximum number of retrievable rows.
+A value of true indicates that the caller requested more rows than the limit
+and the underlying data source contains more rows than can be returned.
+isTotalRowCountLimited can be true in the case of ...
+getAllPagesAsync with more than 4,000,000 rows in the summary or underlying data.
+getLogicalTableDataAsync or getUnderlyingTableDataAsync with more than 10,000 rows in the data.
+In all these cases, limits can be avoided by processing the data in page sized chunks with DataTableReader.
+isTotalRowCountLimited is always false in the results of DataTableReader.getPageAsync().
Optional Readonlymarks
Readonlyname
name: string
Readonlytotal
totalRowCount: number
Interface DataTableReader
A DataTableReader allows iteration over summary or underlying data by pages. +The page size is established when the DataTableReader is created. +(See getLogicalTableDataReaderAsync, getSummaryDataReaderAsync, or getUnderlyingTableDataReaderAsync.) +The normal sequence of operations would be to
+-
+
- Create the DataTableReader for the desired DataTable. +
- Use DataTableReader.totalRowCount or DataTableReader.pageCount to discover how many rows or pages are in the desired DataTable. +
- Call DataTableReader.getPageAsync() to get the page(s) desired. Each page is a DataTable for that page. +Alternatively, based on the DataTableReader.totalRowCount, DataTableReader.getAllPagesAsync can be used to fetch the entire DataTable. +
- Call DataTableReader.releaseAsync() to free up resources. +
Notes for usage of a DataTableReader:
+-
+
- Since DataTableReaders consume server resources, an inactive DataTableReader will be automatically +released after 60 minutes of inactivity. (A new DataTableReader can be created at that time, if needed.) +
- Calling getPageAsync() after an explicit or automatic releaseAsync() will throw an exception. +
- Only one active DataTableReader per logical table id is supported. +
- There are still limits on the number of rows supported for underlying and logical data table readers. +The default limit is approximately 1 million rows of data for getUnderlyingTableDataReaderAsync, +and approximately 32 million cells (rows * columns) for getLogicalTableDataReaderAsync. +Administrators may change these limits to better match computing resources with the Tableau Server (Cloud) or Tableau Desktop options: +ExtensionsAndEmbeddingReaderRowLimit for getUnderlyingTableDataReaderAsync or +ExtensionsAndEmbeddingReaderCellLimit for getLogicalTableDataReaderAsync. +
interface DataTableReader {
pageCount: number;
totalRowCount: number;
getAllPagesAsync(maxRows?: number): Promise<DataTable>;
getPageAsync(pageNumber: number): Promise<DataTable>;
releaseAsync(): Promise<void>;
}
pageCount: number;
totalRowCount: number;
getAllPagesAsync(maxRows?: number): Promise<DataTable>;
getPageAsync(pageNumber: number): Promise<DataTable>;
releaseAsync(): Promise<void>;
}
Index
Properties
Methods
Methods
get
Get all the pages of data into a single DataTable. +Calls to getAllPagesAsync() after releaseAsync() will throw an exception. +To protect against possible browser failure, getAllPagesAsync will cap the data at a maximum of 400 pages. +With a default pageRowCount of 10,000 this will give you a maximum of 4,000,000 rows of data.
+If sizes are larger than this, please process your data in page size chunks.
+Parameters
OptionalmaxRows: numberLimits the request to maxRows. If maxRows === 0, requests all rows.
+
Returns Promise<DataTable>
A DataTable containing all the data available to the DataTableReader with the maximum page count above.
+
+ +// To simplify the example, we assume we have less than 4m rows of data
// Since we are fetching all of the data, use the default page size in getSummaryDataReaderAsync
const dataTableReader = await worksheet.getSummaryDataReaderAsync();
const dataTable = await dataTableReader.getAllPagesAsync();
await dataTableReader.releaseAsync();
// ... process the data table ... +
get
Get a page of data. The page is returned as a DataTable. +Calls to getPageAsync() after releaseAsync() will throw an exception.
+Parameters
- pageNumber: number
The page number (zero-indexed) to fetch. The page number should be treated +like an array index with range: 0 <= pageNumber < pageCount.
+
Returns Promise<DataTable>
A DataTable containing the requested page. The number of rows returned +can be less than the page size at the end of the data.
+
+ +const pageRowCount = 200;
const dataTableReader = await worksheet.getSummaryDataReaderAsync(pageRowCount, options);
for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
const currentPageDataTable = await dataTableReader.getPageAsync(currentPage);
// ... process current page ...
}
await dataTableReader.releaseAsync(); +- pageNumber: number
release
Release all resources held by the DataTableReader. +Calling this when done with the DataTableReader is required practice as it frees up resources. +Calls to getPageAsync() after releaseAsync() will throw an exception.
+Returns Promise<void>
Interface DataValue
interface DataValue {
aliasValue?: string;
formattedValue?: string;
hasAlias?: boolean;
nativeValue: any;
value: any;
}
aliasValue?: string;
formattedValue?: string;
hasAlias?: boolean;
nativeValue: any;
value: any;
}
Index
Properties
Properties
Optional Readonlyalias
aliasValue?: string
Optional Readonlyformatted
formattedValue?: string
Optional Readonlyhas
hasAlias?: boolean
Readonlynative
nativeValue: any
Returns
The raw native value as a JavaScript type, which is +one of string, number, boolean, or Date object. Please note that special +values are returned as null. The actual special value can be found +in formattedValue, which would be something like 'Null', or 'No-Access'. +Using nativeValue can greatly simplify your error checking since all values +will be their native type value or null.
+Readonlyvalue
value: any
Interface DialogMessageEvent
An event which is raised when the dialog has a message for the underlying extension (sent using tableau.extensions.ui.sendDialogMessageAsync), or vice versa.
+Should be listened for directly from the tableau.extensions.ui object.
+For example, when the dialog sends a message to the extension using tableau.extensions.ui.sendDialogMessageAsync method,
+the extension should be listening for this event and handling it.
Hierarchy (View Summary)
- TableauEvent
- DialogMessageEvent
Index
Properties
Interface DialogOptions
Index
Properties
Properties
Optional Readonlydialog
Specifies the style for the popup dialog.
+Optional Readonlyheight
height?: number
Specifies the suggested height (in pixels) of the popup dialog. Not guaranteed to be exactly that height.
+Optional Readonlywidth
width?: number
Specifies the suggested width (in pixels) of dialog to display. Not guaranteed to be exactly that width.
+Interface Encoding
interface Encoding {
field: FieldInstance;
fieldEncodingId: string;
id: string;
type: EncodingType;
}
field: FieldInstance;
fieldEncodingId: string;
id: string;
type: EncodingType;
}
Index
Properties
Interface Environment
The environment namespace provides a way to programmatically gather +information about the environment in which the Extensions is running.
+interface Environment {
apiVersion: string;
context: ExtensionContext;
country?: string;
exportedMediaType?: ExportedMediaType;
isExporting: boolean;
language: string;
locale: string;
mode: ExtensionMode;
operatingSystem: string;
tableauVersion: string;
uniqueUserId?: string;
workbookFormatting?: WorkbookFormatting;
workbookLocale: string;
}
apiVersion: string;
context: ExtensionContext;
country?: string;
exportedMediaType?: ExportedMediaType;
isExporting: boolean;
language: string;
locale: string;
mode: ExtensionMode;
operatingSystem: string;
tableauVersion: string;
uniqueUserId?: string;
workbookFormatting?: WorkbookFormatting;
workbookLocale: string;
}
Index
Properties
Readonlyapi
apiVersion: string
Readonlycontext
Optional Readonlycountry
country?: string
Optional Readonlyexported
exportedMediaType?: ExportedMediaType
Readonlyis
isExporting: boolean
Readonlylanguage
language: string
Readonlylocale
locale: string
Readonlymode
Readonlyoperating
operatingSystem: string
Readonlytableau
tableauVersion: string
Optional Readonlyunique
uniqueUserId?: string
Returns
A unique id representing the current user. +The id is unique across a Tableau deployment or across a Tableau Cloud Site. +When the extension is running in desktop, the uniqueUserId is derived from machine-name/user-name. +When the extension is running in server, the uniqueUserId is derived from the user's login name. +There is no mechanism to obtain the actual user name or any additional user information. +If running against a Tableau version prior to 2023.2, uniqueUserId will be undefined.
+Optional Readonlyworkbook
Returns
WorkbookFormatting contains an array of FormattingSheets that will get +your formatting information from the workbook. +The types of sheet formatting by Class Name Key: WorksheetTitle, Worksheet (body text), +Tooltip, StoryTitle, and DashboardTitle +These formatting sheets include the following CSS properties: fontName, fontSize, +isFontBold, isFontItalic, isFontUnderlined, and color.
+Readonlyworkbook
workbookLocale: string
Interface EventListenerManager
Interface for handling registering and unregistering event listeners. Different objects will implement +this interface to manage their event handling.
+interface EventListenerManager {
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
}
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
}
Hierarchy (View Summary)
Index
Methods
Methods
add
- addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFnAdds a new event listener to the object. If this object does not support the specified
+eventType, +the method throws an exception. +The following table shows the event types supported by objects.+ +
++ + + +object +eventType ++ +Worksheet +FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged+ +Parameter +ParameterChanged+ +Settings +SettingsChanged+ + +Dashboard +DashboardLayoutChanged,WorkbookFormattingChangedParameters
- eventType: TableauEventType
The type of event to register for. The type of event is a
+TableauEventTypeenumeration. - handler: TableauEventHandlerFn
The function which will be called when an event happens.
+
Returns TableauEventUnregisterFn
A helper function which can be called to remove this registration.
+The following example sets up a listener in a worksheet for a mark selection event (
+MarkSelectionChanged). +When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers +the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.
+ +// Add an event listener for the selection changed event on this sheet.
// Assigning the event to a variable just to make the example fit on the page here.
const markSelection = tableau.TableauEventType.MarkSelectionChanged;
//
unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
// When the selection changes, reload the data
loadSelectedMarks(worksheetName);
});
// remove the event listener when done
unregisterEventHandlerFunction();
+ - eventType: TableauEventType
remove
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the
+addEventListenermethod. Alternatively, use the function +returned from the call toaddEventListenerto unregister the event listener. +For more information, see Events and Event Handling.Parameters
- eventType: TableauEventType
- handler: TableauEventHandlerFn
Returns boolean
Whether or not an event listener was removed.
+
Interface Extensions
The extension namespace contains all functionality available to +Extensions in Tableau.
+interface Extensions {
dashboardContent?: DashboardContent;
dashboardObjectId: number;
environment: Environment;
settings: Settings;
ui: UI;
workbook: Workbook;
worksheetContent?: WorksheetContent;
createVizImageAsync(inputSpec: object): Promise<string>;
initializeAsync(
contextMenuCallbacks?: { [key: string]: () => {} },
): Promise<void>;
initializeDialogAsync(): Promise<string>;
reportExtensionRenderComplete(mediaBlob?: ArrayBuffer): Promise<void>;
setClickThroughAsync(clickThroughEnabled: boolean): Promise<void>;
}
dashboardContent?: DashboardContent;
dashboardObjectId: number;
environment: Environment;
settings: Settings;
ui: UI;
workbook: Workbook;
worksheetContent?: WorksheetContent;
createVizImageAsync(inputSpec: object): Promise<string>;
initializeAsync(
contextMenuCallbacks?: { [key: string]: () => {} },
): Promise<void>;
initializeDialogAsync(): Promise<string>;
reportExtensionRenderComplete(mediaBlob?: ArrayBuffer): Promise<void>;
setClickThroughAsync(clickThroughEnabled: boolean): Promise<void>;
}
Index
Properties - All Extensions
Properties - Dashboard Extensions
Properties - Viz Extensions
Methods - All Extensions
Methods - Dashboard Extensions
Properties - All Extensions
environment
The environment namespace provides methods to programmatically gather information about the environment
+in which the extension is running. To access the objects in this name space, specify
+tableau.extensions.environment.
settings
The settings namespace provides methods to get and set values which will be persisted in a workbook.
+You can use the settings to configure an extension. To access the objects in this name space, specify
+tableau.extensions.settings.
ui
The ui namespace provides methods for an extension to display a popup dialog window.
+To access the objects in this name space, specify tableau.extensions.ui.
workbook
The currently opened workbook.
+Properties - Dashboard Extensions
Optionaldashboard
The dashboardContent namespace provides access to the dashboard object when the extension is a dashboard extension.
+When you have the dashboard object, you have access to all elements in the dashboard
+including the worksheets, marks,
+filters, parameters, and data sources.
+To access the objects in this name space, specify tableau.extensions.dashboardContent.
dashboard
dashboardObjectId: number
The dashboard object id for the extension that is running.
+Properties - Viz Extensions
Optionalworksheet
The worksheetContent namespace provides access to the worksheet when the extension is a worksheet extension.
+When you have the worksheet object, you have access to all elements in the worksheet
+To access the objects in this name space, specify tableau.extensions.worksheetContent.
Methods - All Extensions
create
Parameters
- inputSpec: object
the object containing the embedded data and visual spec details
+
+ +tableau.extensions.createVizImageAsync(myInputSpec)); +The following is an example of an input spec object.
+
+ +var myInputSpec = {
description: 'A simple bar chart with embedded data.',
data: {
values: [
{ Category: 'A', Measure: 28, Weather: 10 },
{ Category: 'B', Measure: 55, Weather: 9 },
{ Category: 'C', Measure: 43, Weather: 8 },
]
},
mark: tableau.MarkType.Bar,
encoding: {
columns: { field: 'Category', type: tableau.VizImageEncodingType.Discrete },
rows: { field: 'Measure', type: tableau.VizImageEncodingType.Continuous },
sort: { field: 'Category', 'sortby': 'Weather', direction: tableau.VizImageSortDirectionType.Ascending }
}
}; +
Returns Promise<string>
A promise that when resolved, returns the viz as an svg.
+Supports sorting by field.
+Since
1.8.0 and Tableau 2021.4
+For additional information on using the
+createVizImageAsyncmethod, +see Add Tableau Viz to Your Dashboard Extensions.For additional information about setting options in the
+inputSpecobject, +see Tableau Viz Reference.- inputSpec: object
initialize
This is the entry point for an Extension. This function must first be called +in order to interact with any of the other Extension APIs.
+Parameters
OptionalcontextMenuCallbacks: { [key: string]: () => {} }This optional object maps the ids of context menu items to the function +to be triggered when that context menu item is selected. The keys listed +must matched the keys registered in the
+context-menuelement of the manifest. +Currently, only a single context menu item is available ('configure') +that creates the Configure... menu item), so this object will only contain a single entry. +In this example, the'configure'key is mapped to a function of the same name, +which you would define in your JavaScript code.
+ +$(document).ready(function () {
tableau.extensions.initializeAsync({'configure': configure}).then(function() {
// When the user clicks the Configure... context menu item,
// the configure function specified as the argument here
// is executed.
//
});
}); +
Returns Promise<void>
A promise that when resolved, the other Extension APIs will be available to use.
+
initialize
The
+initializeDialogAsyncfunction is the entry point for an extension that runs inside a dialog box (or popup window) +created by the UI namespace. A call totableau.extensions.ui.displayDialogAsync(payload)creates the dialog box. +When the extension running in the dialog box loads, the extension must first call theinitializeDialogAsyncfunction +to use the rest of the Extension API. TheinitializeDialogAsyncfunction should only be called by extensions +that are displayed in a dialog box. You use theinitializeAsyncfunction +to initialize the main extension, that is, the parent of the extension in the dialog box.Returns Promise<string>
A promise that when resolved the other Extension APIs will be available to use. +Contains a string that is the initial payload for the dialog as sent by the +parent extension via
+tableau.extensions.ui.displayDialogAsync(payload). +See displayDialogAsync for more information.
report
This method notifies the platform that the extension has completed its rendering. +This can be used to signal that the extension is ready for interaction or for exporting.
+Parameters
OptionalmediaBlob: ArrayBufferAn optional blob of media data to be included in the rendering complete notification (e.g. an image).
+
Returns Promise<void>
Methods - Dashboard Extensions
set
This method allows for clicks to pass through the extension window on Tableau Server.
+Parameters
- clickThroughEnabled: boolean
A boolean which represents if clicks should pass through the extension window
+
Returns Promise<void>
A promise that resolves when the click through property has been set.
+The following example shows a call made to setClickThroughAsync.
+
+ +// disabling pointer events on the extension window
tableau.extensions.setClickThroughAsync(true).then(() => {
console.log('Successfully enabled extension window click through');
}).catch((error) => {
// Can throw an error if called from a dialog or on Tableau Desktop
console.error(error.message);
}); +- clickThroughEnabled: boolean
Interface Field
A field contains information about what data source it belongs to, +its role, and the ability to fetch the domain values.
+interface Field {
aggregation: FieldAggregationType;
columnType: ColumnType;
dataFormat?: DataFormat;
dataSource: DataSource;
dataType: undefined | DataType;
description: undefined | string;
id: string;
isCalculatedField: boolean;
isCombinedField: boolean;
isGenerated: boolean;
isGeospatial: boolean;
isHidden: boolean;
isPresentOnPublishedDatasource: boolean;
name: string;
role: FieldRoleType;
semanticRole?: string;
}
aggregation: FieldAggregationType;
columnType: ColumnType;
dataFormat?: DataFormat;
dataSource: DataSource;
dataType: undefined | DataType;
description: undefined | string;
id: string;
isCalculatedField: boolean;
isCombinedField: boolean;
isGenerated: boolean;
isGeospatial: boolean;
isHidden: boolean;
isPresentOnPublishedDatasource: boolean;
name: string;
role: FieldRoleType;
semanticRole?: string;
}
Index
Properties
Readonlyaggregation
Readonlycolumn
Optionaldata
Data formatting options for the field.
+Readonlydata
Readonlydata
Readonlydescription
description: undefined | string
Readonlyid
id: string
Readonlyis
isCalculatedField: boolean
Readonlyis
isCombinedField: boolean
Readonlyis
isGenerated: boolean
Returns
True if this field is generated by Tableau, false otherwise. +Tableau generates a number of fields for a data source, such as Number +of Records, or Measure Values. This property can be used to +distinguish between those fields and fields that come from the underlying +data connection, or were created by a user.
+Readonlyis
isGeospatial: boolean
Readonlyis
isHidden: boolean
Readonlyis
isPresentOnPublishedDatasource: boolean
Readonlyname
name: string
Readonlyrole
Optionalsemantic
semanticRole?: string
The semantic role of the field. +Can be either a geographic role (e.g. latitude, longitude, city, country, etc...) or an image role
+Interface FieldInstance
interface FieldInstance {
aggregation: FieldAggregationType;
columnType: ColumnType;
dataFormat?: DataFormat;
dataType: undefined | DataType;
description: undefined | string;
fieldId: string;
isCalculatedField: boolean;
isCombinedField: boolean;
isGenerated: boolean;
isGeospatial: boolean;
isHidden: boolean;
isPresentOnPublishedDatasource: boolean;
name: string;
role: FieldRoleType;
semanticRole?: string;
}
aggregation: FieldAggregationType;
columnType: ColumnType;
dataFormat?: DataFormat;
dataType: undefined | DataType;
description: undefined | string;
fieldId: string;
isCalculatedField: boolean;
isCombinedField: boolean;
isGenerated: boolean;
isGeospatial: boolean;
isHidden: boolean;
isPresentOnPublishedDatasource: boolean;
name: string;
role: FieldRoleType;
semanticRole?: string;
}
Index
Properties
Readonlyaggregation
Readonlycolumn
Optionaldata
Data formatting options for the field.
+Readonlydata
Readonlydescription
description: undefined | string
Readonlyfield
fieldId: string
Returns
The unique representation of the field across all data sources in the workbook. In summary data, this includes aggregation. +Note that the fieldId could change if you change the data source. +For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become +[federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].
+Readonlyis
isCalculatedField: boolean
Readonlyis
isCombinedField: boolean
Readonlyis
isGenerated: boolean
Returns
True if this field is generated by Tableau, false otherwise. +Tableau generates a number of fields for a data source, such as Number +of Records, or Measure Values. This property can be used to +distinguish between those fields and fields that come from the underlying +data connection, or were created by a user.
+Readonlyis
isGeospatial: boolean
Readonlyis
isHidden: boolean
Readonlyis
isPresentOnPublishedDatasource: boolean
Readonlyname
name: string
Readonlyrole
Optionalsemantic
semanticRole?: string
The semantic role of the field. +Can be either a geographic role (e.g. latitude, longitude, city, country, etc...) or an image role
+Interface Filter
An abstract base class for all of the filter types.
+interface Filter {
fieldId: string;
fieldName: string;
filterType: FilterType;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
fieldId: string;
fieldName: string;
filterType: FilterType;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
Hierarchy (View Summary)
Index
Properties
Methods
Properties
Readonlyfield
fieldId: string
Readonlyfield
fieldName: string
Readonlyfilter
Readonlyworksheet
worksheetName: string
Methods
get
get
Returns Promise<Field>
a promise containing the field for the filter.
+
set
Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
+Parameters
- applyToWorksheets: string[]
list of worksheets to apply the filter on
+
Returns Promise<string[]>
the list of worksheet names that have the filter applied
+- applyToWorksheets: string[]
Interface FilterChangedEvent
An event which is related to a particular Worksheet in the workbook.
+interface FilterChangedEvent {
fieldName: string;
sheet: Sheet;
type: TableauEventType;
worksheet: Worksheet;
getFilterAsync(): Promise<Filter>;
}
fieldName: string;
sheet: Sheet;
type: TableauEventType;
worksheet: Worksheet;
getFilterAsync(): Promise<Filter>;
}
Hierarchy (View Summary)
- TableauWorksheetEvent
- FilterChangedEvent
Index
Properties
Methods
Interface FilterOptions
Passed into the applyFilter methods to control advanced filtering options.
+Index
Properties
diff --git a/website/static/api/interfaces/GetSummaryDataOptions.html b/website/static/api/interfaces/GetSummaryDataOptions.html
new file mode 100644
index 00000000..76cb4338
--- /dev/null
+++ b/website/static/api/interfaces/GetSummaryDataOptions.html
@@ -0,0 +1,50 @@
+
Interface GetSummaryDataOptions
Options argument for the Worksheet.GetSummaryDataAsync API
+interface GetSummaryDataOptions {
applyWorksheetFormatting?: boolean;
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
ignoreSelection?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
applyWorksheetFormatting?: boolean;
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
ignoreSelection?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
Hierarchy (View Summary)
- GetSummaryDataOptions
Index
Properties
Optionalapply
applyWorksheetFormatting?: boolean
Specifies whether to apply worksheet level formatting to numbers and dates +Note that this is different from the global field formatting degined in the Schema Viewer
+Optionalcolumns
columnsToIncludeById?: string[]
The columns to return specified by field id, returns all by default. +Since 1.5.0, fieldId is a property of the Column object.
+Optionalignore
ignoreAliases?: boolean
Do not use aliases specified in the data source in Tableau. Default is false.
+Optionalignore
ignoreSelection?: boolean
Only return data for the currently selected marks. Default is false.
+Optionalinclude
Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
+All properties not requested will be undefined in the DataValue results.
+This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
Optionalmax
maxRows?: number
The number of rows of data that you want to return. A value of 0 will attempt to return all rows.
+0 is the default if maxRows is not specified.
+getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows.
+getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.
Interface GetUnderlyingDataOptions
Options argument for the Worksheet.getUnderlyingTableDataAsync API.
+interface GetUnderlyingDataOptions {
applyWorksheetFormatting?: boolean;
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
ignoreSelection?: boolean;
includeAllColumns?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
applyWorksheetFormatting?: boolean;
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
ignoreSelection?: boolean;
includeAllColumns?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
Hierarchy (View Summary)
- GetSummaryDataOptions
- GetUnderlyingDataOptions
Properties
Optionalapply
applyWorksheetFormatting?: boolean
Specifies whether to apply worksheet level formatting to numbers and dates +Note that this is different from the global field formatting degined in the Schema Viewer
+Optionalcolumns
columnsToIncludeById?: string[]
The columns to return specified by field id, returns all by default. +Since 1.5.0, fieldId is a property of the Column object.
+Optionalignore
ignoreAliases?: boolean
Do not use aliases specified in the data source in Tableau. Default is false.
+Optionalignore
ignoreSelection?: boolean
Only return data for the currently selected marks. Default is false.
+Optionalinclude
includeAllColumns?: boolean
Return all the columns for the data source. Default is false.
+Optionalinclude
Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
+All properties not requested will be undefined in the DataValue results.
+This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
Optionalmax
maxRows?: number
The number of rows of data that you want to return. A value of 0 will attempt to return all rows.
+0 is the default if maxRows is not specified.
+getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows.
+getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.
Interface HierarchicalFilter
A Hierarchical Filter +Hierarchical Filters are used when a hierarchical field is used as a filter on a cube database. +As an example, assume a hierarchical field in Product, named ByCategory. +ByCategory has the following five levels: Family, Category, Subcategory, Brand, Sku.
+interface HierarchicalFilter {
appliedValues: HierarchicalFilterDataValue[];
dimensionName: string;
fieldId: string;
fieldName: string;
filterType: FilterType;
hierarchyCaption: string;
isAllSelected: boolean;
levelDetails: HierarchicalLevelDetail[];
numberOfLevels: number;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
appliedValues: HierarchicalFilterDataValue[];
dimensionName: string;
fieldId: string;
fieldName: string;
filterType: FilterType;
hierarchyCaption: string;
isAllSelected: boolean;
levelDetails: HierarchicalLevelDetail[];
numberOfLevels: number;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
Hierarchy (View Summary)
- Filter
- HierarchicalFilter
Index
Properties
Readonlyapplied
Readonlydimension
dimensionName: string
Readonlyfield
fieldId: string
Readonlyfield
fieldName: string
Readonlyfilter
Readonlyhierarchy
hierarchyCaption: string
Readonlyis
isAllSelected: boolean
Readonlylevel
Readonlynumber
numberOfLevels: number
Readonlyworksheet
worksheetName: string
Methods
get
get
Returns Promise<Field>
a promise containing the field for the filter.
+
set
Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
+Parameters
- applyToWorksheets: string[]
list of worksheets to apply the filter on
+
Returns Promise<string[]>
the list of worksheet names that have the filter applied
+- applyToWorksheets: string[]
diff --git a/website/static/api/interfaces/HierarchicalLevelDetail.html b/website/static/api/interfaces/HierarchicalLevelDetail.html
new file mode 100644
index 00000000..b26d59c7
--- /dev/null
+++ b/website/static/api/interfaces/HierarchicalLevelDetail.html
@@ -0,0 +1,30 @@
+
Interface HierarchicalLevelDetail
Details about each level in a hierarchical filter
+interface HierarchicalLevelDetail {
levelSelectionState: HierarchicalLevelSelectionState;
name: string;
}
levelSelectionState: HierarchicalLevelSelectionState;
name: string;
}
Index
Properties
diff --git a/website/static/api/interfaces/LogicalTable.html b/website/static/api/interfaces/LogicalTable.html
new file mode 100644
index 00000000..ce1f6fe3
--- /dev/null
+++ b/website/static/api/interfaces/LogicalTable.html
@@ -0,0 +1,29 @@
+
diff --git a/website/static/api/interfaces/MarkInfo.html b/website/static/api/interfaces/MarkInfo.html
new file mode 100644
index 00000000..5e78de62
--- /dev/null
+++ b/website/static/api/interfaces/MarkInfo.html
@@ -0,0 +1,32 @@
+
diff --git a/website/static/api/interfaces/MarksCollection.html b/website/static/api/interfaces/MarksCollection.html
new file mode 100644
index 00000000..1237db8d
--- /dev/null
+++ b/website/static/api/interfaces/MarksCollection.html
@@ -0,0 +1,31 @@
+
Interface MarksCollection
Represents a collection of marks on a viz. This collection could be +marks that are either selected or highlighted.
+Index
Properties
data
+
Interface MarksSelectedEvent
An event which is raised when marks are selected on a worksheet.
+interface MarksSelectedEvent {
sheet: Sheet;
type: TableauEventType;
worksheet: Worksheet;
getMarksAsync(): Promise<MarksCollection>;
}
sheet: Sheet;
type: TableauEventType;
worksheet: Worksheet;
getMarksAsync(): Promise<MarksCollection>;
}
Hierarchy (View Summary)
- TableauWorksheetEvent
- MarksSelectedEvent
Index
Properties
Methods
Methods
get
Returns Promise<MarksCollection>
The collection of Marks that were selected.
+
Interface MarksSpecification
Index
Properties
Interface Parameter
Represents a parameter in Tableau and provides ways to introspect the parameter and change its values.
+interface Parameter {
allowableValues: ParameterDomainRestriction;
currentValue: DataValue;
dataType: DataType;
id: string;
name: string;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
changeValueAsync(
newValue: string | number | boolean | Date,
): Promise<DataValue>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
}
allowableValues: ParameterDomainRestriction;
currentValue: DataValue;
dataType: DataType;
id: string;
name: string;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
changeValueAsync(
newValue: string | number | boolean | Date,
): Promise<DataValue>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
}
Hierarchy (View Summary)
- EventListenerManager
- Parameter
Index
Properties
Methods
Properties
Readonlyallowable
Readonlycurrent
Readonlydata
Readonlyid
id: string
Readonlyname
name: string
Methods
add
- addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFnAdds a new event listener to the object. If this object does not support the specified
+eventType, +the method throws an exception. +The following table shows the event types supported by objects.+ +
++ + + +object +eventType ++ +Worksheet +FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged+ +Parameter +ParameterChanged+ +Settings +SettingsChanged+ + +Dashboard +DashboardLayoutChanged,WorkbookFormattingChangedParameters
- eventType: TableauEventType
The type of event to register for. The type of event is a
+TableauEventTypeenumeration. - handler: TableauEventHandlerFn
The function which will be called when an event happens.
+
Returns TableauEventUnregisterFn
A helper function which can be called to remove this registration.
+The following example sets up a listener in a worksheet for a mark selection event (
+MarkSelectionChanged). +When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers +the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.
+ +// Add an event listener for the selection changed event on this sheet.
// Assigning the event to a variable just to make the example fit on the page here.
const markSelection = tableau.TableauEventType.MarkSelectionChanged;
//
unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
// When the selection changes, reload the data
loadSelectedMarks(worksheetName);
});
// remove the event listener when done
unregisterEventHandlerFunction();
+ - eventType: TableauEventType
change
Modifies this parameter and assigns it a new value. The new value must fall within +the domain restrictions defined by
+allowableValues. If the domain restriction isParameterValueType.Range, +be sure to check theallowableValuesbefore assigning a new value. If the new value is out of range, the +updated value will be set to either theminValueor themaxValueof the allowable range. If a step size is also specified +and the new value does not fall on the step intervals, the updated value will be set to the closest, lower step, +or closest, earlier date. If the domain restriction is typeParameterValueType.List, and there are aliases defined for the list, +the aliased value should be passed to the method.Parameters
- newValue: string | number | boolean | Date
The new value to assign to this parameter.
++NoteFor changing
+Dateparameters, UTC Date objects are expected.
Returns Promise<DataValue>
The updated
+DataValue. The promise is rejected ifnewValueis invalid. However, if the domain restriction +is typeAllowableValuesType.Range, and thenewValueis out of the range bounds, the parameter gets set to theminValue+or themaxValueof the range (whichever is closer). If the range has astepSizeordateStepPeriod, the parameter gets set +to the closest, lower step, or the closest, earlier date.- newValue: string | number | boolean | Date
remove
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the
+addEventListenermethod. Alternatively, use the function +returned from the call toaddEventListenerto unregister the event listener. +For more information, see Events and Event Handling.Parameters
- eventType: TableauEventType
- handler: TableauEventHandlerFn
Returns boolean
Whether or not an event listener was removed.
+
Interface ParameterChangedEvent
An event which is raised when the value of a parameter changes.
+Hierarchy (View Summary)
- TableauEvent
- ParameterChangedEvent
Index
Properties
type
+
Methods
Interface ParameterDomainRestriction
Represents the allowable set of values which a parameter can be set to.
+interface ParameterDomainRestriction {
allowableValues?: DataValue[];
dateStepPeriod?: PeriodType;
maxValue?: DataValue;
minValue?: DataValue;
stepSize?: number;
type: ParameterValueType;
}
allowableValues?: DataValue[];
dateStepPeriod?: PeriodType;
maxValue?: DataValue;
minValue?: DataValue;
stepSize?: number;
type: ParameterValueType;
}
Index
Properties
Properties
Optional Readonlyallowable
Optional Readonlydate
Returns
If ParameterValueType.Range, this defines the step date period
+used in the Parameter UI control slider. Note that if you specify a new value for the parameter,
+using the changeValueAsync() method, that does not align on the dateStepPeriod interval, the
+value will be set to the closest, earlier date.
Optional Readonlymax
Optional Readonlymin
Optional Readonlystep
stepSize?: number
Returns
If ParameterValueType.Range, the value will
+define the step size used in the parameter UI control slider.
+Note that if you specify a new value for the parameter, using the changeValueAsync() method,
+that does not align on the stepSize interval, the value will be set to the closest, lower interval.
+For example, if the stepSize was 5 and the steps were 1, 5, 10, if the new value specified
+was 8, the value 5 would be used instead.
Readonlytype
diff --git a/website/static/api/interfaces/RangeDomain.html b/website/static/api/interfaces/RangeDomain.html
new file mode 100644
index 00000000..fb60e17f
--- /dev/null
+++ b/website/static/api/interfaces/RangeDomain.html
@@ -0,0 +1,32 @@
+
Interface RangeFilter
A Range Filter
+interface RangeFilter {
fieldId: string;
fieldName: string;
filterType: FilterType;
includeNullValues: boolean;
maxValue: DataValue;
minValue: DataValue;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getDomainAsync(domainType?: FilterDomainType): Promise<RangeDomain>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
fieldId: string;
fieldName: string;
filterType: FilterType;
includeNullValues: boolean;
maxValue: DataValue;
minValue: DataValue;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getDomainAsync(domainType?: FilterDomainType): Promise<RangeDomain>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
Hierarchy (View Summary)
- Filter
- RangeFilter
Index
Properties
Methods
Properties
Readonlyfield
fieldId: string
Readonlyfield
fieldName: string
Readonlyfilter
Readonlyinclude
includeNullValues: boolean
Readonlymax
Readonlymin
Readonlyworksheet
worksheetName: string
Methods
get
get
Parameters
OptionaldomainType: FilterDomainTypethe domain type, defaults to relevant
+
Returns Promise<RangeDomain>
a promise containing the domain for the range filter
+
get
Returns Promise<Field>
a promise containing the field for the filter.
+
set
Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
+Parameters
- applyToWorksheets: string[]
list of worksheets to apply the filter on
+
Returns Promise<string[]>
the list of worksheet names that have the filter applied
+- applyToWorksheets: string[]
Interface RangeFilterOptions
Options for Range Filter
+interface RangeFilterOptions {
max?: number | Date;
min?: number | Date;
nullOption?: FilterNullOption;
}
max?: number | Date;
min?: number | Date;
nullOption?: FilterNullOption;
}
Index
Properties
Interface RangeValue
RangeValue interface to provide selection value for range based selections.
+The associated field should be a quantitative field.
+For Date Values, UTC Date objects are expected. (i.e., var min = new Date(Date.UTC(1999, 0, 1))).
+While date string inputs work, UTC date inputs are officially supported going forward for RangeValue.
Index
Properties
Interface RelativeDateFilter
An abstract base class for all of the filter types.
+interface RelativeDateFilter {
anchorDate: DataValue;
fieldId: string;
fieldName: string;
filterType: FilterType;
periodType: PeriodType;
rangeN: number;
rangeType: DateRangeType;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
anchorDate: DataValue;
fieldId: string;
fieldName: string;
filterType: FilterType;
periodType: PeriodType;
rangeN: number;
rangeType: DateRangeType;
worksheetName: string;
getAppliedWorksheetsAsync(): Promise<string[]>;
getFieldAsync(): Promise<Field>;
setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}
Hierarchy (View Summary)
- Filter
- RelativeDateFilter
Index
Properties
Methods
Properties
Readonlyanchor
Readonlyfield
fieldId: string
Readonlyfield
fieldName: string
Readonlyfilter
Readonlyperiod
Readonlyrange
rangeN: number
Readonlyrange
Readonlyworksheet
worksheetName: string
Methods
get
get
Returns Promise<Field>
a promise containing the field for the filter.
+
set
Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
+Parameters
- applyToWorksheets: string[]
list of worksheets to apply the filter on
+
Returns Promise<string[]>
the list of worksheet names that have the filter applied
+- applyToWorksheets: string[]
Interface RelativeDateFilterOptions
Options for Relative Date Filter
+interface RelativeDateFilterOptions {
anchorDate?: Date;
periodType: PeriodType;
rangeN?: number;
rangeType: DateRangeType;
}
anchorDate?: Date;
periodType: PeriodType;
rangeN?: number;
rangeType: DateRangeType;
}
Index
Properties
Interface SelectionCriteria
SelectionCriteria interface is used to specify to the fieldName to values for Hierarchical, Categorical and Range based selections.
+Properties
Readonlyfield
fieldName: string
Fieldname of the mark that is intended to be selected. +Hierarchical fields follow the convention of "[{parentField}].[{selectingField}]"
+Readonlyvalue
Value that is intended to be selected. This can be specified as the list of values or a single value. +Range-based selections need to provide the value in the format of RangeValue interface. +To select a single quantitative value, use the RangeValue interface where both max and min are the value you want to select.
+Interface Settings
The settings namespace is used to get and set settings +values. You can use the settings to configure your extension. +The setting values are be persisted in a workbook.
+interface Settings {
isModified: boolean;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
erase(key: string): void;
get(key: string): undefined | string;
getAll(): { [key: string]: string };
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
saveAsync(): Promise<{ [key: string]: string }>;
set(key: string, value: string): void;
}
isModified: boolean;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
erase(key: string): void;
get(key: string): undefined | string;
getAll(): { [key: string]: string };
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
saveAsync(): Promise<{ [key: string]: string }>;
set(key: string, value: string): void;
}
Hierarchy (View Summary)
- EventListenerManager
- Settings
Index
Properties
Methods
Properties
Readonlyis
isModified: boolean
Indicates whether or not the settings have been +modified since the last call to saveAsync.
+Methods
add
- addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFnAdds a new event listener to the object. If this object does not support the specified
+eventType, +the method throws an exception. +The following table shows the event types supported by objects.+ +
++ + + +object +eventType ++ +Worksheet +FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged+ +Parameter +ParameterChanged+ +Settings +SettingsChanged+ + +Dashboard +DashboardLayoutChanged,WorkbookFormattingChangedParameters
- eventType: TableauEventType
The type of event to register for. The type of event is a
+TableauEventTypeenumeration. - handler: TableauEventHandlerFn
The function which will be called when an event happens.
+
Returns TableauEventUnregisterFn
A helper function which can be called to remove this registration.
+The following example sets up a listener in a worksheet for a mark selection event (
+MarkSelectionChanged). +When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers +the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.
+ +// Add an event listener for the selection changed event on this sheet.
// Assigning the event to a variable just to make the example fit on the page here.
const markSelection = tableau.TableauEventType.MarkSelectionChanged;
//
unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
// When the selection changes, reload the data
loadSelectedMarks(worksheetName);
});
// remove the event listener when done
unregisterEventHandlerFunction();
+ - eventType: TableauEventType
erase
Erases a settings key / value pair. If key isn't found, nothing happens.
+Parameters
- key: string
The key of the pair to erase.
+
Returns void
- key: string
get
Gets a settings value or undefined if the value does not exist.
+Parameters
- key: string
The key to retrieve.
+
Returns undefined | string
The value or undefined if it does not exist.
+- key: string
get
Returns a copy of all the saved settings keys and values. +Modifying this value will have no effect on the class.
+Returns { [key: string]: string }
All the saved settings keys and values in a dictionary.
+
remove
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the
+addEventListenermethod. Alternatively, use the function +returned from the call toaddEventListenerto unregister the event listener. +For more information, see Events and Event Handling.Parameters
- eventType: TableauEventType
- handler: TableauEventHandlerFn
Returns boolean
Whether or not an event listener was removed.
+
save
Attempts to persist any currently modified settings key-value pairs. The
+saveAsync()method +should only be called in authoring mode.Returns Promise<{ [key: string]: string }>
Promise containing the newly saved settings values.
+
+ +tableau.extensions.settings.saveAsync().then(result => {
console.log('Settings saved.');
// ... process results
}).catch((error) => {
// ...
// ... code for error handling
});
+
set
Adds or updates a settings key / value pair.
+Parameters
- key: string
The key to save.
+ - value: string
The value to save.
+
Returns void
- key: string
Interface SettingsChangedEvent
An event which is raised when the settings of an extension are updated.
+Should be listened for directly from the tableau.extensions.settings object.
Hierarchy (View Summary)
- TableauEvent
- SettingsChangedEvent
Index
Properties
new
Interface Sheet
Interface for handling registering and unregistering event listeners. Different objects will implement +this interface to manage their event handling.
+interface Sheet {
name: string;
sheetType: SheetType;
size: Size;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
getParametersAsync(): Promise<Parameter[]>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
}
name: string;
sheetType: SheetType;
size: Size;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
getParametersAsync(): Promise<Parameter[]>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
}
Hierarchy (View Summary)
Index
Properties
Methods
Methods
add
- addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFnAdds a new event listener to the object. If this object does not support the specified
+eventType, +the method throws an exception. +The following table shows the event types supported by objects.+ +
++ + + +object +eventType ++ +Worksheet +FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged+ +Parameter +ParameterChanged+ +Settings +SettingsChanged+ + +Dashboard +DashboardLayoutChanged,WorkbookFormattingChangedParameters
- eventType: TableauEventType
The type of event to register for. The type of event is a
+TableauEventTypeenumeration. - handler: TableauEventHandlerFn
The function which will be called when an event happens.
+
Returns TableauEventUnregisterFn
A helper function which can be called to remove this registration.
+The following example sets up a listener in a worksheet for a mark selection event (
+MarkSelectionChanged). +When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers +the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.
+ +// Add an event listener for the selection changed event on this sheet.
// Assigning the event to a variable just to make the example fit on the page here.
const markSelection = tableau.TableauEventType.MarkSelectionChanged;
//
unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
// When the selection changes, reload the data
loadSelectedMarks(worksheetName);
});
// remove the event listener when done
unregisterEventHandlerFunction();
+ - eventType: TableauEventType
find
Searches for a parameter with the given name.
+Parameters
- parameterName: string
The name of the parameter to find.
+
Returns Promise<undefined | Parameter>
The parameter with the given name, or undefined if it does not exist.
+- parameterName: string
get
Returns Promise<Parameter[]>
A collection of all the Tableau parameters that are used in this workbook.
+
remove
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the
+addEventListenermethod. Alternatively, use the function +returned from the call toaddEventListenerto unregister the event listener. +For more information, see Events and Event Handling.Parameters
- eventType: TableauEventType
- handler: TableauEventHandlerFn
Returns boolean
Whether or not an event listener was removed.
+
diff --git a/website/static/api/interfaces/SummaryDataChangedEvent.html b/website/static/api/interfaces/SummaryDataChangedEvent.html
new file mode 100644
index 00000000..2bcdeded
--- /dev/null
+++ b/website/static/api/interfaces/SummaryDataChangedEvent.html
@@ -0,0 +1,33 @@
+
Interface SummaryDataChangedEvent
An event which is raised when summary data is changed for a worksheet or when a worksheet's data source is refreshed
+Hierarchy (View Summary)
- TableauWorksheetEvent
- SummaryDataChangedEvent
Interface TableSummary
Represents a table of data in a data source.
+interface TableSummary {
connectionId: string;
customSQL: undefined | string;
id: string;
name: string;
}
connectionId: string;
customSQL: undefined | string;
id: string;
name: string;
}
Index
Properties
diff --git a/website/static/api/interfaces/TableauEvent.html b/website/static/api/interfaces/TableauEvent.html
new file mode 100644
index 00000000..99a83898
--- /dev/null
+++ b/website/static/api/interfaces/TableauEvent.html
@@ -0,0 +1,29 @@
+
Interface TableauEvent
An event object represents a notification that some sort of state has changed. +This is the base event interface. All events will inherit this type.
+Hierarchy (View Summary)
Index
Properties
type
+
Interface TableauSheetEvent
An event which is related to a particular Sheet (worksheet, dashboard, story) in the workbook.
+Hierarchy (View Summary)
- TableauEvent
- TableauSheetEvent
Interface TableauWorksheetEvent
An event which is related to a particular Worksheet in the workbook.
+Hierarchy (View Summary)
diff --git a/website/static/api/interfaces/UI.html b/website/static/api/interfaces/UI.html
new file mode 100644
index 00000000..2ea2b027
--- /dev/null
+++ b/website/static/api/interfaces/UI.html
@@ -0,0 +1,88 @@
+
Interface UI
The UI namespace contains methods that allow an extension to display a popup
+dialog window. A modal dialog can be useful in authentication or configuration scenarios,
+or when extra situational UI space is needed. Only one dialog can be displayed at a time per extension.
+Inside the popup dialog window, another extension can be loaded and run. This dialog extension will have full access
+to the functions provided by the Extensions API. One difference between the extension running in the popup dialog window
+and an extension running in the dashboard is that the popup dialog window must call
+the initializeDialogAsync() method instead of initializeAsync() to initialize the extension.
Note If you want to use a popup dialog window on Tableau Server, you need to let users know that their browser must be +configured to allow popups.
+interface UI {
closeDialog(payload?: string, dialogUrl?: string): void;
displayDialogAsync(
url: string,
payload?: string,
dialogOptions?: DialogOptions,
): Promise<string>;
sendDialogMessageAsync(message: string, targetDialogUrl?: string): any;
sendDialogMessageToParentAsync(message: string): any;
}
closeDialog(payload?: string, dialogUrl?: string): void;
displayDialogAsync(
url: string,
payload?: string,
dialogOptions?: DialogOptions,
): Promise<string>;
sendDialogMessageAsync(message: string, targetDialogUrl?: string): any;
sendDialogMessageToParentAsync(message: string): any;
}
Methods
close
Closes the extension's dialog. Can be called from the popup dialog or from the extension itself.
+Parameters
Optionalpayload: stringThe
+payloadis optional, and if specified, it is made available to parent extension when +this popup dialog closes. If the extension running in the popup dialog window does not return +a payload, you must still provide an empty string" "as a return value.OptionaldialogUrl: stringSpecifies the url of the dialog to close. +If the method is called from a dialog, and the dialogUrl is not specified, this will close the current dialog. +If the method is called from an extension, and the dialogUrl is not specified, this will close all open dialogs.
+
+ +tableau.extensions.ui.closeDialog('myPayload string');
+The following example shows a call to the closeDialog method when the dialog extension does not return a payload.
+
+ +// specify an empty string if no payload is returned
tableau.extensions.ui.closeDialog(''); +
Returns void
display
Parameters
- url: string
The url of the 'dialog extension' to navigate to in the dialog. The url must +belong to the same domain as the parent extension.
+ Optionalpayload: stringThe
+payloadis optional, and is used to provide data to the popup dialog window +at startup. Thepayloadwill be returned to the dialog extension as the return +value of the call to thetableau.extensions.ui.initializeDialogAsyncfunction. +If nopayloadis provided, you must indicate this with an empty string" ".OptionaldialogOptions: DialogOptionsSpecifies the options for the popup dialog window. +The
+dialogOptionshas properties for width and height (in pixels) and a property for the dialog's style. +The dialog style can be a window, a modal dialog, or a modeless dialog. If style is not specified, window will be used. +You pass these properties to thedisplayDialogAsyncfunction, as follows: +{width:number, height:number, dialogStyle:DialogStyle}
Returns Promise<string>
A promise that resolves when the dialog has been closed. It will contain a +payload as a string provided by the dialog extension. The promise is rejected if +the user manually closes the dialog window (for example, by clicking the 'X' in window). +It is good practice to handle this error condition with a catch block, as in the following example.
+
+ +tableau.extensions.ui.displayDialogAsync(popupUrl, defaultPayload, { width: 500, height: 500 }).then((closePayload) => {
//
// The promise is resolved when the dialog has been closed as expected, meaning that
// the popup extension has called tableau.extensions.ui.closeDialog() method.
// The close payload (closePayload) is returned from the popup extension
// via the closeDialog() method.
//
}).catch((error) => {
// One expected error condition is when the popup is closed by the user (meaning the user
// clicks the 'X' in the top right of the dialog). This can be checked for like so:
switch(error.errorCode) {
case tableau.ErrorCodes.DialogClosedByUser:
console.log("Dialog was closed by user");
break;
default:
console.error(error.message);
}
}); +Since
1.3.0 A relative path may be used beginning with Tableau 2019.3 and version 1.3.0 of the Extensions API library. +The relative path must resolve to the directory, or a child directory, of the extension. +Root-relative paths are not allowed. For example,
+./config.htmlorconfig.htmlare allowed, +but not the root-relative path/config.html. +Note If your extension is meant for use in versions of Tableau prior to 2019.3, +you should use an absolute url.- url: string
send
ExperimentalSends a message from the dialog to the host extension or vice versa. +For dialogs sending messages to extensions, we must listen for the DialogMessageEvent in the extension in order to receive the message. +For extensions sending messages to dialog, we must listen for the DialogMessageEvent in the dialog code in order to receive the message. +For two way communication, listen for the DialogMessageEvent in both the dialog and extension code.
+Parameters
- message: string
A message to send.
+ OptionaltargetDialogUrl: stringThe url of the dialog to send the message to. If not provided, the message will be sent to the parent extension.
+
+ +
// Sending a message from the dialog to the extension:
// extension code (listening for messages originating from the dialog)
tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => {
console.log('Message received from dialog: ' + e.message);
})
tableau.extensions.ui.displayDialogAsync(popupUrl);
...
// dialog code (sending message to extension)
await tableau.extensions.initializeDialogAsync();
await tableau.extensions.ui.sendDialogMessageAsync('Hello from dialog!');
// Sending a message from the extension to the dialog:
// dialog code (listening for messages originating from the extension)
await tableau.extensions.initializeDialogAsync();
tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => {
console.log('Message received from extension: ' + e.message);
})
...
// extension code (sending message to dialog)
tableau.extensions.ui.displayDialogAsync(popupUrl);
// waiting a bit for dialog to appear before sending message.
// notice the intentional omission of await in calls to displayDialogAsync.
// that's because if we await, we wont run any code after that line until the dialog closes and the promise returns.
setTimeout(() => tableau.extensions.ui.sendDialogMessageAsync('Hello from extension!', popupUrl), 1000); +
Returns any
- message: string
send
ExperimentalSends a message from the dialog to the extension or dialog that opened it. +This only works if called from the dialog.
+Parameters
- message: string
A message to send.
+
Returns any
- message: string
Interface VisualSpecification
interface VisualSpecification {
activeMarksSpecificationIndex: number;
columnFields: FieldInstance[];
marksSpecifications: MarksSpecification[];
rowFields: FieldInstance[];
}
activeMarksSpecificationIndex: number;
columnFields: FieldInstance[];
marksSpecifications: MarksSpecification[];
rowFields: FieldInstance[];
}
Index
Properties
Interface Workbook
The Workbook represents the currently open workbook.
Index
Methods
Methods
get
Gets the data sources for this workbook. Note that calling this method might negatively impact performance +and responsiveness of the viz that your extension is added to. The method is not entirely +asynchronous and includes some serial operations.
+Returns Promise<DataSource[]>
All data sources used in this workbook.
+
diff --git a/website/static/api/interfaces/WorkbookFormattingChangedEvent.html b/website/static/api/interfaces/WorkbookFormattingChangedEvent.html
new file mode 100644
index 00000000..a43c5d7c
--- /dev/null
+++ b/website/static/api/interfaces/WorkbookFormattingChangedEvent.html
@@ -0,0 +1,30 @@
+
Interface WorkbookFormattingChangedEvent
An event which is related to a workbook's formatting (worksheet, dashboard, story) in the workbook.
+Hierarchy (View Summary)
- TableauEvent
- WorkbookFormattingChangedEvent
Index
Properties
formatting
+type
+
Interface Worksheet
Interface for handling registering and unregistering event listeners. Different objects will implement +this interface to manage their event handling.
+interface Worksheet {
backgroundColor: string;
formatting: WorksheetFormatting;
name: string;
parentDashboard: Dashboard;
sheetType: SheetType;
size: Size;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
annotateMarkAsync(mark: MarkInfo, annotationText: string): Promise<void>;
applyFilterAsync(
fieldName: string,
values: string[],
updateType: FilterUpdateType,
filterOptions: FilterOptions,
): Promise<string>;
applyHierarchicalFilterAsync(
fieldName: string,
values: string[] | HierarchicalLevels,
updateType: FilterUpdateType,
options: FilterOptions,
): Promise<string>;
applyRangeFilterAsync(
fieldName: string,
filterOptions: RangeFilterOptions,
): Promise<string>;
applyRelativeDateFilterAsync(
fieldName: string,
options: RelativeDateFilterOptions,
): Promise<string>;
clearFilterAsync(fieldName: string): Promise<string>;
clearSelectedMarksAsync(): Promise<void>;
findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
getAnnotationsAsync(): Promise<Annotation[]>;
getDataSourcesAsync(): Promise<DataSource[]>;
getFiltersAsync(): Promise<Filter[]>;
getHighlightedMarksAsync(): Promise<MarksCollection>;
getParametersAsync(): Promise<Parameter[]>;
getSelectedMarksAsync(): Promise<MarksCollection>;
getSummaryColumnsInfoAsync(): Promise<Column[]>;
getSummaryDataAsync(options?: GetSummaryDataOptions): Promise<DataTable>;
getSummaryDataReaderAsync(
pageRowCount?: number,
options?: GetSummaryDataOptions,
): Promise<DataTableReader>;
getTooltipTextAsync(tupleId: number): Promise<String>;
getUnderlyingDataAsync(
options?: GetUnderlyingDataOptions,
): Promise<DataTable>;
getUnderlyingTableDataAsync(
logicalTableId: string,
options?: GetUnderlyingDataOptions,
): Promise<DataTable>;
getUnderlyingTableDataReaderAsync(
logicalTableId: string,
pageRowCount?: number,
options?: GetUnderlyingDataOptions,
): Promise<DataTableReader>;
getUnderlyingTablesAsync(): Promise<LogicalTable[]>;
getVisualSpecificationAsync(): Promise<VisualSpecification>;
hoverTupleAsync(
hoveredTuple: number,
tooltip?: null | TooltipContext,
allowHoverActions?: boolean,
): Promise<void>;
leaveMarkNavigationAsync(): Promise<void>;
removeAnnotationAsync(annotation: Annotation): Promise<void>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
selectMarksByValueAsync(
selectionCriteria: SelectionCriteria[],
updateType: SelectionUpdateType,
): Promise<void>;
selectTuplesAsync(
selectedTuples: number[],
selectOption: SelectOptions,
tooltip?: TooltipContext,
): Promise<void>;
}
backgroundColor: string;
formatting: WorksheetFormatting;
name: string;
parentDashboard: Dashboard;
sheetType: SheetType;
size: Size;
addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFn;
annotateMarkAsync(mark: MarkInfo, annotationText: string): Promise<void>;
applyFilterAsync(
fieldName: string,
values: string[],
updateType: FilterUpdateType,
filterOptions: FilterOptions,
): Promise<string>;
applyHierarchicalFilterAsync(
fieldName: string,
values: string[] | HierarchicalLevels,
updateType: FilterUpdateType,
options: FilterOptions,
): Promise<string>;
applyRangeFilterAsync(
fieldName: string,
filterOptions: RangeFilterOptions,
): Promise<string>;
applyRelativeDateFilterAsync(
fieldName: string,
options: RelativeDateFilterOptions,
): Promise<string>;
clearFilterAsync(fieldName: string): Promise<string>;
clearSelectedMarksAsync(): Promise<void>;
findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
getAnnotationsAsync(): Promise<Annotation[]>;
getDataSourcesAsync(): Promise<DataSource[]>;
getFiltersAsync(): Promise<Filter[]>;
getHighlightedMarksAsync(): Promise<MarksCollection>;
getParametersAsync(): Promise<Parameter[]>;
getSelectedMarksAsync(): Promise<MarksCollection>;
getSummaryColumnsInfoAsync(): Promise<Column[]>;
getSummaryDataAsync(options?: GetSummaryDataOptions): Promise<DataTable>;
getSummaryDataReaderAsync(
pageRowCount?: number,
options?: GetSummaryDataOptions,
): Promise<DataTableReader>;
getTooltipTextAsync(tupleId: number): Promise<String>;
getUnderlyingDataAsync(
options?: GetUnderlyingDataOptions,
): Promise<DataTable>;
getUnderlyingTableDataAsync(
logicalTableId: string,
options?: GetUnderlyingDataOptions,
): Promise<DataTable>;
getUnderlyingTableDataReaderAsync(
logicalTableId: string,
pageRowCount?: number,
options?: GetUnderlyingDataOptions,
): Promise<DataTableReader>;
getUnderlyingTablesAsync(): Promise<LogicalTable[]>;
getVisualSpecificationAsync(): Promise<VisualSpecification>;
hoverTupleAsync(
hoveredTuple: number,
tooltip?: null | TooltipContext,
allowHoverActions?: boolean,
): Promise<void>;
leaveMarkNavigationAsync(): Promise<void>;
removeAnnotationAsync(annotation: Annotation): Promise<void>;
removeEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): boolean;
selectMarksByValueAsync(
selectionCriteria: SelectionCriteria[],
updateType: SelectionUpdateType,
): Promise<void>;
selectTuplesAsync(
selectedTuples: number[],
selectOption: SelectOptions,
tooltip?: TooltipContext,
): Promise<void>;
}
Hierarchy (View Summary)
- Sheet
- Worksheet
Index
Properties - All Extensions
Properties - Dashboard Extensions
Properties - Viz Extensions
Methods - All Extensions
add
Methods - Viz Extensions
Methods - All Extensions
add
- addEventListener(
eventType: TableauEventType,
handler: TableauEventHandlerFn,
): TableauEventUnregisterFnAdds a new event listener to the object. If this object does not support the specified
+eventType, +the method throws an exception. +The following table shows the event types supported by objects.+ +
++ + + +object +eventType ++ +Worksheet +FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged+ +Parameter +ParameterChanged+ +Settings +SettingsChanged+ + +Dashboard +DashboardLayoutChanged,WorkbookFormattingChangedParameters
- eventType: TableauEventType
The type of event to register for. The type of event is a
+TableauEventTypeenumeration. - handler: TableauEventHandlerFn
The function which will be called when an event happens.
+
Returns TableauEventUnregisterFn
A helper function which can be called to remove this registration.
+The following example sets up a listener in a worksheet for a mark selection event (
+MarkSelectionChanged). +When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers +the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.
+ +// Add an event listener for the selection changed event on this sheet.
// Assigning the event to a variable just to make the example fit on the page here.
const markSelection = tableau.TableauEventType.MarkSelectionChanged;
//
unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
// When the selection changes, reload the data
loadSelectedMarks(worksheetName);
});
// remove the event listener when done
unregisterEventHandlerFunction();
+ - eventType: TableauEventType
annotate
Add an annotation to the specified mark. +This is intended to be passed a MarkInfo object received from a DataTable. +MarkInfo can be found in the DataTable returned from getSelectedMarksAsync or getHighlightedMarksAsync.
+Parameters
- mark: MarkInfo
The mark to annotate.
+ - annotationText: string
The text to display in the annotation.
+
Returns Promise<void>
Empty promise that resolves when the annotation is complete.
+Since
1.10.0 and Tableau 2022.4
+The following example shows how you might call this method using a MarkInfo object.
+
+ +const markCollection = await worksheet.getSelectedMarksAsync();
const markToAnnotate = marksCollection.data[0].marksInfo[0];
await worksheet.annotateMarkAsync(markToAnnotate, 'Manufacturing line #2 shutdown triggered'); +- mark: MarkInfo
apply
- applyFilterAsync(
fieldName: string,
values: string[],
updateType: FilterUpdateType,
filterOptions: FilterOptions,
): Promise<string>Applies the list of provided categorical filter values.
+Parameters
- fieldName: string
The name of the field to filter on.
+ - values: string[]
The list of values to filter on.
+ - updateType: FilterUpdateType
The update type of this filter (add, all, remove, replace).
+ - filterOptions: FilterOptions
Advanced filter options (isExcludeMode).
+
Returns Promise<string>
The field name that the filter is applied on.
+ - fieldName: string
apply
- applyHierarchicalFilterAsync(
fieldName: string,
values: string[] | HierarchicalLevels,
updateType: FilterUpdateType,
options: FilterOptions,
): Promise<string>Applies the list of provided hierarchial filter values.
+Parameters
- fieldName: string
The name of the field to filter on.
+ - values: string[] | HierarchicalLevels
The list of values or levels to filter on.
+ - updateType: FilterUpdateType
The update type of this filter (add, all, remove, replace).
+ - options: FilterOptions
Returns Promise<string>
The field name that the filter is applied on.
+ - fieldName: string
apply
Applies a range filter to a quantitative or date field.
+Parameters
- fieldName: string
The name of the field to filter on
+ - filterOptions: RangeFilterOptions
Filter Options: min, max, nullOption. At least one of of min and max is required. +For applying date filters, UTC Date objects are expected (that is,
+var min = new Date(Date.UTC(1999, 0, 1))).
Returns Promise<string>
The field name that the filter is applied on.
+- fieldName: string
apply
- applyRelativeDateFilterAsync(
fieldName: string,
options: RelativeDateFilterOptions,
): Promise<string>Applies a relative date filter.
+Parameters
- fieldName: string
The name of the field to filter on.
+ - options: RelativeDateFilterOptions
The relative date filter options (anchorDate, periodType, rangeType, rangeN). When the rangeType is LASTN or NEXTN, the rangeN is required.
+
Returns Promise<string>
The field name that the filter is applied on.
+Since
version 1.9.0 and Tableau 2022.2
+The following example shows how to apply a relative date filter from a worksheet.
+
+ +worksheet.applyRelativeDateFilterAsync(
'Order Date',
{
anchorDate: new Date(Date.UTC(2022, 4, 13)),
periodType: PeriodType.Years,
rangeType: DateRangeType.LastN,
rangeN: 1,
}
); + - fieldName: string
clear
Resets existing filters on the given field. +Categorical filters are reset to "All," and range filters are reset to the full range +Relative date filters can not be reset, consider using the applyRelativeDateFilterAsync API.
+Parameters
- fieldName: string
The name of the field to clear filter on.
+
Returns Promise<string>
The field to clear filter on.
+- fieldName: string
clear
Clears selected marks in the current worksheet.
+Returns Promise<void>
Empty promise that resolves when the selection has been cleared.
+The following example assumes that you have some marks already selected in the worksheet. After it has run, +you should have no marks selected, and you should see the console message.
+
+ +worksheet.clearSelectedMarksAsync().then(function () {
console.log('Your marks selection has been cleared!');
}) +
find
Searches for a parameter with the given name.
+Parameters
- parameterName: string
The name of the parameter to find.
+
Returns Promise<undefined | Parameter>
The parameter with the given name, or undefined if it does not exist.
+- parameterName: string
get
Retrieves a list of the annotations in the worksheet.
+Returns Promise<Annotation[]>
A list annotations in the worksheet.
+
get
Gets the data sources for this worksheet. Note that calling this method might negatively impact performance +and responsiveness of the viz that your extension is added to. The method is not entirely +asynchronous and includes some serial operations.
+Returns Promise<DataSource[]>
The primary data source and all of the secondary data sources for this worksheet. +By convention the first data source in the array is the primary.
+The following example shows how you might find a specific data source of a worksheet, +using the
+getDataSourcesAsync()method. The example then chains the data source returned in the promise +to a call to thegetUnderlyingDataAsync()method to access the data table.
+ +worksheet.getDataSourcesAsync().then(datasources => {
dataSource = datasources.find(datasource => datasource.name === "Sample - Superstore");
return dataSource.getUnderlyingDataAsync();
}).then(dataTable => {
// process the dataTable...
});
+
get
Gets the list of filters on a worksheet. Hierarchical filters are not yet supported
+Returns Promise<Filter[]>
A promise that resolves to the collection of filters used in this worksheet.
+
get
Gets the data for the marks which are currently highlighted on the worksheet. +If there are no marks currently highlighted, an empty model is returned.
+Returns Promise<MarksCollection>
The marks which are selected.
+
get
Returns Promise<Parameter[]>
A collection of all the Tableau parameters that are used in this workbook.
+
get
Gets the data for the marks which are currently selected on the worksheet. +If there are no marks currently selected, an empty model is returned.
+Returns Promise<MarksCollection>
The marks that are selected.
+
+ +// Call to get the selected marks for the worksheet
worksheet.getSelectedMarksAsync().then(function (marks) {
// Get the first DataTable for our selected marks (usually there is just one)
const worksheetData = marks.data[0];
// Map the data into a format for display, etc.
}); +
get
Gets the columns that are returned with
+getSummaryDataAsync.Returns Promise<Column[]>
The array of columns that describe the data in the worksheet.
+
get
Gets the summary data table for this worksheet. +Warning: getSummaryDataAsync can fail with a worksheet with many rows of data and is now deprecated.
+Parameters
Optionaloptions: GetSummaryDataOptionsCollection of options to change the behavior of the call.
+
Returns Promise<DataTable>
A data table containing the summary data for the worksheet.
+Deprecated
since 1.10.0 Use getSummaryDataReaderAsync to avoid failures with many rows of data.
++Note+The
+getSummaryDataAsyncandgetSummaryDataReaderAsyncmethods return the data that is currently +in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is +the underlying data without the additional fields and processing you have added in Tableau, use +the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.The following example shows how to replace unsafe usage of
+getSummaryDataAsyncwith +getSummaryDataReaderAsyncandgetAllPagesAsync, assuming you have less than 4,000,000 +rows of data. +
+ + +const dataTableReader = await worksheet.getSummaryDataReaderAsync();
const dataTable = await dataTableReader.getAllPagesAsync();
await dataTableReader.releaseAsync();
// ... process data table ... +The following example shows how to replace unsafe usage of
+ +getSummaryDataAsyncwith +getSummaryDataReaderAsyncandgetPageAsyncand work with individual +pages.
+ +const dataTableReader = await worksheet.getSummaryDataReaderAsync();
for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
const dataTablePage = await dataTableReader.getPageAsync(currentPage);
// ... process current page ....
}
await dataTableReader.releaseAsync(); +
get
- getSummaryDataReaderAsync(
pageRowCount?: number,
options?: GetSummaryDataOptions,
): Promise<DataTableReader>Gets a summary data table reader for this worksheet. +Only one active DataTableReader for summary data is supported.
++Note+The
+getSummaryDataAsyncandgetSummaryDataReaderAsyncmethods return the data that is currently +in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is +the underlying data without the additional fields and processing you have added in Tableau, use +the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.Parameters
OptionalpageRowCount: numberThe number of rows per page. The default and maximum is 10,000 rows.
+Optionaloptions: GetSummaryDataOptionsCollection of options to change the behavior of the reader.
+
Returns Promise<DataTableReader>
A data table reader to access the summary data for the worksheet.
+The following example shows the methods to get and use the summary data reader for all rows in a worksheet.
+
+ +const dataTableReader = await worksheet.getSummaryDataReaderAsync();
for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
let dataTablePage = await dataTableReader.getPageAsync(currentPage);
// ... process current page ....
}
await dataTableReader.releaseAsync(); +
get
Gets the underlying data table for this worksheet.
+Parameters
Optionaloptions: GetUnderlyingDataOptionsCollection of options to change the behavior of the call.
+
Returns Promise<DataTable>
A data table containing the underlying data for the worksheet.
+Deprecated
Use Worksheet.getUnderlyingTableDataReaderAsync or Worksheet.getUnderlyingTableDataAsync.
+
get
- getUnderlyingTableDataAsync(
logicalTableId: string,
options?: GetUnderlyingDataOptions,
): Promise<DataTable>Gets the underlying data table for the given logical table id. +Use the
+getUnderlyingTablesAsyncmethod to identify the logical tables.Parameters
- logicalTableId: string
logical table id.
+ Optionaloptions: GetUnderlyingDataOptionsCollection of options to change the behavior of the call.
+
Returns Promise<DataTable>
A data table containing the underlying data for the given logical table id
+Since
1.4.0
++Note+Use the
+getUnderlyingTableDataAsyncmethod to access the full data, that is the underlying +data without the parameters, calculated fields, and processing you might have added in Tableau. +To access just the data that is currently in the viz, with parameters, +calculated fields, and sorting applied, use the Worksheet.getSummaryDataAsync and +Worksheet.getSummaryDataReaderAsync methods.You can use the
+getUnderlyingDataOptions.maxRowsproperty to request the number of rows of data to return. +If unspecified (maxRows == '0'), the call togetUnderlyingTableDataAsyncrequests all rows in the logical table. +Note that the maximum number of rows returned from thegetUnderlyingTableDataAsync()method is limited +to 10,000 rows. You can use theDataTableproperty,isTotalRowCountLimited, to test whether there is +more data. A value of true indicates that the calling function requested more rows than the limit (10,000) and the +underlying data source contains more rows than can be returned. - logicalTableId: string
get
- getUnderlyingTableDataReaderAsync(
logicalTableId: string,
pageRowCount?: number,
options?: GetUnderlyingDataOptions,
): Promise<DataTableReader>Gets a underlying data table reader for the given logical table id. +Use the
+getUnderlyingTablesAsyncmethod to identify the logical tables. +Only one active DataTableReader per logical table id is supported.+Note+Use the
+getUnderlyingTableDataReaderAsyncmethod to access the full data, that is +the underlying data without the parameters, calculated fields, and processing you might +have added in Tableau. To access just the data that is currently in the viz, with parameters, +calculated fields, and sorting applied use the Worksheet.getSummaryDataAsync and +Worksheet.getSummaryDataReaderAsync methods.The
+getUnderlyingTableDataReaderAsyncmethod attempts to prepare all the rows of the underlying table to be read as pages. +However, there is a limit to the number of rows that can be prepared. The default limit is 1 million rows of data. +You can change the default limit with the Tableau Server (Cloud) or Tableau Desktop option: ExtensionsAndEmbeddingReaderRowLimit. +If the underlying table has many columns,getUnderlyingTableDataReaderAsynccan be sped up by only requesting +native data values in the GetUnderlyingDataOptions.Parameters
- logicalTableId: string
logical table id.
+ OptionalpageRowCount: numberThe number of rows per page. The default and maximum is 10,000 rows.
+Optionaloptions: GetUnderlyingDataOptionsCollection of options to change the behavior of the reader.
+
Returns Promise<DataTableReader>
A data table reader to access the underlying data for the given logical table id.
+The following example shows getting the first page of underlying data.
+
+ +// Call to get the underlying logical tables used by the worksheet
const underlyingTablesData = await worksheet.getUnderlyingTablesAsync();
const logicalTableId = underlyingTablesData[0].id;
// Use the above logicalTableId to get the underlying data reader on the active sheet
const dataTableReader = await worksheet.getUnderlyingTableDataReaderAsync(logicalTableId);
const page = await dataTableReader.getPageAsync(0);
// ... process first page of data table ...
await dataTableReader.releaseAsync(); + - logicalTableId: string
get
Gets the underlying logical tables used by the worksheet. The resulting logical tables are determined by the measures in the worksheet. +If a worksheet's data source contains multiple logical tables and the worksheet contains only measures from one logical table, this API +will return one logical table.
+Returns Promise<LogicalTable[]>
An array of logical tables corresponding to the measures referenced by the worksheet.
+
+ +// Call to get the underlying logical tables used by the worksheet
worksheet.getUnderlyingTablesAsync().then(function (logicalTables) {
// Get the first logical table's id
const logicalTableId = logicalTables[0].id;
// Use the above logicalTableId to then get worksheet's underlying data
// by calling worksheet.getUnderlyingTableDataAsync(logicalTableId)
}); +
get
Returns the visual specification for the worksheet, which can be used to get +the mappings from fields to encodings backing the visual within the worksheet
+Returns Promise<VisualSpecification>
Promise containing the VisualSpecification
+
remove
Removes the corresponding annotation from the worksheet it belongs to. +This is intended to be passed a Annotation object received from getAnnotationsAsync.
+Parameters
- annotation: Annotation
The annotation to remove.
+
Returns Promise<void>
Empty promise that resolves when the annotation is removed.
+- annotation: Annotation
remove
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the
+addEventListenermethod. Alternatively, use the function +returned from the call toaddEventListenerto unregister the event listener. +For more information, see Events and Event Handling.Parameters
- eventType: TableauEventType
- handler: TableauEventHandlerFn
Returns boolean
Whether or not an event listener was removed.
+
select
- selectMarksByValueAsync(
selectionCriteria: SelectionCriteria[],
updateType: SelectionUpdateType,
): Promise<void>Selects the marks specified by value using the SelectionCriteria interface. +This is intended for manual construction of the desired selections.
+Parameters
- selectionCriteria: SelectionCriteria[]
A list of criteria for which marks to select.
+ - updateType: SelectionUpdateType
The type of selection to make: add, remove, or replace.
+
Returns Promise<void>
Empty promise that resolves when the selection is complete.
+Since
1.10.0 Errors will now be thrown for invalid fields or values.
+ +The following example shows how you might call this method using state names as the
+SelectionCriteria. +TheSelectionUpdateTypeis replace (tableau.SelectionUpdateType.Replace), so these values replace +the marks that are currently selected.
+ +worksheet.selectMarksByValueAsync([{
fieldName: 'State',
value: ['Texas', 'Washington', 'California']
}], tableau.SelectionUpdateType.Replace );
+ - selectionCriteria: SelectionCriteria[]
Methods - Viz Extensions
get
Method to get the text of the tooltip that would be displayed for a given tuple id. Currently supported for web only.
+You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. +For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.
+Passing in an invalid tuple id will not throw. +
+
+ +let navigatedTuple = -1;
let updateScreenReaderElement = (screenReadertext) => {
// updates an element to be read out by screen readers
};
let updateNavigatedTuple = (keyboardEvent) => {
switch (keyboardEvent.key) {
case 'ArrowLeft':
navigatedTuple = navigatedTuple - 1;
break;
case 'ArrowRight':
navigatedTuple = navigatedTuple + 1;
break;
default:
break;
}
// do any work to show visual indication of a mark being navigated to
};
svg.on('keydown', (keyboardEvent) => {
updateNavigatedTuple(keyboardEvent);
tableau.extensions.worksheetContent.worksheet
.getTooltipTextAsync(navigatedTuple)
.then((response) => {
console.log(response.result);
updateScreenReaderElement(response.result);
})
.catch((error) => console.log('Failed to get tooltip text because of: ', error));
}); +Parameters
- tupleId: number
Returns Promise<String>
Returns promise that resolves to a string describing the tooltip text for a given tuple id and rejects on error
+
hover
- hoverTupleAsync(
hoveredTuple: number,
tooltip?: null | TooltipContext,
allowHoverActions?: boolean,
): Promise<void>Method to execute hover actions and render tooltip for a given tuple representing a mark in the visualization. +If the tooltip parameter is included it will show the tooltip when the mark is hovered over. +If null or no tooltip parameter is passed, no tooltip is shown. +Hover actions are run by default, but passing false for the allowHoverActions parameter will prevent their execution.
+The
+hoveredTupleparameter is a tuple id. You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. +For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.Passing in an invalid tuple id will not throw and will clear the tooltip. +
+
+ +svg.on('mousemove', (mouseEvent) => {
const myHoveredTuple = 10;
tableau.extensions.worksheetContent.worksheet.hoverTupleAsync(myHoveredTuple, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } })
.then(() => console.log('Done'))
.catch((error) => console.log('Failed to hover because of: ', error));
}); +Parameters
- hoveredTuple: number
Optionaltooltip: null | TooltipContextOptionalallowHoverActions: boolean
Returns Promise<void>
Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error
+
leave
Notifies the scene of a desire to leave mark-level keyboard navigation and return to scene-level keyboard navigation. +Used when implementing keyboard navigation within a visualization, an integral part of building accessibility into a visualization. +Currently supported for the web only. +
+
+ +svg.on('keyup', (keyboardEvent) => {
if (keyboardEvent.key == "Escape") {
tableau.extensions.worksheetContent.worksheet
.leaveMarkNavigationAsync()
.then(() => console.log('Done'))
.catch((error) => console.log('Failed to leave mark-level keyboard navigation because of: ', error));
}
}); +Returns Promise<void>
Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error
+
select
- selectTuplesAsync(
selectedTuples: number[],
selectOption: SelectOptions,
tooltip?: TooltipContext,
): Promise<void>Method to modify selection, execute select actions, and render tooltip for a given list of tuples representing a mark or marks in the visualization. +If the tooltip parameter is included it will show the tooltip when the mark or marks are selected. If not, no tooltip is shown.
+The
+selectedTuplesparameter is an array of tuple ids. You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. +For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.Passing in an invalid tuple id will not throw and will clear the tooltip. +
+
+ +svg.on('click', (mouseEvent) => {
const myClickedTuples = [10];
const ctrlKeyPressed = !!mouseEvent.ctrlKey;
const selectOption = ctrlKeyPressed ? tableau.SelectOptions.Toggle : tableau.SelectOptions.Simple;
tableau.extensions.worksheetContent.worksheet.selectTuplesAsync(myClickedTuples, selectOption, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } })
.then(() => console.log('Done'))
.catch((error) => console.log('Failed to select because of: ', error));
}); +Parameters
- selectedTuples: number[]
- selectOption: SelectOptions
Optionaltooltip: TooltipContext
Returns Promise<void>
Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error
+
Interface WorksheetContent
The WorksheetContent namespace is the namespace associated with Viz Extensions.
+The WorksheetContent namespace contains the Worksheet interface. Use the Worksheet Interface to
+access worksheet objects and to add or remove event listeners.
Index
Properties
Interface WorksheetFormattingChangedEvent
An event raised when the worksheet's formatting changes. +Note that this event is also raised when the workbook's formatting changes.
+interface WorksheetFormattingChangedEvent {
formatting: WorksheetFormatting;
sheet: Sheet;
type: TableauEventType;
worksheet: Worksheet;
}
formatting: WorksheetFormatting;
sheet: Sheet;
type: TableauEventType;
worksheet: Worksheet;
}
Hierarchy (View Summary)
- TableauWorksheetEvent
- WorksheetFormattingChangedEvent
Index
Properties
-
-
-
-
- Interface Annotation
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/categoricaldomain.html b/website/static/api/interfaces/categoricaldomain.html
deleted file mode 100644
index cf324ee0..00000000
--- a/website/static/api/interfaces/categoricaldomain.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- annotation
-
-
-
-
-
- annotation
-
-
-
-
-
- annotation
-
-
-
-
-
- tuple
-
-
-
-
-
-
-
-
-
-
- Represents an annotation in a worksheet.
-Hierarchy
--
-
- - Annotation - -
Index
-
-
-
-
- Properties
--
-
- annotationHTML -
- annotation
Id
- - annotation
Text
- - annotation
Type
- - tuple
Id
-
Properties
-annotationHTML
- - -
-
-
- annotationId
-
-
-
-
-
- annotationText
-
-
-
-
-
- annotationType
-
-
-
-
-
- tupleId
-
-
-
-
-
-
-
-
-
-
- Interface CategoricalDomain
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/categoricalfilter.html b/website/static/api/interfaces/categoricalfilter.html
deleted file mode 100644
index 3bb3171e..00000000
--- a/website/static/api/interfaces/categoricalfilter.html
+++ /dev/null
@@ -1,500 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface CategoricalFilter
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/column.html b/website/static/api/interfaces/column.html
deleted file mode 100644
index 3fb5e7be..00000000
--- a/website/static/api/interfaces/column.html
+++ /dev/null
@@ -1,302 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- applied
-
-
-
-
-
- field
-
-
-
-
-
- field
-
-
-
-
-
- filter
-
-
-
-
-
- Optional is
-
-
-
-
-
- is
-
-
-
-
-
- worksheet
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- set
-
-
-
-
-
-
-
-
- A Categorical Filter
-Hierarchy
--
-
-
- Filter
-
-
-
- - CategoricalFilter - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- applied
Values
- - field
Id
- - field
Name
- - filter
Type
- - is
All Selected
- - is
Exclude Mode
- - worksheet
Name
-
Methods
- -Properties
-appliedValues
-
-
-
-
-
- fieldId
-
-
-
-
-
- fieldName
-
-
-
-
-
- filterType
-
-
-
-
-
- Optional isAllSelected
-
-
-
-
-
- isExcludeMode
-
-
-
-
-
- worksheetName
-
-
-
-
-
- Methods
-getAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied.
-
-
getDomainAsync
- -
-
-
-
-
-
-
- --
Parameters
--
-
-
-
Optional domainType: FilterDomainType
-
-
Returns Promise<CategoricalDomain>
-a promise containing the categorical domain for the filter. Note if a filter contains - multiple fields (such as a filter action with multiple fields), the values array in the returned - CategoricalDomain (CategoricalDomain.values) will be empty. If there are multiple fields - in the filter, the results need to be represented by a table, which is not currently supported.
-
- -
-
getFieldAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Field>
-a promise containing the field for the filter.
-
-
setAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- ---- -
Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
-Parameters
--
-
-
-
applyToWorksheets: Array<string>
---list of worksheets to apply the filter on
-
-
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied
-
- -
-
-
-
-
-
- Interface Column
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/connectionsummary.html b/website/static/api/interfaces/connectionsummary.html
deleted file mode 100644
index be2ee8a1..00000000
--- a/website/static/api/interfaces/connectionsummary.html
+++ /dev/null
@@ -1,282 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-
-
-
- field
-
-
-
-
-
- field
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
-
- Hierarchy
--
-
- - Column - -
Index
-
-
-
-
- Properties
--
-
- data
Type
- - field
Id
- - field
Name
- - index -
- is
Referenced
-
Properties
-dataType
-
-
-
-
-
- fieldId
-
-
-
-
-
- fieldName
-
-
-
-
-
- index
- - -
-
-
- isReferenced
-
-
-
-
-
-
-
-
-
-
- Interface ConnectionSummary
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dashboard.html b/website/static/api/interfaces/dashboard.html
deleted file mode 100644
index 6c474436..00000000
--- a/website/static/api/interfaces/dashboard.html
+++ /dev/null
@@ -1,908 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a connection within a datasource (ex: A SQL Server connection). - A data source can be composed of one or more connections.
-Hierarchy
--
-
- - ConnectionSummary - -
Index
-Properties
-id
- - -
-
-
- name
- - -
-
-
- serverURI
- - -
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface Dashboard
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dashboardcontent.html b/website/static/api/interfaces/dashboardcontent.html
deleted file mode 100644
index aa8c98f2..00000000
--- a/website/static/api/interfaces/dashboardcontent.html
+++ /dev/null
@@ -1,219 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- active
-
-
-
-
-
- active
-
-
-
-
-
-
-
-
-
-
-
- sheet
-
-
-
-
-
-
-
-
-
-
-
-
-
- add
-
-
-
- apply
-
-
-
- find
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- move
-
-
-
- remove
-
-
-
- replay
-
-
-
- set
-
-
-
- set
-
-
-
-
-
-
-
-
- The Dashboard interface inherits from the Sheet interface.
Hierarchy
--
-
-
- Sheet
-
-
-
- - Dashboard - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- active
Dashboard Name
- - active
Dashboard Object Id
- - name -
- objects -
- sheet
Type
- - size -
- worksheets -
Methods
- -Properties
-activeDashboardName
-
-
-
-
-
- activeDashboardObjectId
-
-
-
-
-
- name
- - -
-
-
- objects
- - -
-
-
- sheetType
-
-
-
-
-
- size
- - -
-
-
- worksheets
- - -
-
-
-
-
- This is a helper method and is equivalent to looping
- through all of the objects in a dashboard and collecting all of the objects
- whose type is worksheet. You can use this property to iterate
- through all of the worksheets in the dashboard.
Methods
-addEventListener
- -
-
-
-
-
-
-
- ----
Adds a new event listener to the object. If this object does not support the specified
-eventType, - the method throws an exception. - The following table shows the event types supported by objects.- -
-- - -object -eventType -- -Worksheet -FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged- -Parameter -ParameterChanged- -Settings -SettingsChanged- -Dashboard -DashboardLayoutChanged,WorkbookFormattingChangedParameters
--
-
-
-
eventType: TableauEventType
---The type of event to register for. The type of event is a
-TableauEventTypeenumeration.
- -
-
handler: TableauEventHandlerFn
---The function which will be called when an event happens.
-
-
Returns TableauEventUnregisterFn
-A helper function which can be called to remove this registration.
-The following example sets up a listener in a worksheet for a mark selection event (
-MarkSelectionChanged). - When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers - the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.// Add an event listener for the selection changed event on this sheet. -// Assigning the event to a variable just to make the example fit on the page here. -const markSelection = tableau.TableauEventType.MarkSelectionChanged; -// -unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) { -// When the selection changes, reload the data -loadSelectedMarks(worksheetName); -}); - -// remove the event listener when done - unregisterEventHandlerFunction(); -
- -
-
applyFilterAsync
- -
-
-
-
-
-
-
- ---- -
Applies a simple categorical filter (non-date) to the dashboard. - This method is similar to the method used for worksheets, but applies the filter to all the worksheets in the dashboard that have that same field. - Note that the filter is ignored by a worksheet if the worksheet doesn't have the relevant field in its data source.
-Parameters
--
-
-
-
fieldName: string
---The name of the field to filter on.
-
- -
-
values: Array<string>
---The list of values to filter on.
-
- -
-
updateType: FilterUpdateType
---The update type of this filter (add, all, remove, replace).
-
- -
-
filterOptions: FilterOptions
---Advanced filter options (isExcludeMode).
-
-
Returns Promise<string>
-The field name that the filter is applied on.
-
- -
-
findParameterAsync
- -
-
-
-
-
-
-
- ----
Searches for a parameter with the given name.
-Parameters
--
-
-
-
parameterName: string
---The name of the parameter to find.
-
-
Returns Promise<Parameter | undefined>
-The parameter with the given name, or undefined if it does not exist.
-
- -
-
getDashboardObjectById
- -
-
-
-
-
-
-
- ---- -
Gets the specified dashboard object by its id. If a dashboard object is not found this method returns undefined.
-Parameters
--
-
-
-
dashboardObjectId: number
---The id of an object on the dashboard.
-
-
Returns DashboardObject | undefined
-The dashboard object with that id. Returns undefined if the dashboard object is not found.
-
- -
-
getFiltersAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<Filter>>
-The collection of filters used on the dashboard
-
-
getParametersAsync
- -
-
-
-
-
-
-
- --
Returns Promise<Array<Parameter>>
-A collection of all the Tableau parameters that are used in this workbook.
-
-
moveAndResizeDashboardObjectsAsync
- -
-
-
-
-
-
-
- ---- -
Sets the position and size of one or more floating dashboard objects. - Throws an error if the dashboard object is invalid
-Parameters
--
-
-
-
dashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdateArray
-
-
Returns Promise<void>
-Empty promise that resolves when the position and size of the dashboard objects have been changed.
-
- -
-
removeEventListener
- -
-
-
-
-
-
-
- ----
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the
-addEventListenermethod. Alternatively, use the function - returned from the call toaddEventListenerto unregister the event listener. - For more information, see Events and Event Handling.Parameters
--
-
-
-
eventType: TableauEventType
-
- -
-
handler: TableauEventHandlerFn
-
-
Returns boolean
-Whether or not an event listener was removed.
-
- -
-
replayAnimationAsync
- -
-
-
-
-
-
-
- ---- -
Replays an animation for the active sheet - Throws an error if the replay speed is invalid
-Parameters
--
-
-
-
replaySpeed: ReplaySpeedType
-
-
Returns Promise<void>
-Empty promise that resolves when the animation has been replayed.
-
- -
-
setDashboardObjectVisibilityAsync
- -
-
-
-
-
-
-
- ---- -
Sets the visibility of one or more dashboard objects. - Throws an error if the dashboard object is invalid
-Parameters
--
-
-
-
dashboardObjectVisibilityMap: DashboardObjectVisibilityMap
---A map of dashboard object ids to its desired state of visibility.
-
-
Returns Promise<void>
-Empty promise that resolves when the visibility has been changed.
-
- -
-
setZoneVisibilityAsync
- -
-
-
-
-
-
-
- ---- -
Sets the visibility of one or more floating dashboard zones. - Throws an error if the zone is invalid
-Parameters
--
-
-
-
zoneVisibilityMap: ZoneVisibilityMap
---A map of zone ids to the desired state of visibility for that zone.
-
-
Returns Promise<void>
-Empty promise that resolves when the visibility has been changed.
-
- -
-
-
-
-
-
- Interface DashboardContent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dashboardlayoutchangedevent.html b/website/static/api/interfaces/dashboardlayoutchangedevent.html
deleted file mode 100644
index d8f34227..00000000
--- a/website/static/api/interfaces/dashboardlayoutchangedevent.html
+++ /dev/null
@@ -1,249 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The DashboardContent namespace is the namespace associated with Dashboard Extensions.
- The DashboardContent namespace contains the Dashboard interface. Use the Dashboard Interface to
- access dashboard objects, worksheets, and parameters, and to add or remove event listeners.
Hierarchy
--
-
- - DashboardContent - -
Index
-
-
-
-
- Properties
--
-
- dashboard -
Properties
-dashboard
- - -
-
-
-
-
-
-
-
- Interface DashboardLayoutChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dashboardobject.html b/website/static/api/interfaces/dashboardobject.html
deleted file mode 100644
index 652a6240..00000000
--- a/website/static/api/interfaces/dashboardobject.html
+++ /dev/null
@@ -1,417 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- dashboard
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is raised when the dashboard objects are modified.
- Should be listened for directly from the tableau.extensions.dashboardContent.dashboard object.
Hierarchy
--
-
-
- TableauEvent
-
-
-
- - DashboardLayoutChangedEvent - -
-
Index
-
-
-
-
- Properties
- -Properties
-dashboardLayoutChangeDetails
-
-
-
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface DashboardObject
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html b/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html
deleted file mode 100644
index c5c13766..00000000
--- a/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html
+++ /dev/null
@@ -1,300 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An object of a dashboard.
-Hierarchy
--
-
- - DashboardObject - -
Index
-Properties
-dashboard
- - -
-
-
- fieldId
-
-
-
-
-
- id
- - -
-
-
- isFloating
-
-
-
-
-
- isVisible
-
-
-
-
-
- name
- - -
-
-
- position
- - -
-
-
- size
- - -
-
-
- type
- - -
-
-
- worksheet
- - -
-
-
-
-
-
-
-
- Interface DashboardObjectPositionAndSizeUpdate
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/datasource.html b/website/static/api/interfaces/datasource.html
deleted file mode 100644
index 05ba766f..00000000
--- a/website/static/api/interfaces/datasource.html
+++ /dev/null
@@ -1,570 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- dashboard
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An object to specify a dashboard object and its new position and size in a dashboard.
-Hierarchy
--
-
- - DashboardObjectPositionAndSizeUpdate - -
Index
-
-
-
-
- Properties
--
-
- dashboard
ObjectID
- - height -
- width -
- x -
- y -
Properties
-dashboardObjectID
-
-
-
-
-
- height
- - -
-
-
- width
- - -
-
-
- x
- - -
-
-
- y
- - -
-
-
-
-
-
-
-
- Interface DataSource
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/datasourceunderlyingdataoptions.html b/website/static/api/interfaces/datasourceunderlyingdataoptions.html
deleted file mode 100644
index c2cc1e70..00000000
--- a/website/static/api/interfaces/datasourceunderlyingdataoptions.html
+++ /dev/null
@@ -1,309 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- extract
-
-
-
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- refresh
-
-
-
-
-
-
-
-
- Represents the data source used by a Worksheet.
-Hierarchy
--
-
- - DataSource - -
Index
-
-
-
-
-
-
- Properties
--
-
- extract
Update Time
- - fields -
- id -
- is
Extract
- - is
Published
- - name -
Methods
- -Properties
-extractUpdateTime
-
-
-
-
-
- fields
- - -
-
-
- id
- - -
-
-
- isExtract
-
-
-
-
-
- isPublished
-
-
-
-
-
- name
- - -
-
-
- Methods
-getActiveTablesAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<TableSummary>>
-An array of table summary objects that are currently used in the data source.
-
-
getConnectionSummariesAsync
- -
-
-
-
-
-
-
- --
Returns Promise<Array<ConnectionSummary>>
-An array of descriptions of the connections within this data source.
-
-
getLogicalTableDataAsync
- -
-
-
-
-
-
-
- ---- -
Gets the underlying data table for the given logical table id.
-Parameters
--
-
-
-
logicalTableId: string
-
- -
-
Optional options: DataSourceUnderlyingDataOptions
---Collection of options to change the behavior of the call.
-
-
Returns Promise<DataTable>
-A data table containing the underlying data of the data source.
-
- -
-
getLogicalTablesAsync
- -
-
-
-
-
-
-
- ---- -
Gets the underlying logical tables used in the data source.
-Returns Promise<Array<LogicalTable>>
-An array of logical tables that are currently used in the data source.
-The following example uses the
-getLogicalTablesAsyncmethod to print the names of the - the logical tables to the console.dataSource.getLogicalTablesAsync().then(function (logicalTables) { - // Loop through each table that was used in creating this data source - logicalTables.forEach(function (table) { - console.log(table.caption); - }); -});
-
getUnderlyingDataAsync
- -
-
-
-
-
-
-
- - --
Parameters
--
-
-
-
Optional options: DataSourceUnderlyingDataOptions
---Collection of options to change the behavior of the call.
-
-
Returns Promise<DataTable>
-Returns a promise containing a page of data from the underlying data of the data source.
-The following example shows use of the
-getUnderlyingDataAsync()method to get the underlying data from a specific data source. - The example uses the JavaScriptfind()method to select the workbook and data source.const dataSources = await worksheet.getDataSourcesAsync(); -const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore"); -const dataTable = await dataSource.getUnderlyingDataAsync(); -let field = dataTable.columns.find(column => column.fieldName === "Sub-Category"); -let list = []; -for (let row of dataTable.data) { - list.push(row[field.index].value); -} -let values = list.filter((el, i, arr) => arr.indexOf(el) === i); -console.log(values); -
- -
-
refreshAsync
- -
-
-
-
-
-
-
- ----
This call has the same functionality as clicking the Refresh option on a data source in - Tableau. This does not refresh an extract.
-Note: The
-refreshAsync()method is intended to be used in scenarios where manual - interaction causes a need to refresh the data in the Tableau visualization. The method is not, - as currently designed, meant to support or emulate streaming or live visualizations. - Extensions that use the method to refresh aggressively or automatically - can cause issues on Tableau Server and Tableau Online and are subject to being blocked - by the Tableau Online administrator.This call does not currently support refreshing live Google Sheet data sources.
-Returns Promise<void>
-Promise that resolves when the data source has finished refreshing.
-
-
-
-
-
-
- Interface DataSourceUnderlyingDataOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/datatable.html b/website/static/api/interfaces/datatable.html
deleted file mode 100644
index af07b47f..00000000
--- a/website/static/api/interfaces/datatable.html
+++ /dev/null
@@ -1,347 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional columns
-
-
-
-
-
- Optional columns
-
-
-
-
-
- Optional ignore
-
-
-
-
-
- Optional include
-
-
-
-
-
- Optional max
-
-
-
-
-
-
-
-
-
-
- Configuration object for fetching data from an data source object.
-Hierarchy
--
-
- - DataSourceUnderlyingDataOptions - -
Index
-
-
-
-
- Properties
- -Properties
-Optional columnsToInclude
-
-
-
-
-
-
- The columns to return specified by field name, returns all by default.
-Optional columnsToIncludeById
-
-
-
-
-
-
-
- The columns to return specified by field id, returns all by default. - Since 1.5.0, fieldId is a property of the Column object.
-Optional ignoreAliases
-
-
-
-
-
-
- Do not use aliases specified in the data source in Tableau. Default is false.
-Optional includeDataValuesOption
-
-
-
-
-
-
-
- Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
- All properties not requested will be undefined in the DataValue results.
- This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
Optional maxRows
-
-
-
-
-
-
-
- The maximum number of rows to return. 10,000 by default
-
-
-
-
-
- Interface DataTable
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/datatablereader.html b/website/static/api/interfaces/datatablereader.html
deleted file mode 100644
index d44bcf6d..00000000
--- a/website/static/api/interfaces/datatablereader.html
+++ /dev/null
@@ -1,393 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional is
-
-
-
-
-
- Optional is
-
-
-
-
-
- Optional marks
-
-
-
-
-
-
-
-
- total
-
-
-
-
-
-
- Hierarchy
--
-
- - DataTable - -
Index
-
-
-
-
- Properties
--
-
- columns -
- data -
- is
Summary Data
- - is
Total Row Count Limited
- - marks
Info
- - name -
- total
Row Count
-
Properties
-columns
- - -
-
-
- data
- - -
-
-
- Optional isSummaryData
-
-
-
-
-
- Optional isTotalRowCountLimited
-
-
-
-
-
- Optional marksInfo
-
-
-
-
-
- name
- - -
-
-
- totalRowCount
-
-
-
-
-
-
-
-
-
-
- Interface DataTableReader
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/datavalue.html b/website/static/api/interfaces/datavalue.html
deleted file mode 100644
index 3ccae1cd..00000000
--- a/website/static/api/interfaces/datavalue.html
+++ /dev/null
@@ -1,309 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- page
-
-
-
-
-
- total
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- release
-
-
-
-
-
-
-
-
- A DataTableReader allows iteration over summary or underlying data by pages. - The page size is established when the DataTableReader is created. - (See getLogicalTableDataReaderAsync, getSummaryDataReaderAsync, or getUnderlyingTableDataReaderAsync.) - The normal sequence of operations would be to
--
-
- Create the DataTableReader for the desired DataTable. -
- Use DataTableReader.totalRowCount or DataTableReader.pageCount to discover how many rows or pages are in the desired DataTable. -
- Call DataTableReader.getPageAsync() to get the page(s) desired. Each page is a DataTable for that page. - Alternatively, based on the DataTableReader.totalRowCount, DataTableReader.getAllPagesAsync can be used to fetch the entire DataTable. -
- Call DataTableReader.releaseAsync() to free up resources. -
Notes for usage of a DataTableReader:
--
-
- Since DataTableReaders consume server resources, an inactive DataTableReader will be automatically - released after 60 minutes of inactivity. (A new DataTableReader can be created at that time, if needed.) -
- Calling getPageAsync() after an explicit or automatic releaseAsync() will throw an exception. -
- Only one active DataTableReader per logical table id is supported. -
- There are still limits on the number of rows supported for underlying and logical data table readers. - The default limit is approximately 1 million rows of data for getUnderlyingTableDataReaderAsync, - and approximately 32 million cells (rows * columns) for getLogicalTableDataReaderAsync. - Administrators may change these limits to better match computing resources with the Tableau Server (Cloud) or Tableau Desktop options: - ExtensionsAndEmbeddingReaderRowLimit for getUnderlyingTableDataReaderAsync or - ExtensionsAndEmbeddingReaderCellLimit for getLogicalTableDataReaderAsync. -
Hierarchy
--
-
- - DataTableReader - -
Index
-
-
-
-
-
-
- Properties
--
-
- page
Count
- - total
Row Count
-
Methods
--
-
- get
All Pages Async
- - get
Page Async
- - release
Async
-
Properties
-pageCount
-
-
-
-
-
- totalRowCount
-
-
-
-
-
- Methods
-getAllPagesAsync
- -
-
-
-
-
-
-
- ----
Get all the pages of data into a single DataTable. - Calls to getAllPagesAsync() after releaseAsync() will throw an exception. - To protect against possible browser failure, getAllPagesAsync will cap the data at a maximum of 400 pages. - With a default pageRowCount of 10,000 this will give you a maximum of 4,000,000 rows of data.
-If sizes are larger than this, please process your data in page size chunks.
-Parameters
--
-
-
-
Optional maxRows: undefined | number
---Limits the request to maxRows. If maxRows === 0, requests all rows.
-
-
Returns Promise<DataTable>
-A DataTable containing all the data available to the DataTableReader with the maximum page count above.
-// To simplify the example, we assume we have less than 4m rows of data -// Since we are fetching all of the data, use the default page size in getSummaryDataReaderAsync -const dataTableReader = await worksheet.getSummaryDataReaderAsync(); -const dataTable = await dataTableReader.getAllPagesAsync(); -await dataTableReader.releaseAsync(); -// ... process the data table ...
- -
-
getPageAsync
- -
-
-
-
-
-
-
- ----
Get a page of data. The page is returned as a DataTable. - Calls to getPageAsync() after releaseAsync() will throw an exception.
-Parameters
--
-
-
-
pageNumber: number
---The page number (zero-indexed) to fetch. The page number should be treated - like an array index with range: 0 <= pageNumber < pageCount.
-
-
Returns Promise<DataTable>
-A DataTable containing the requested page. The number of rows returned - can be less than the page size at the end of the data.
-const pageRowCount = 200; -const dataTableReader = await worksheet.getSummaryDataReaderAsync(pageRowCount, options); -for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) { - const currentPageDataTable = await dataTableReader.getPageAsync(currentPage); - // ... process current page ... -} -await dataTableReader.releaseAsync();
- -
-
releaseAsync
- -
-
-
-
-
-
-
- ----
Release all resources held by the DataTableReader. - Calling this when done with the DataTableReader is required practice as it frees up resources. - Calls to getPageAsync() after releaseAsync() will throw an exception.
-Returns Promise<void>
-
-
-
-
-
-
- Interface DataValue
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dialogmessageevent.html b/website/static/api/interfaces/dialogmessageevent.html
deleted file mode 100644
index 5da27762..00000000
--- a/website/static/api/interfaces/dialogmessageevent.html
+++ /dev/null
@@ -1,268 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional alias
-
-
-
-
-
- Optional formatted
-
-
-
-
-
- Optional has
-
-
-
-
-
- native
-
-
-
-
-
-
-
-
-
- Hierarchy
--
-
- - DataValue - -
Index
-
-
-
-
- Properties
--
-
- alias
Value
- - formatted
Value
- - has
Alias
- - native
Value
- - value -
Properties
-Optional aliasValue
-
-
-
-
-
- Optional formattedValue
-
-
-
-
-
- Optional hasAlias
-
-
-
-
-
- nativeValue
-
-
-
-
-
- value
- - -
-
-
-
-
-
-
-
- Interface DialogMessageEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/dialogoptions.html b/website/static/api/interfaces/dialogoptions.html
deleted file mode 100644
index d5a4c7d7..00000000
--- a/website/static/api/interfaces/dialogoptions.html
+++ /dev/null
@@ -1,250 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional source
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is raised when the dialog has a message for the underlying extension (sent using tableau.extensions.ui.sendDialogMessageAsync), or vice versa.
- Should be listened for directly from the tableau.extensions.ui object.
- For example, when the dialog sends a message to the extension using tableau.extensions.ui.sendDialogMessageAsync method,
- the extension should be listening for this event and handling it.
Hierarchy
--
-
-
- TableauEvent
-
-
-
- - DialogMessageEvent - -
-
Index
-
-
-
-
- Properties
--
-
- message -
- source
Dialog Url
- - type -
Properties
-message
- - -
-
-
- Optional sourceDialogUrl
-
-
-
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface DialogOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/encoding.html b/website/static/api/interfaces/encoding.html
deleted file mode 100644
index 555e13a5..00000000
--- a/website/static/api/interfaces/encoding.html
+++ /dev/null
@@ -1,286 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional dialog
-
-
-
-
-
-
-
-
-
-
-
-
- Hierarchy
--
-
- - DialogOptions - -
Index
-
-
-
-
- Properties
--
-
- dialog
Style
- - height -
- width -
Properties
-Optional dialogStyle
-
-
-
-
-
-
-
- Specifies the style for the popup dialog.
-Optional height
- - -
-
-
-
- Specifies the suggested height (in pixels) of the popup dialog. Not guaranteed to be exactly that height.
-Optional width
- - -
-
-
-
- Specifies the suggested width (in pixels) of dialog to display. Not guaranteed to be exactly that width.
-
-
-
-
-
- Interface Encoding
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/environment.html b/website/static/api/interfaces/environment.html
deleted file mode 100644
index 48604789..00000000
--- a/website/static/api/interfaces/environment.html
+++ /dev/null
@@ -1,430 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hierarchy
--
-
- - Encoding - -
Index
-
-
-
-
- Properties
--
-
- field -
- field
Encoding Id
- - id -
- type -
Properties
-field
- - -
-
-
- fieldEncodingId
-
-
-
-
-
- id
- - -
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface Environment
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/eventlistenermanager.html b/website/static/api/interfaces/eventlistenermanager.html
deleted file mode 100644
index 1d7f2a01..00000000
--- a/website/static/api/interfaces/eventlistenermanager.html
+++ /dev/null
@@ -1,329 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- api
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- operating
-
-
-
-
-
- tableau
-
-
-
-
-
- Optional unique
-
-
-
-
-
- Optional workbook
-
-
-
-
-
-
-
-
-
-
- The environment namespace provides a way to programmatically gather - information about the environment in which the Extensions is running.
-Hierarchy
--
-
- - Environment - -
Index
-
-
-
-
- Properties
--
-
- api
Version
- - context -
- country -
- language -
- locale -
- mode -
- operating
System
- - tableau
Version
- - unique
User Id
- - workbook
Formatting
-
Properties
-apiVersion
-
-
-
-
-
- context
- - -
-
-
- Optional country
- - -
-
-
- language
- - -
-
-
- locale
- - -
-
-
- mode
- - -
-
-
- operatingSystem
-
-
-
-
-
- tableauVersion
-
-
-
-
-
- Optional uniqueUserId
-
-
-
-
-
- Optional workbookFormatting
-
-
-
-
-
-
-
-
-
-
- Interface EventListenerManager
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/extensions.html b/website/static/api/interfaces/extensions.html
deleted file mode 100644
index 71761450..00000000
--- a/website/static/api/interfaces/extensions.html
+++ /dev/null
@@ -1,576 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- add
-
-
-
- remove
-
-
-
-
-
-
-
-
- Interface for handling registering and unregistering event listeners. Different objects will implement - this interface to manage their event handling.
-Hierarchy
- -Index
-
-
-
-
- Methods
- -Methods
-addEventListener
- -
-
-
-
-
-
-
- ----
Adds a new event listener to the object. If this object does not support the specified
-eventType, - the method throws an exception. - The following table shows the event types supported by objects.- -
-- - -object -eventType -- -Worksheet -FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged- -Parameter -ParameterChanged- -Settings -SettingsChanged- -Dashboard -DashboardLayoutChanged,WorkbookFormattingChangedParameters
--
-
-
-
eventType: TableauEventType
---The type of event to register for. The type of event is a
-TableauEventTypeenumeration.
- -
-
handler: TableauEventHandlerFn
---The function which will be called when an event happens.
-
-
Returns TableauEventUnregisterFn
-A helper function which can be called to remove this registration.
-The following example sets up a listener in a worksheet for a mark selection event (
-MarkSelectionChanged). - When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers - the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.// Add an event listener for the selection changed event on this sheet. -// Assigning the event to a variable just to make the example fit on the page here. -const markSelection = tableau.TableauEventType.MarkSelectionChanged; -// -unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) { -// When the selection changes, reload the data -loadSelectedMarks(worksheetName); -}); - -// remove the event listener when done - unregisterEventHandlerFunction(); -
- -
-
removeEventListener
- -
-
-
-
-
-
-
- ----
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the
-addEventListenermethod. Alternatively, use the function - returned from the call toaddEventListenerto unregister the event listener. - For more information, see Events and Event Handling.Parameters
--
-
-
-
eventType: TableauEventType
-
- -
-
handler: TableauEventHandlerFn
-
-
Returns boolean
-Whether or not an event listener was removed.
-
- -
-
-
-
-
-
- Interface Extensions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/field.html b/website/static/api/interfaces/field.html
deleted file mode 100644
index b8300bb2..00000000
--- a/website/static/api/interfaces/field.html
+++ /dev/null
@@ -1,511 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional dashboard
-
-
-
-
-
- dashboard
-
-
-
-
-
-
-
- Optional worksheet
-
-
-
-
-
-
-
- create
-
-
-
- initialize
-
-
-
- initialize
-
-
-
-
-
- set
-
-
-
-
-
-
-
-
- The extension namespace contains all functionality available to - Extensions in Tableau.
-Hierarchy
--
-
- - Extensions - -
Index
-
-
-
-
-
-
- All Extensions Properties
--
-
- environment -
- settings -
- ui -
- workbook -
Dashboard Extensions Properties
- -Viz Extensions Properties
--
-
- worksheet
Content
-
All Extensions Methods
- -Dashboard Extensions Methods
- -All Extensions Properties
-environment
- - -
-
-
-
- The environment namespace provides methods to programmatically gather information about the environment
- in which the extension is running. To access the objects in this name space, specify
- tableau.extensions.environment.
settings
- - -
-
-
-
- The settings namespace provides methods to get and set values which will be persisted in a workbook.
- You can use the settings to configure an extension. To access the objects in this name space, specify
- tableau.extensions.settings.
ui
- - -
-
-
-
- The ui namespace provides methods for an extension to display a popup dialog window.
- To access the objects in this name space, specify tableau.extensions.ui.
workbook
- - -
-
-
-
-
- The currently opened workbook.
-Dashboard Extensions Properties
-Optional dashboardContent
-
-
-
-
-
-
- The dashboardContent namespace provides access to the dashboard object when the extension is a dashboard extension.
- When you have the dashboard object, you have access to all elements in the dashboard
- including the worksheets, marks,
- filters, parameters, and data sources.
- To access the objects in this name space, specify tableau.extensions.dashboardContent.
dashboardObjectId
-
-
-
-
-
-
-
- The dashboard object id for the extension that is running.
-Viz Extensions Properties
-Optional worksheetContent
-
-
-
-
-
-
-
- The worksheetContent namespace provides access to the worksheet when the extension is a worksheet extension.
- When you have the worksheet object, you have access to all elements in the worksheet
- To access the objects in this name space, specify tableau.extensions.worksheetContent.
All Extensions Methods
-createVizImageAsync
- -
-
-
-
-
-
-
- - --
Parameters
--
-
-
-
inputSpec: object
---the object containing the embedded data and visual spec details
-tableau.extensions.createVizImageAsync(myInputSpec));The following is an example of an input spec object.
-var myInputSpec = { - description: 'A simple bar chart with embedded data.', - data: { - values: [ - { Category: 'A', Measure: 28, Weather: 10 }, - { Category: 'B', Measure: 55, Weather: 9 }, - { Category: 'C', Measure: 43, Weather: 8 }, - ] - }, - mark: tableau.MarkType.Bar, - encoding: { - columns: { field: 'Category', type: tableau.VizImageEncodingType.Discrete }, - rows: { field: 'Measure', type: tableau.VizImageEncodingType.Continuous }, - sort: { field: 'Category', 'sortby': 'Weather', direction: tableau.VizImageSortDirectionType.Ascending } - } - };
-
Returns Promise<string>
-A promise that when resolved, returns the viz as an svg.
-Supports sorting by field.
-
- -
-
initializeAsync
- -
-
-
-
-
-
-
- ----
This is the entry point for an Extension. This function must first be called - in order to interact with any of the other Extension APIs.
-Parameters
--
-
-
-
Optional contextMenuCallbacks: undefined | {}
---This optional object maps the ids of context menu items to the function - to be triggered when that context menu item is selected. The keys listed - must matched the keys registered in the
-context-menuelement of the manifest. - Currently, only a single context menu item is available ('configure') - that creates the Configure... menu item), so this object will only contain a single entry. - In this example, the'configure'key is mapped to a function of the same name, - which you would define in your JavaScript code.$(document).ready(function () { - tableau.extensions.initializeAsync({'configure': configure}).then(function() { - // When the user clicks the Configure... context menu item, - // the configure function specified as the argument here - // is executed. - // - }); - });
-
Returns Promise<void>
-A promise that when resolved, the other Extension APIs will be available to use.
-
- -
-
initializeDialogAsync
- -
-
-
-
-
-
-
- ----
The
-initializeDialogAsyncfunction is the entry point for an extension that runs inside a dialog box (or popup window) - created by the UI namespace. A call totableau.extensions.ui.displayDialogAsync(payload)creates the dialog box. - When the extension running in the dialog box loads, the extension must first call theinitializeDialogAsyncfunction - to use the rest of the Extension API. TheinitializeDialogAsyncfunction should only be called by extensions - that are displayed in a dialog box. You use theinitializeAsyncfunction - to initialize the main extension, that is, the parent of the extension in the dialog box.Returns Promise<string>
-A promise that when resolved the other Extension APIs will be available to use. - Contains a string that is the initial payload for the dialog as sent by the - parent extension via
-tableau.extensions.ui.displayDialogAsync(payload). - See displayDialogAsync for more information.
-
Dashboard Extensions Methods
-setClickThroughAsync
- -
-
-
-
-
-
-
- ---- -
This method allows for clicks to pass through the extension window on Tableau Server.
-Parameters
--
-
-
-
clickThroughEnabled: boolean
---A boolean which represents if clicks should pass through the extension window
-
-
Returns Promise<void>
-A promise that resolves when the click through property has been set.
-The following example shows a call made to setClickThroughAsync.
-// disabling pointer events on the extension window - tableau.extensions.setClickThroughAsync(true).then(() => { - console.log('Successfully enabled extension window click through'); - }).catch((error) => { - // Can throw an error if called from a dialog or on Tableau Desktop - console.error(error.message); - });
- -
-
-
-
-
-
- Interface Field
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/fieldinstance.html b/website/static/api/interfaces/fieldinstance.html
deleted file mode 100644
index 27495a3d..00000000
--- a/website/static/api/interfaces/fieldinstance.html
+++ /dev/null
@@ -1,495 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- column
-
-
-
-
-
- data
-
-
-
-
-
- data
-
-
-
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- A field contains information about what data source it belongs to, - its role, and the ability to fetch the domain values.
-Hierarchy
--
-
-
- FieldBase
-
-
-
- - Field - -
-
Index
-
-
-
-
- Properties
--
-
- aggregation -
- column
Type
- - data
Source
- - data
Type
- - description -
- id -
- is
Calculated Field
- - is
Combined Field
- - is
Generated
- - is
Geospatial
- - is
Hidden
- - is
Present OnPublished Datasource
- - name -
- role -
Properties
-aggregation
- - -
-
-
- columnType
-
-
-
-
-
- dataSource
-
-
-
-
-
- dataType
-
-
-
-
-
- description
- - -
-
-
- id
- - -
-
-
- isCalculatedField
-
-
-
-
-
- isCombinedField
-
-
-
-
-
- isGenerated
-
-
-
-
-
- isGeospatial
-
-
-
-
-
- isHidden
-
-
-
-
-
- isPresentOnPublishedDatasource
-
-
-
-
-
- name
- - -
-
-
- role
- - -
-
-
-
-
-
-
-
- Interface FieldInstance
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/filter.html b/website/static/api/interfaces/filter.html
deleted file mode 100644
index e2171926..00000000
--- a/website/static/api/interfaces/filter.html
+++ /dev/null
@@ -1,402 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- column
-
-
-
-
-
- data
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
- is
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hierarchy
--
-
-
- FieldBase
-
-
-
- - FieldInstance - -
-
Index
-
-
-
-
- Properties
--
-
- aggregation -
- column
Type
- - data
Type
- - description -
- field
Id
- - is
Calculated Field
- - is
Combined Field
- - is
Generated
- - is
Geospatial
- - is
Hidden
- - is
Present OnPublished Datasource
- - name -
- role -
Properties
-aggregation
- - -
-
-
- columnType
-
-
-
-
-
- dataType
-
-
-
-
-
- description
- - -
-
-
- fieldId
-
-
-
-
-
- isCalculatedField
-
-
-
-
-
- isCombinedField
-
-
-
-
-
- isGenerated
-
-
-
-
-
- isGeospatial
-
-
-
-
-
- isHidden
-
-
-
-
-
- isPresentOnPublishedDatasource
-
-
-
-
-
- name
- - -
-
-
- role
- - -
-
-
-
-
-
-
-
- Interface Filter
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/filterchangedevent.html b/website/static/api/interfaces/filterchangedevent.html
deleted file mode 100644
index d067cce1..00000000
--- a/website/static/api/interfaces/filterchangedevent.html
+++ /dev/null
@@ -1,312 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
- field
-
-
-
-
-
- filter
-
-
-
-
-
- worksheet
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- set
-
-
-
-
-
-
-
-
- An abstract base class for all of the filter types.
-Hierarchy
--
-
-
- Filter
-
-
-
- - CategoricalFilter - -
- - HierarchicalFilter - -
- - RangeFilter - -
- - RelativeDateFilter - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- field
Id
- - field
Name
- - filter
Type
- - worksheet
Name
-
Methods
- -Properties
-fieldId
-
-
-
-
-
- fieldName
-
-
-
-
-
- filterType
-
-
-
-
-
- worksheetName
-
-
-
-
-
- Methods
-getAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied.
-
-
getFieldAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Field>
-a promise containing the field for the filter.
-
-
setAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- ---- -
Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
-Parameters
--
-
-
-
applyToWorksheets: Array<string>
---list of worksheets to apply the filter on
-
-
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied
-
- -
-
-
-
-
-
- Interface FilterChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/filteroptions.html b/website/static/api/interfaces/filteroptions.html
deleted file mode 100644
index c7bda01f..00000000
--- a/website/static/api/interfaces/filteroptions.html
+++ /dev/null
@@ -1,216 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- get
-
-
-
-
- Hierarchy
--
-
-
- TableauWorksheetEvent
-
-
-
- - FilterChangedEvent - -
-
Index
-
-
-
-
-
-
- Properties
- -Methods
--
-
- get
Filter Async
-
Properties
-fieldName
-
-
-
-
-
- sheet
- - -
-
-
- type
- - -
-
-
- worksheet
- - -
-
-
- Methods
-getFilterAsync
- -
-
-
-
-
-
-
- --
Returns Promise<Filter>
-The Filter object associated with the event.
-
-
-
-
-
-
- Interface FilterOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/formattingsheet.html b/website/static/api/interfaces/formattingsheet.html
deleted file mode 100644
index b43b3776..00000000
--- a/website/static/api/interfaces/formattingsheet.html
+++ /dev/null
@@ -1,227 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
-
-
-
-
-
- Passed into the applyFilter methods to control advanced filtering options.
-Hierarchy
--
-
- - FilterOptions - -
Index
-
-
-
-
- Properties
--
-
- is
Exclude Mode
-
Properties
-isExcludeMode
-
-
-
-
-
-
- Determines whether the filter will apply in exclude mode or include mode. - The default is include, which means that you use the fields as part of a filter. - Exclude mode means that you include everything else except the specified fields.
-
-
-
-
-
- Interface FormattingSheet
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/getsummarydataoptions.html b/website/static/api/interfaces/getsummarydataoptions.html
deleted file mode 100644
index 83a79467..00000000
--- a/website/static/api/interfaces/getsummarydataoptions.html
+++ /dev/null
@@ -1,344 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- class
-
-
-
-
-
- css
-
-
-
-
-
-
- Hierarchy
--
-
- - FormattingSheet - -
Index
-
-
-
-
- Properties
--
-
- class
Name Key
- - css
Properties
-
Properties
-classNameKey
-
-
-
-
-
- cssProperties
-
-
-
-
-
-
-
- Interface GetSummaryDataOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/getunderlyingdataoptions.html b/website/static/api/interfaces/getunderlyingdataoptions.html
deleted file mode 100644
index db608c04..00000000
--- a/website/static/api/interfaces/getunderlyingdataoptions.html
+++ /dev/null
@@ -1,369 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional apply
-
-
-
-
-
- Optional columns
-
-
-
-
-
- Optional ignore
-
-
-
-
-
- Optional ignore
-
-
-
-
-
- Optional include
-
-
-
-
-
- Optional max
-
-
-
-
-
-
-
-
-
-
- Options argument for the Worksheet.GetSummaryDataAsync API
-Hierarchy
--
-
-
- GetSummaryDataOptions
-
-
-
- - GetUnderlyingDataOptions - -
-
Index
-
-
-
-
- Properties
- -Properties
-Optional applyWorksheetFormatting
-
-
-
-
-
-
-
- Specifies whether to apply worksheet level formatting to numbers and dates - Note that this is different from the global field formatting degined in the Schema Viewer
-Optional columnsToIncludeById
-
-
-
-
-
-
-
- The columns to return specified by field id, returns all by default. - Since 1.5.0, fieldId is a property of the Column object.
-Optional ignoreAliases
-
-
-
-
-
-
- Do not use aliases specified in the data source in Tableau. Default is false.
-Optional ignoreSelection
-
-
-
-
-
-
- Only return data for the currently selected marks. Default is false.
-Optional includeDataValuesOption
-
-
-
-
-
-
-
- Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
- All properties not requested will be undefined in the DataValue results.
- This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
Optional maxRows
-
-
-
-
-
-
-
- The number of rows of data that you want to return. A value of 0 will attempt to return all rows.
- 0 is the default if maxRows is not specified.
- getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows.
- getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.
-
-
-
-
- Interface GetUnderlyingDataOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/hierarchicalfilter.html b/website/static/api/interfaces/hierarchicalfilter.html
deleted file mode 100644
index b716b069..00000000
--- a/website/static/api/interfaces/hierarchicalfilter.html
+++ /dev/null
@@ -1,535 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional apply
-
-
-
-
-
- Optional columns
-
-
-
-
-
- Optional ignore
-
-
-
-
-
- Optional ignore
-
-
-
-
-
- Optional include
-
-
-
-
-
- Optional include
-
-
-
-
-
- Optional max
-
-
-
-
-
-
-
-
-
-
- Options argument for the Worksheet.getUnderlyingTableDataAsync API.
-Hierarchy
--
-
-
- GetSummaryDataOptions
-
-
-
- - GetUnderlyingDataOptions - -
-
Index
-
-
-
-
- Properties
- -Properties
-Optional applyWorksheetFormatting
-
-
-
-
-
-
-
- Specifies whether to apply worksheet level formatting to numbers and dates - Note that this is different from the global field formatting degined in the Schema Viewer
-Optional columnsToIncludeById
-
-
-
-
-
-
-
- The columns to return specified by field id, returns all by default. - Since 1.5.0, fieldId is a property of the Column object.
-Optional ignoreAliases
-
-
-
-
-
-
- Do not use aliases specified in the data source in Tableau. Default is false.
-Optional ignoreSelection
-
-
-
-
-
-
- Only return data for the currently selected marks. Default is false.
-Optional includeAllColumns
-
-
-
-
-
-
- Return all the columns for the data source. Default is false.
-Optional includeDataValuesOption
-
-
-
-
-
-
-
- Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
- All properties not requested will be undefined in the DataValue results.
- This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
Optional maxRows
-
-
-
-
-
-
-
- The number of rows of data that you want to return. A value of 0 will attempt to return all rows.
- 0 is the default if maxRows is not specified.
- getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows.
- getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.
-
-
-
-
- Interface HierarchicalFilter
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/hierarchicalfilterdatavalue.html b/website/static/api/interfaces/hierarchicalfilterdatavalue.html
deleted file mode 100644
index 635a6dcf..00000000
--- a/website/static/api/interfaces/hierarchicalfilterdatavalue.html
+++ /dev/null
@@ -1,260 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- applied
-
-
-
-
-
- dimension
-
-
-
-
-
- field
-
-
-
-
-
- field
-
-
-
-
-
- filter
-
-
-
-
-
- hierarchy
-
-
-
-
-
- is
-
-
-
-
-
- level
-
-
-
-
-
- number
-
-
-
-
-
- worksheet
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- set
-
-
-
-
-
-
-
-
-
- A Hierarchical Filter - Hierarchical Filters are used when a hierarchical field is used as a filter on a cube database. - As an example, assume a hierarchical field in Product, named ByCategory. - ByCategory has the following five levels: Family, Category, Subcategory, Brand, Sku.
-Hierarchy
--
-
-
- Filter
-
-
-
- - HierarchicalFilter - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- applied
Values
- - dimension
Name
- - field
Id
- - field
Name
- - filter
Type
- - hierarchy
Caption
- - is
All Selected
- - level
Details
- - number
OfLevels
- - worksheet
Name
-
Methods
- -Properties
-appliedValues
-
-
-
-
-
- dimensionName
-
-
-
-
-
- fieldId
-
-
-
-
-
- fieldName
-
-
-
-
-
- filterType
-
-
-
-
-
- hierarchyCaption
-
-
-
-
-
- isAllSelected
-
-
-
-
-
- levelDetails
-
-
-
-
-
- numberOfLevels
-
-
-
-
-
- worksheetName
-
-
-
-
-
- Methods
-getAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied.
-
-
getFieldAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Field>
-a promise containing the field for the filter.
-
-
setAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- ---- -
Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
-Parameters
--
-
-
-
applyToWorksheets: Array<string>
---list of worksheets to apply the filter on
-
-
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied
-
- -
-
-
-
-
-
- Interface HierarchicalFilterDataValue
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/hierarchicalleveldetail.html b/website/static/api/interfaces/hierarchicalleveldetail.html
deleted file mode 100644
index 604c147e..00000000
--- a/website/static/api/interfaces/hierarchicalleveldetail.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- hierarchical
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- A selected value in a hierarchical filter
-Hierarchy
--
-
- - HierarchicalFilterDataValue - -
Index
-
-
-
-
- Properties
--
-
- hierarchical
Path
- - level -
- value -
Properties
-hierarchicalPath
-
-
-
-
-
- level
- - -
-
-
- value
- - -
-
-
-
-
-
-
-
- Interface HierarchicalLevelDetail
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/hierarchicallevels.html b/website/static/api/interfaces/hierarchicallevels.html
deleted file mode 100644
index e6c41f88..00000000
--- a/website/static/api/interfaces/hierarchicallevels.html
+++ /dev/null
@@ -1,214 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- level
-
-
-
-
-
-
-
-
-
-
-
-
-
- Details about each level in a hierarchical filter
-Hierarchy
--
-
- - HierarchicalLevelDetail - -
Index
-
-
-
-
- Properties
--
-
- level
Selection State
- - name -
Properties
-levelSelectionState
-
-
-
-
-
- name
- - -
-
-
-
-
-
-
-
- Interface HierarchicalLevels
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/logicaltable.html b/website/static/api/interfaces/logicaltable.html
deleted file mode 100644
index fce865ca..00000000
--- a/website/static/api/interfaces/logicaltable.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Levels to apply to a hierarchical filter
-Hierarchy
--
-
- - HierarchicalLevels - -
Index
-
-
-
-
- Properties
--
-
- levels -
Properties
-levels
- - -
-
-
-
-
- Interface LogicalTable
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/markinfo.html b/website/static/api/interfaces/markinfo.html
deleted file mode 100644
index ea5e0b38..00000000
--- a/website/static/api/interfaces/markinfo.html
+++ /dev/null
@@ -1,262 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface MarkInfo
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/markscollection.html b/website/static/api/interfaces/markscollection.html
deleted file mode 100644
index a17eff62..00000000
--- a/website/static/api/interfaces/markscollection.html
+++ /dev/null
@@ -1,219 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface MarksCollection
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/marksselectedevent.html b/website/static/api/interfaces/marksselectedevent.html
deleted file mode 100644
index f0b90ade..00000000
--- a/website/static/api/interfaces/marksselectedevent.html
+++ /dev/null
@@ -1,298 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a collection of marks on a viz. This collection could be - marks that are either selected or highlighted.
-Hierarchy
--
-
- - MarksCollection - -
Index
-
-
-
-
- Properties
--
-
- data -
Properties
-data
- - -
-
-
-
-
-
-
-
- Interface MarksSelectedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/marksspecification.html b/website/static/api/interfaces/marksspecification.html
deleted file mode 100644
index 35229cba..00000000
--- a/website/static/api/interfaces/marksspecification.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- get
-
-
-
-
-
-
-
-
- An event which is raised when marks are selected on a worksheet.
-Hierarchy
--
-
-
- TableauWorksheetEvent
-
-
-
- - MarksSelectedEvent - -
-
Index
-
-
-
-
-
-
- Properties
- -Methods
--
-
- get
Marks Async
-
Properties
-sheet
- - -
-
-
- type
- - -
-
-
- worksheet
- - -
-
-
- Methods
-getMarksAsync
- -
-
-
-
-
-
-
- --
Returns Promise<MarksCollection>
-The collection of Marks that were selected.
-
-
-
-
-
-
- Interface MarksSpecification
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/parameter.html b/website/static/api/interfaces/parameter.html
deleted file mode 100644
index 6a17f155..00000000
--- a/website/static/api/interfaces/parameter.html
+++ /dev/null
@@ -1,483 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- primitive
-
-
-
-
-
-
-
-
-
- Hierarchy
--
-
- - MarksSpecification - -
Index
-
-
-
-
- Properties
--
-
- encodings -
- primitive
Type
-
Properties
-encodings
- - -primitiveType
-
-
-
-
-
-
-
- Interface Parameter
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/parameterchangedevent.html b/website/static/api/interfaces/parameterchangedevent.html
deleted file mode 100644
index 8f25b5f7..00000000
--- a/website/static/api/interfaces/parameterchangedevent.html
+++ /dev/null
@@ -1,254 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- allowable
-
-
-
-
-
- current
-
-
-
-
-
- data
-
-
-
-
-
-
-
-
-
-
-
-
-
- add
-
-
-
- change
-
-
-
- remove
-
-
-
-
-
-
-
-
- Represents a parameter in Tableau and provides ways to introspect the parameter and change its values.
-Hierarchy
--
-
-
- EventListenerManager
-
-
-
- - Parameter - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- allowable
Values
- - current
Value
- - data
Type
- - id -
- name -
Methods
- -Properties
-allowableValues
-
-
-
-
-
- currentValue
-
-
-
-
-
- dataType
-
-
-
-
-
- id
- - -
-
-
- name
- - -
-
-
- Methods
-addEventListener
- -
-
-
-
-
-
-
- ----
Adds a new event listener to the object. If this object does not support the specified
-eventType, - the method throws an exception. - The following table shows the event types supported by objects.- -
-- - -object -eventType -- -Worksheet -FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged- -Parameter -ParameterChanged- -Settings -SettingsChanged- -Dashboard -DashboardLayoutChanged,WorkbookFormattingChangedParameters
--
-
-
-
eventType: TableauEventType
---The type of event to register for. The type of event is a
-TableauEventTypeenumeration.
- -
-
handler: TableauEventHandlerFn
---The function which will be called when an event happens.
-
-
Returns TableauEventUnregisterFn
-A helper function which can be called to remove this registration.
-The following example sets up a listener in a worksheet for a mark selection event (
-MarkSelectionChanged). - When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers - the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.// Add an event listener for the selection changed event on this sheet. -// Assigning the event to a variable just to make the example fit on the page here. -const markSelection = tableau.TableauEventType.MarkSelectionChanged; -// -unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) { -// When the selection changes, reload the data -loadSelectedMarks(worksheetName); -}); - -// remove the event listener when done - unregisterEventHandlerFunction(); -
- -
-
changeValueAsync
- -
-
-
-
-
-
-
- ----
Modifies this parameter and assigns it a new value. The new value must fall within - the domain restrictions defined by
-allowableValues. If the domain restriction isParameterValueType.Range, - be sure to check theallowableValuesbefore assigning a new value. If the new value is out of range, the - updated value will be set to either theminValueor themaxValueof the allowable range. If a step size is also specified - and the new value does not fall on the step intervals, the updated value will be set to the closest, lower step, - or closest, earlier date. If the domain restriction is typeParameterValueType.List, and there are aliases defined for the list, - the aliased value should be passed to the method.Parameters
--
-
-
-
newValue: string | number | boolean | Date
---The new value to assign to this parameter. - Note: For changing
-Dateparameters, UTC Date objects are expected.
-
Returns Promise<DataValue>
-The updated
-DataValue. The promise is rejected ifnewValueis invalid. However, if the domain restriction - is typeAllowableValuesType.Range, and thenewValueis out of the range bounds, the parameter gets set to theminValue- or themaxValueof the range (whichever is closer). If the range has astepSizeordateStepPeriod, the parameter gets set - to the closest, lower step, or the closest, earlier date.
- -
-
removeEventListener
- -
-
-
-
-
-
-
- ----
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the
-addEventListenermethod. Alternatively, use the function - returned from the call toaddEventListenerto unregister the event listener. - For more information, see Events and Event Handling.Parameters
--
-
-
-
eventType: TableauEventType
-
- -
-
handler: TableauEventHandlerFn
-
-
Returns boolean
-Whether or not an event listener was removed.
-
- -
-
-
-
-
-
- Interface ParameterChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/parameterdomainrestriction.html b/website/static/api/interfaces/parameterdomainrestriction.html
deleted file mode 100644
index fc31a161..00000000
--- a/website/static/api/interfaces/parameterdomainrestriction.html
+++ /dev/null
@@ -1,333 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- get
-
-
-
-
-
-
-
-
- An event which is raised when the value of a parameter changes.
-Hierarchy
--
-
-
- TableauEvent
-
-
-
- - ParameterChangedEvent - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- type -
Methods
- -Properties
-type
- - -
-
-
- Methods
-getParameterAsync
- -
-
-
-
-
-
-
- --
Returns Promise<Parameter>
-The parameter that was changed.
-
-
-
-
-
-
- Interface ParameterDomainRestriction
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/point.html b/website/static/api/interfaces/point.html
deleted file mode 100644
index 5d820ffe..00000000
--- a/website/static/api/interfaces/point.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional allowable
-
-
-
-
-
- Optional date
-
-
-
-
-
- Optional max
-
-
-
-
-
- Optional min
-
-
-
-
-
- Optional step
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents the allowable set of values which a parameter can be set to.
-Hierarchy
--
-
- - ParameterDomainRestriction - -
Index
-
-
-
-
- Properties
--
-
- allowable
Values
- - date
Step Period
- - max
Value
- - min
Value
- - step
Size
- - type -
Properties
-Optional allowableValues
-
-
-
-
-
- Optional dateStepPeriod
-
-
-
-
-
- Optional maxValue
-
-
-
-
-
- Optional minValue
-
-
-
-
-
- Optional stepSize
-
-
-
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface Point
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/rangedomain.html b/website/static/api/interfaces/rangedomain.html
deleted file mode 100644
index 7d5cf29d..00000000
--- a/website/static/api/interfaces/rangedomain.html
+++ /dev/null
@@ -1,258 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface RangeDomain
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/rangefilter.html b/website/static/api/interfaces/rangefilter.html
deleted file mode 100644
index b5d307f6..00000000
--- a/website/static/api/interfaces/rangefilter.html
+++ /dev/null
@@ -1,496 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface RangeFilter
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/rangefilteroptions.html b/website/static/api/interfaces/rangefilteroptions.html
deleted file mode 100644
index 7fa65393..00000000
--- a/website/static/api/interfaces/rangefilteroptions.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
- field
-
-
-
-
-
- filter
-
-
-
-
-
- include
-
-
-
-
-
- max
-
-
-
-
-
- min
-
-
-
-
-
- worksheet
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- set
-
-
-
-
-
-
-
-
- A Range Filter
-Hierarchy
--
-
-
- Filter
-
-
-
- - RangeFilter - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- field
Id
- - field
Name
- - filter
Type
- - include
Null Values
- - max
Value
- - min
Value
- - worksheet
Name
-
Methods
- -Properties
-fieldId
-
-
-
-
-
- fieldName
-
-
-
-
-
- filterType
-
-
-
-
-
- includeNullValues
-
-
-
-
-
- maxValue
-
-
-
-
-
- minValue
-
-
-
-
-
- worksheetName
-
-
-
-
-
- Methods
-getAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied.
-
-
getDomainAsync
- -
-
-
-
-
-
-
- --
Parameters
--
-
-
-
Optional domainType: FilterDomainType
---the domain type, defaults to relevant
-
-
Returns Promise<RangeDomain>
-a promise containing the domain for the range filter
-
- -
-
getFieldAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Field>
-a promise containing the field for the filter.
-
-
setAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- ---- -
Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
-Parameters
--
-
-
-
applyToWorksheets: Array<string>
---list of worksheets to apply the filter on
-
-
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied
-
- -
-
-
-
-
-
- Interface RangeFilterOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/rangevalue.html b/website/static/api/interfaces/rangevalue.html
deleted file mode 100644
index d6828598..00000000
--- a/website/static/api/interfaces/rangevalue.html
+++ /dev/null
@@ -1,255 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional null
-
-
-
-
-
-
-
-
-
-
- Options for Range Filter
-Hierarchy
--
-
- - RangeFilterOptions - -
Index
-
-
-
-
- Properties
--
-
- max -
- min -
- null
Option
-
Properties
-Optional max
- - -Optional min
- - -Optional nullOption
-
-
-
-
-
-
-
- Interface RangeValue
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/relativedatefilter.html b/website/static/api/interfaces/relativedatefilter.html
deleted file mode 100644
index e062429e..00000000
--- a/website/static/api/interfaces/relativedatefilter.html
+++ /dev/null
@@ -1,477 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional null
-
-
-
-
-
-
-
-
-
-
- RangeValue interface to provide selection value for range based selections.
- The associated field should be a quantitative field.
- For Date Values, UTC Date objects are expected. (i.e., var min = new Date(Date.UTC(1999, 0, 1))).
- While date string inputs work, UTC date inputs are officially supported going forward for RangeValue.
Hierarchy
--
-
- - RangeValue - -
Index
-
-
-
-
- Properties
--
-
- max -
- min -
- null
Option
-
Properties
-max
- - -
-
-
-
- max range value for the range based selection
-min
- - -
-
-
-
- min range value for the range based selection
-Optional nullOption
-
-
-
-
-
-
- Including nulloptions parameter.
-
-
-
-
-
- Interface RelativeDateFilter
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/relativedatefilteroptions.html b/website/static/api/interfaces/relativedatefilteroptions.html
deleted file mode 100644
index 7187f78f..00000000
--- a/website/static/api/interfaces/relativedatefilteroptions.html
+++ /dev/null
@@ -1,284 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- anchor
-
-
-
-
-
- field
-
-
-
-
-
- field
-
-
-
-
-
- filter
-
-
-
-
-
- period
-
-
-
-
-
-
-
-
- range
-
-
-
-
-
- worksheet
-
-
-
-
-
-
-
- get
-
-
-
- get
-
-
-
- set
-
-
-
-
- Hierarchy
--
-
-
- Filter
-
-
-
- - RelativeDateFilter - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- anchor
Date
- - field
Id
- - field
Name
- - filter
Type
- - period
Type
- - rangeN -
- range
Type
- - worksheet
Name
-
Methods
- -Properties
-anchorDate
-
-
-
-
-
- fieldId
-
-
-
-
-
- fieldName
-
-
-
-
-
- filterType
-
-
-
-
-
- periodType
-
-
-
-
-
- rangeN
- - -
-
-
- rangeType
-
-
-
-
-
- worksheetName
-
-
-
-
-
- Methods
-getAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied.
-
-
getFieldAsync
- -
-
-
-
-
-
-
- - --
Returns Promise<Field>
-a promise containing the field for the filter.
-
-
setAppliedWorksheetsAsync
- -
-
-
-
-
-
-
- ---- -
Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
-Parameters
--
-
-
-
applyToWorksheets: Array<string>
---list of worksheets to apply the filter on
-
-
Returns Promise<Array<string>>
-the list of worksheet names that have the filter applied
-
- -
-
-
-
-
-
- Interface RelativeDateFilterOptions
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/selectioncriteria.html b/website/static/api/interfaces/selectioncriteria.html
deleted file mode 100644
index 0df8f7cd..00000000
--- a/website/static/api/interfaces/selectioncriteria.html
+++ /dev/null
@@ -1,236 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional anchor
-
-
-
-
-
- period
-
-
-
-
-
-
-
-
- range
-
-
-
-
-
-
-
-
-
-
-
- Options for Relative Date Filter
-Hierarchy
--
-
- - RelativeDateFilterOptions - -
Index
-
-
-
-
- Properties
--
-
- anchor
Date
- - period
Type
- - rangeN -
- range
Type
-
Properties
-Optional anchorDate
-
-
-
-
-
- periodType
-
-
-
-
-
- Optional rangeN
- - -
-
-
- rangeType
-
-
-
-
-
-
-
-
-
-
- Interface SelectionCriteria
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/settings.html b/website/static/api/interfaces/settings.html
deleted file mode 100644
index a99fe6a0..00000000
--- a/website/static/api/interfaces/settings.html
+++ /dev/null
@@ -1,540 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- field
-
-
-
-
-
-
-
-
-
-
-
-
-
- SelectionCriteria interface is used to specify to the fieldName to values for Hierarchical, Categorical and Range based selections.
-Hierarchy
--
-
- - SelectionCriteria - -
Index
-Properties
-fieldName
-
-
-
-
-
-
- Fieldname of the mark that is intended to be selected. - Hierarchical fields follow the convention of "[{parentField}].[{selectingField}]"
-value
- - -
-
-
-
- Value that is intended to be selected. This can be specified as the list of values or a single value. - Range-based selections need to provide the value in the format of RangeValue interface. - To select a single quantitative value, use the RangeValue interface where both max and min are the value you want to select.
-
-
-
-
-
- Interface Settings
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/settingschangedevent.html b/website/static/api/interfaces/settingschangedevent.html
deleted file mode 100644
index 4af2df03..00000000
--- a/website/static/api/interfaces/settingschangedevent.html
+++ /dev/null
@@ -1,252 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
-
-
- add
-
-
-
-
-
-
-
-
-
- get
-
-
-
- remove
-
-
-
- save
-
-
-
-
-
-
-
-
-
-
-
- The settings namespace is used to get and set settings - values. You can use the settings to configure your extension. - The setting values are be persisted in a workbook.
-Hierarchy
--
-
-
- EventListenerManager
-
-
-
- - Settings - -
-
Index
-
-
-
-
-
-
- Properties
--
-
- is
Modified
-
Methods
--
-
- add
Event Listener
- - erase -
- get -
- get
All
- - remove
Event Listener
- - save
Async
- - set -
Properties
-isModified
-
-
-
-
-
-
-
- Indicates whether or not the settings have been - modified since the last call to saveAsync.
-Methods
-addEventListener
- -
-
-
-
-
-
-
- ----
Adds a new event listener to the object. If this object does not support the specified
-eventType, - the method throws an exception. - The following table shows the event types supported by objects.- -
-- - -object -eventType -- -Worksheet -FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged- -Parameter -ParameterChanged- -Settings -SettingsChanged- -Dashboard -DashboardLayoutChanged,WorkbookFormattingChangedParameters
--
-
-
-
eventType: TableauEventType
---The type of event to register for. The type of event is a
-TableauEventTypeenumeration.
- -
-
handler: TableauEventHandlerFn
---The function which will be called when an event happens.
-
-
Returns TableauEventUnregisterFn
-A helper function which can be called to remove this registration.
-The following example sets up a listener in a worksheet for a mark selection event (
-MarkSelectionChanged). - When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers - the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.// Add an event listener for the selection changed event on this sheet. -// Assigning the event to a variable just to make the example fit on the page here. -const markSelection = tableau.TableauEventType.MarkSelectionChanged; -// -unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) { -// When the selection changes, reload the data -loadSelectedMarks(worksheetName); -}); - -// remove the event listener when done - unregisterEventHandlerFunction(); -
- -
-
erase
--
-
-
-
-
-
-
- ----
Erases a settings key / value pair. If key isn't found, nothing happens.
-Parameters
--
-
-
-
key: string
---The key of the pair to erase.
-
-
Returns void
-
- -
-
get
--
-
-
-
-
-
-
- ----
Gets a settings value or undefined if the value does not exist.
-Parameters
--
-
-
-
key: string
---The key to retrieve.
-
-
Returns string | undefined
-The value or undefined if it does not exist.
-
- -
-
getAll
- -
-
-
-
-
-
-
- ----
Returns a copy of all the saved settings keys and values. - Modifying this value will have no effect on the class.
-Returns {}
-All the saved settings keys and values in a dictionary.
--
-
-
-
[key: string]: string
-
-
- -
-
removeEventListener
- -
-
-
-
-
-
-
- ----
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the
-addEventListenermethod. Alternatively, use the function - returned from the call toaddEventListenerto unregister the event listener. - For more information, see Events and Event Handling.Parameters
--
-
-
-
eventType: TableauEventType
-
- -
-
handler: TableauEventHandlerFn
-
-
Returns boolean
-Whether or not an event listener was removed.
-
- -
-
saveAsync
- -
-
-
-
-
-
-
- ----
Attempts to persist any currently modified settings key-value pairs. The
-saveAsync()method - should only be called in authoring mode.Returns Promise<{}>
-Promise containing the newly saved settings values.
-tableau.extensions.settings.saveAsync().then(result => { - console.log('Settings saved.'); - // ... process results -}).catch((error) => { - // ... - // ... code for error handling -}); -
-
set
--
-
-
-
-
-
-
- ----
Adds or updates a settings key / value pair.
-Parameters
--
-
-
-
key: string
---The key to save.
-
- -
-
value: string
---The value to save.
-
-
Returns void
-
- -
-
-
-
-
-
- Interface SettingsChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/sheet.html b/website/static/api/interfaces/sheet.html
deleted file mode 100644
index 028ec250..00000000
--- a/website/static/api/interfaces/sheet.html
+++ /dev/null
@@ -1,456 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- new
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is raised when the settings of an extension are updated.
- Should be listened for directly from the tableau.extensions.settings object.
Hierarchy
--
-
-
- TableauEvent
-
-
-
- - SettingsChangedEvent - -
-
Index
-
-
-
-
- Properties
--
-
- new
Settings
- - type -
Properties
-newSettings
-
-
-
-
-
-
-
- Type declaration
--
-
-
-
[key: string]: string
-
-
type
- - -
-
-
-
-
-
-
-
- Interface Sheet
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/size.html b/website/static/api/interfaces/size.html
deleted file mode 100644
index 89bac840..00000000
--- a/website/static/api/interfaces/size.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- sheet
-
-
-
-
-
-
-
-
-
-
- add
-
-
-
- find
-
-
-
- get
-
-
-
- remove
-
-
-
-
- Hierarchy
--
-
- - EventListenerManager - - -
Index
-
-
-
-
-
-
- Properties
- -Methods
- -Properties
-name
- - -
-
-
- sheetType
-
-
-
-
-
- size
- - -
-
-
- Methods
-addEventListener
- -
-
-
-
-
-
-
- ----
Adds a new event listener to the object. If this object does not support the specified
-eventType, - the method throws an exception. - The following table shows the event types supported by objects.- -
-- - -object -eventType -- -Worksheet -FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged- -Parameter -ParameterChanged- -Settings -SettingsChanged- -Dashboard -DashboardLayoutChanged,WorkbookFormattingChangedParameters
--
-
-
-
eventType: TableauEventType
---The type of event to register for. The type of event is a
-TableauEventTypeenumeration.
- -
-
handler: TableauEventHandlerFn
---The function which will be called when an event happens.
-
-
Returns TableauEventUnregisterFn
-A helper function which can be called to remove this registration.
-The following example sets up a listener in a worksheet for a mark selection event (
-MarkSelectionChanged). - When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers - the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.// Add an event listener for the selection changed event on this sheet. -// Assigning the event to a variable just to make the example fit on the page here. -const markSelection = tableau.TableauEventType.MarkSelectionChanged; -// -unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) { -// When the selection changes, reload the data -loadSelectedMarks(worksheetName); -}); - -// remove the event listener when done - unregisterEventHandlerFunction(); -
- -
-
findParameterAsync
- -
-
-
-
-
-
-
- ----
Searches for a parameter with the given name.
-Parameters
--
-
-
-
parameterName: string
---The name of the parameter to find.
-
-
Returns Promise<Parameter | undefined>
-The parameter with the given name, or undefined if it does not exist.
-
- -
-
getParametersAsync
- -
-
-
-
-
-
-
- --
Returns Promise<Array<Parameter>>
-A collection of all the Tableau parameters that are used in this workbook.
-
-
removeEventListener
- -
-
-
-
-
-
-
- ----
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the
-addEventListenermethod. Alternatively, use the function - returned from the call toaddEventListenerto unregister the event listener. - For more information, see Events and Event Handling.Parameters
--
-
-
-
eventType: TableauEventType
-
- -
-
handler: TableauEventHandlerFn
-
-
Returns boolean
-Whether or not an event listener was removed.
-
- -
-
-
-
-
-
- Interface Size
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/summarydatachangedevent.html b/website/static/api/interfaces/summarydatachangedevent.html
deleted file mode 100644
index 0519c63d..00000000
--- a/website/static/api/interfaces/summarydatachangedevent.html
+++ /dev/null
@@ -1,271 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface SummaryDataChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/tableauerror.html b/website/static/api/interfaces/tableauerror.html
deleted file mode 100644
index e9b65ec7..00000000
--- a/website/static/api/interfaces/tableauerror.html
+++ /dev/null
@@ -1,280 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is raised when summary data is changed for a worksheet or when a worksheet's data source is refreshed
-Hierarchy
--
-
-
- TableauWorksheetEvent
-
-
-
- - SummaryDataChangedEvent - -
-
Index
-Properties
-sheet
- - -
-
-
- type
- - -
-
-
- worksheet
- - -
-
-
-
-
-
-
-
- Interface TableauError
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/tableauevent.html b/website/static/api/interfaces/tableauevent.html
deleted file mode 100644
index 0fc8b8fd..00000000
--- a/website/static/api/interfaces/tableauevent.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- error
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom error class that extends the default JavaScript Error object.
-Hierarchy
--
-
-
- Error
-
-
-
- - TableauError - -
-
Index
-Properties
-Error
- - -errorCode
-
-
-
-
-
- message
- - -name
- - -Optional stack
- - -
-
-
-
-
- Interface TableauEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/tableausheetevent.html b/website/static/api/interfaces/tableausheetevent.html
deleted file mode 100644
index ab1b74fe..00000000
--- a/website/static/api/interfaces/tableausheetevent.html
+++ /dev/null
@@ -1,248 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event object represents a notification that some sort of state has changed. - This is the base event interface. All events will inherit this type.
-Hierarchy
--
-
-
- TableauEvent
-
-
-
- - TableauSheetEvent - -
- - WorkbookFormattingChangedEvent - -
- - ParameterChangedEvent - -
- - SettingsChangedEvent - -
- - DashboardLayoutChangedEvent - -
- - DialogMessageEvent - -
-
Index
-
-
-
-
- Properties
--
-
- type -
Properties
-type
- - -
-
-
-
-
-
-
-
- Interface TableauSheetEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/tableauworksheetevent.html b/website/static/api/interfaces/tableauworksheetevent.html
deleted file mode 100644
index 690fd092..00000000
--- a/website/static/api/interfaces/tableauworksheetevent.html
+++ /dev/null
@@ -1,279 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is related to a particular Sheet (worksheet, dashboard, story) in the workbook.
-Hierarchy
--
-
-
- TableauEvent
-
-
-
-
- TableauSheetEvent
-
-
-
- - TableauWorksheetEvent - -
-
- -
- TableauSheetEvent
-
Index
-Properties
-sheet
- - -
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface TableauWorksheetEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/tablesummary.html b/website/static/api/interfaces/tablesummary.html
deleted file mode 100644
index 4018c957..00000000
--- a/website/static/api/interfaces/tablesummary.html
+++ /dev/null
@@ -1,279 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is related to a particular Worksheet in the workbook.
-Hierarchy
--
-
-
- TableauSheetEvent
-
-
-
-
- TableauWorksheetEvent
-
-
-
- - MarksSelectedEvent - -
- - SummaryDataChangedEvent - -
- - FilterChangedEvent - -
- - WorksheetFormattingChangedEvent - -
-
- -
- TableauWorksheetEvent
-
Index
-Properties
-sheet
- - -
-
-
- type
- - -
-
-
- worksheet
- - -
-
-
-
-
-
-
-
- Interface TableSummary
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/tooltipcontext.html b/website/static/api/interfaces/tooltipcontext.html
deleted file mode 100644
index e1bd343e..00000000
--- a/website/static/api/interfaces/tooltipcontext.html
+++ /dev/null
@@ -1,219 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- connection
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a table of data in a data source.
-Hierarchy
--
-
- - TableSummary - -
Index
-
-
-
-
- Properties
--
-
- connection
Id
- - customSQL -
- id -
- name -
Properties
-connectionId
-
-
-
-
-
- customSQL
- - -
-
-
- id
- - -
-
-
- name
- - -
-
-
-
-
-
-
-
- Interface TooltipContext
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/ui.html b/website/static/api/interfaces/ui.html
deleted file mode 100644
index 96778cf4..00000000
--- a/website/static/api/interfaces/ui.html
+++ /dev/null
@@ -1,450 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- tooltip
-
-
-
-
-
-
-
-
-
-
-
- Provides the necessary information for how to display a Tableau tooltip.
-Hierarchy
--
-
- - TooltipContext - -
Index
-
-
-
-
- Properties
- -Properties
-tooltipAnchorPoint
-
-
-
-
-
-
- Indicates where the tooltip should be displayed relative to the top left of the visualization.
-
-
-
-
-
- Interface UI
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/visualspecification.html b/website/static/api/interfaces/visualspecification.html
deleted file mode 100644
index aef6512d..00000000
--- a/website/static/api/interfaces/visualspecification.html
+++ /dev/null
@@ -1,254 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- close
-
-
-
- display
-
-
-
- send
-
-
-
- send
-
-
-
-
-
-
-
-
- The UI namespace contains methods that allow an extension to display a popup
- dialog window. A modal dialog can be useful in authentication or configuration scenarios,
- or when extra situational UI space is needed. Only one dialog can be displayed at a time per extension.
- Inside the popup dialog window, another extension can be loaded and run. This dialog extension will have full access
- to the functions provided by the Extensions API. One difference between the extension running in the popup dialog window
- and an extension running in the dashboard is that the popup dialog window must call
- the initializeDialogAsync() method instead of initializeAsync() to initialize the extension.
Note If you want to use a popup dialog window on Tableau Server, you need to let users know that their browser must be - configured to allow popups.
-Hierarchy
--
-
- - UI - -
Index
-
-
-
-
- Methods
- -Methods
-closeDialog
- -
-
-
-
-
-
-
- ----
Closes the extension's dialog. Can be called from the popup dialog or from the extension itself.
-Parameters
--
-
-
-
Optional payload: undefined | string
---The
-payloadis optional, and if specified, it is made available to parent extension when - this popup dialog closes. If the extension running in the popup dialog window does not return - a payload, you must still provide an empty string" "as a return value.
- -
-
Optional dialogUrl: undefined | string
---Specifies the url of the dialog to close. - If the method is called from a dialog, and the dialogUrl is not specified, this will close the current dialog. - If the method is called from an extension, and the dialogUrl is not specified, this will close all open dialogs.
-tableau.extensions.ui.closeDialog('myPayload string'); -The following example shows a call to the closeDialog method when the dialog extension does not return a payload.
-// specify an empty string if no payload is returned - tableau.extensions.ui.closeDialog('');
-
Returns void
-
- -
-
displayDialogAsync
- -
-
-
-
-
-
-
- - --
Parameters
--
-
-
-
url: string
---The url of the 'dialog extension' to navigate to in the dialog. The url must - belong to the same domain as the parent extension.
-
- -
-
Optional payload: undefined | string
---The
-payloadis optional, and is used to provide data to the popup dialog window - at startup. Thepayloadwill be returned to the dialog extension as the return - value of the call to thetableau.extensions.ui.initializeDialogAsyncfunction. - If nopayloadis provided, you must indicate this with an empty string" ".
- -
-
Optional dialogOptions: DialogOptions
---Specifies the options for the popup dialog window. - The
-dialogOptionshas properties for width and height (in pixels) and a property for the dialog's style. - The dialog style can be a window, a modal dialog, or a modeless dialog. If style is not specified, window will be used. - You pass these properties to thedisplayDialogAsyncfunction, as follows: -{width:number, height:number, dialogStyle:DialogStyle}
-
Returns Promise<string>
-A promise that resolves when the dialog has been closed. It will contain a - payload as a string provided by the dialog extension. The promise is rejected if - the user manually closes the dialog window (for example, by clicking the 'X' in window). - It is good practice to handle this error condition with a catch block, as in the following example.
-tableau.extensions.ui.displayDialogAsync(popupUrl, defaultPayload, { width: 500, height: 500 }).then((closePayload) => { - // - // The promise is resolved when the dialog has been closed as expected, meaning that - // the popup extension has called tableau.extensions.ui.closeDialog() method. - // The close payload (closePayload) is returned from the popup extension - // via the closeDialog() method. - // - }).catch((error) => { - // One expected error condition is when the popup is closed by the user (meaning the user - // clicks the 'X' in the top right of the dialog). This can be checked for like so: - switch(error.errorCode) { - case tableau.ErrorCodes.DialogClosedByUser: - console.log("Dialog was closed by user"); - break; - default: - console.error(error.message); - } - });
- -
-
sendDialogMessageAsync
- -
-
-
-
-
-
-
- - --
Parameters
--
-
-
-
message: string
---A message to send.
-
- -
-
Optional targetDialogUrl: undefined | string
---The url of the dialog to send the message to. If not provided, the message will be sent to the parent extension.
-- // Sending a message from the dialog to the extension: - - // extension code (listening for messages originating from the dialog) - tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => { - console.log('Message received from dialog: ' + e.message); - }) - tableau.extensions.ui.displayDialogAsync(popupUrl); - ... - - // dialog code (sending message to extension) - await tableau.extensions.initializeDialogAsync(); - await tableau.extensions.ui.sendDialogMessageAsync('Hello from dialog!'); - - - // Sending a message from the extension to the dialog: - - // dialog code (listening for messages originating from the extension) - await tableau.extensions.initializeDialogAsync(); - tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => { - console.log('Message received from extension: ' + e.message); - }) - ... - - // extension code (sending message to dialog) - tableau.extensions.ui.displayDialogAsync(popupUrl); - // waiting a bit for dialog to appear before sending message. - // notice the intentional omission of await in calls to displayDialogAsync. - // that's because if we await, we wont run any code after that line until the dialog closes and the promise returns. - setTimeout(() => tableau.extensions.ui.sendDialogMessageAsync('Hello from extension!', popupUrl), 1000);
-
Returns any
-
- -
-
sendDialogMessageToParentAsync
- -
-
-
-
-
-
-
- - --
Parameters
--
-
-
-
message: string
---A message to send.
-
-
Returns any
-
- -
-
-
-
-
-
- Interface VisualSpecification
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/workbook.html b/website/static/api/interfaces/workbook.html
deleted file mode 100644
index abebb987..00000000
--- a/website/static/api/interfaces/workbook.html
+++ /dev/null
@@ -1,234 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- Interface Workbook
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/workbookformatting.html b/website/static/api/interfaces/workbookformatting.html
deleted file mode 100644
index 70a7fd2e..00000000
--- a/website/static/api/interfaces/workbookformatting.html
+++ /dev/null
@@ -1,221 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- get
-
-
-
-
-
-
-
-
-
- The Workbook represents the currently open workbook.
Hierarchy
--
-
- - Workbook - -
Index
-
-
-
-
- Methods
- -Methods
-getAllDataSourcesAsync
- -
-
-
-
-
-
-
- ---- -
Gets the data sources for this workbook. Note that calling this method might negatively impact performance - and responsiveness of the viz that your extension is added to. The method is not entirely - asynchronous and includes some serial operations.
-Returns Promise<Array<DataSource>>
-All data sources used in this workbook.
-
-
-
-
-
-
- Interface WorkbookFormatting
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/workbookformattingchangedevent.html b/website/static/api/interfaces/workbookformattingchangedevent.html
deleted file mode 100644
index 69699b45..00000000
--- a/website/static/api/interfaces/workbookformattingchangedevent.html
+++ /dev/null
@@ -1,243 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- formatting
-
-
-
-
-
-
-
-
-
-
- The Workbook formatting contains an array of Formatting sheets. - Each of these sheets can be identified by the ClassNameKey and - contains the CSS properties needed to mimic the formatting on your workbook.
-Hierarchy
--
-
- - WorkbookFormatting - -
Index
-
-
-
-
- Properties
--
-
- formatting
Sheets
-
Properties
-formattingSheets
-
-
-
-
-
-
-
-
-
-
- Interface WorkbookFormattingChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/worksheet.html b/website/static/api/interfaces/worksheet.html
deleted file mode 100644
index 353d07cc..00000000
--- a/website/static/api/interfaces/worksheet.html
+++ /dev/null
@@ -1,1776 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event which is related to a workbook's formatting (worksheet, dashboard, story) in the workbook.
-Hierarchy
--
-
-
- TableauEvent
-
-
-
- - WorkbookFormattingChangedEvent - -
-
Index
-
-
-
-
- Properties
--
-
- formatting -
- type -
Properties
-formatting
- - -
-
-
- type
- - -
-
-
-
-
-
-
-
- Interface Worksheet
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/worksheetcontent.html b/website/static/api/interfaces/worksheetcontent.html
deleted file mode 100644
index b90ba971..00000000
--- a/website/static/api/interfaces/worksheetcontent.html
+++ /dev/null
@@ -1,224 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- sheet
-
-
-
-
-
-
-
-
-
-
- parent
-
-
-
-
-
-
-
- background
-
-
-
-
-
-
-
-
-
-
- add
-
-
-
- annotate
-
-
-
- apply
-
-
-
- apply
-
-
-
- apply
-
-
-
- apply
-
-
-
- clear
-
-
-
- clear
-
-
-
- find
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- get
-
-
-
- remove
-
-
-
- remove
-
-
-
- select
-
-
-
-
-
- get
-
-
-
- hover
-
-
-
- leave
-
-
-
- select
-
-
-
-
- Hierarchy
--
-
-
- Sheet
-
-
-
- - Worksheet - -
-
Index
-
-
-
-
-
-
- All Extensions Properties
- -Dashboard Extensions Properties
--
-
- parent
Dashboard
-
Viz Extensions Properties
--
-
- background
Color
- - formatting -
All Extensions Methods
--
-
- add
Event Listener
- - annotate
Mark Async
- - apply
Filter Async
- - apply
Hierarchical Filter Async
- - apply
Range Filter Async
- - apply
Relative Date Filter Async
- - clear
Filter Async
- - clear
Selected Marks Async
- - find
Parameter Async
- - get
Annotations Async
- - get
Data Sources Async
- - get
Filters Async
- - get
Highlighted Marks Async
- - get
Parameters Async
- - get
Selected Marks Async
- - get
Summary Columns Info Async
- - get
Summary Data Async
- - get
Summary Data Reader Async
- - get
Underlying Data Async
- - get
Underlying Table Data Async
- - get
Underlying Table Data Reader Async
- - get
Underlying Tables Async
- - get
Visual Specification Async
- - remove
Annotation Async
- - remove
Event Listener
- - select
Marks ByValue Async
-
Viz Extensions Methods
- -All Extensions Properties
-name
- - -
-
-
- sheetType
-
-
-
-
-
- size
- - -
-
-
- Dashboard Extensions Properties
-parentDashboard
-
-
-
-
-
- Viz Extensions Properties
-backgroundColor
-
-
-
-
-
- formatting
- - -
-
-
- All Extensions Methods
-addEventListener
- -
-
-
-
-
-
-
- ----
Adds a new event listener to the object. If this object does not support the specified
-eventType, - the method throws an exception. - The following table shows the event types supported by objects.- -
-- - -object -eventType -- -Worksheet -FilterChanged,MarkSelectionChanged,SummaryDataChanged,WorksheetFormattingChanged- -Parameter -ParameterChanged- -Settings -SettingsChanged- -Dashboard -DashboardLayoutChanged,WorkbookFormattingChangedParameters
--
-
-
-
eventType: TableauEventType
---The type of event to register for. The type of event is a
-TableauEventTypeenumeration.
- -
-
handler: TableauEventHandlerFn
---The function which will be called when an event happens.
-
-
Returns TableauEventUnregisterFn
-A helper function which can be called to remove this registration.
-The following example sets up a listener in a worksheet for a mark selection event (
-MarkSelectionChanged). - When the event occurs, the data is reloaded. TheaddEventListenermethod returns a function that un-registers - the event handler. Call that function, in this case,unregisterEventHandlerFunction()to remove the registration.// Add an event listener for the selection changed event on this sheet. -// Assigning the event to a variable just to make the example fit on the page here. -const markSelection = tableau.TableauEventType.MarkSelectionChanged; -// -unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) { -// When the selection changes, reload the data -loadSelectedMarks(worksheetName); -}); - -// remove the event listener when done - unregisterEventHandlerFunction(); -
- -
-
annotateMarkAsync
- -
-
-
-
-
-
-
- ---- -
Add an annotation to the specified mark. - This is intended to be passed a MarkInfo object received from a DataTable. - MarkInfo can be found in the DataTable returned from getSelectedMarksAsync or getHighlightedMarksAsync.
-Parameters
--
-
-
-
mark: MarkInfo
---The mark to annotate.
-
- -
-
annotationText: string
---The text to display in the annotation.
-
-
Returns Promise<void>
-Empty promise that resolves when the annotation is complete.
-
- -
-
applyFilterAsync
- -
-
-
-
-
-
-
- ----
Applies the list of provided categorical filter values.
-Parameters
--
-
-
-
fieldName: string
---The name of the field to filter on.
-
- -
-
values: Array<string>
---The list of values to filter on.
-
- -
-
updateType: FilterUpdateType
---The update type of this filter (add, all, remove, replace).
-
- -
-
filterOptions: FilterOptions
---Advanced filter options (isExcludeMode).
-
-
Returns Promise<string>
-The field name that the filter is applied on.
-
- -
-
applyHierarchicalFilterAsync
- -
-
-
-
-
-
-
- ---- -
Applies the list of provided hierarchial filter values.
-Parameters
--
-
-
-
fieldName: string
---The name of the field to filter on.
-
- -
-
values: Array<string> | HierarchicalLevels
---The list of values or levels to filter on.
-
- -
-
updateType: FilterUpdateType
---The update type of this filter (add, all, remove, replace).
-
- -
-
options: FilterOptions
-
-
Returns Promise<string>
-The field name that the filter is applied on.
-
- -
-
applyRangeFilterAsync
- -
-
-
-
-
-
-
- ---- -
Applies a range filter to a quantitative or date field.
-Parameters
--
-
-
-
fieldName: string
---The name of the field to filter on
-
- -
-
filterOptions: RangeFilterOptions
---Filter Options: min, max, nullOption. At least one of of min and max is required. - For applying date filters, UTC Date objects are expected (that is,
-var min = new Date(Date.UTC(1999, 0, 1))).
-
Returns Promise<string>
-The field name that the filter is applied on.
-
- -
-
applyRelativeDateFilterAsync
- -
-
-
-
-
-
-
- ---- -
Applies a relative date filter.
-Parameters
--
-
-
-
fieldName: string
---The name of the field to filter on.
-
- -
-
options: RelativeDateFilterOptions
---The relative date filter options (anchorDate, periodType, rangeType, rangeN). When the rangeType is LASTN or NEXTN, the rangeN is required.
-
-
Returns Promise<string>
-The field name that the filter is applied on.
-
- -
-
clearFilterAsync
- -
-
-
-
-
-
-
- ----
Resets existing filters on the given field. - Categorical filters are reset to "All," and range filters are reset to the full range - Relative date filters can not be reset, consider using the applyRelativeDateFilterAsync API.
-Parameters
--
-
-
-
fieldName: string
---The name of the field to clear filter on.
-
-
Returns Promise<string>
-The field to clear filter on.
-
- -
-
clearSelectedMarksAsync
- -
-
-
-
-
-
-
- ----
Clears selected marks in the current worksheet.
-Returns Promise<void>
-Empty promise that resolves when the selection has been cleared.
-The following example assumes that you have some marks already selected in the worksheet. After it has run, - you should have no marks selected, and you should see the console message.
-worksheet.clearSelectedMarksAsync().then(function () { - console.log('Your marks selection has been cleared!'); - })
-
findParameterAsync
- -
-
-
-
-
-
-
- ----
Searches for a parameter with the given name.
-Parameters
--
-
-
-
parameterName: string
---The name of the parameter to find.
-
-
Returns Promise<Parameter | undefined>
-The parameter with the given name, or undefined if it does not exist.
-
- -
-
getAnnotationsAsync
- -
-
-
-
-
-
-
- ---- -
Retrieves a list of the annotations in the worksheet.
-Returns Promise<Array<Annotation>>
-A list annotations in the worksheet.
-
-
getDataSourcesAsync
- -
-
-
-
-
-
-
- ----
Gets the data sources for this worksheet. Note that calling this method might negatively impact performance - and responsiveness of the viz that your extension is added to. The method is not entirely - asynchronous and includes some serial operations.
-Returns Promise<Array<DataSource>>
-The primary data source and all of the secondary data sources for this worksheet. - By convention the first data source in the array is the primary.
-The following example shows how you might find a specific data source of a worksheet, - using the
-getDataSourcesAsync()method. The example then chains the data source returned in the promise - to a call to thegetUnderlyingDataAsync()method to access the data table.worksheet.getDataSourcesAsync().then(datasources => { - dataSource = datasources.find(datasource => datasource.name === "Sample - Superstore"); - return dataSource.getUnderlyingDataAsync(); -}).then(dataTable => { -// process the dataTable... -}); -
-
getFiltersAsync
- -
-
-
-
-
-
-
- ----
Gets the list of filters on a worksheet. Hierarchical filters are not yet supported
-Returns Promise<Array<Filter>>
-A promise that resolves to the collection of filters used in this worksheet.
-
-
getHighlightedMarksAsync
- -
-
-
-
-
-
-
- ----
Gets the data for the marks which are currently highlighted on the worksheet. - If there are no marks currently highlighted, an empty model is returned.
-Returns Promise<MarksCollection>
-The marks which are selected.
-
-
getParametersAsync
- -
-
-
-
-
-
-
- --
Returns Promise<Array<Parameter>>
-A collection of all the Tableau parameters that are used in this workbook.
-
-
getSelectedMarksAsync
- -
-
-
-
-
-
-
- ----
Gets the data for the marks which are currently selected on the worksheet. - If there are no marks currently selected, an empty model is returned.
-Returns Promise<MarksCollection>
-The marks that are selected.
-// Call to get the selected marks for the worksheet -worksheet.getSelectedMarksAsync().then(function (marks) { - // Get the first DataTable for our selected marks (usually there is just one) - const worksheetData = marks.data[0]; - - // Map the data into a format for display, etc. - -});
-
getSummaryColumnsInfoAsync
- -
-
-
-
-
-
-
- ---- -
Gets the columns that are returned with
-getSummaryDataAsync.Returns Promise<Array<Column>>
-The array of columns that describe the data in the worksheet.
-
-
getSummaryDataAsync
- -
-
-
-
-
-
-
- ---- -
Gets the summary data table for this worksheet. - Warning: getSummaryDataAsync can fail with a worksheet with many rows of data and is now deprecated.
-Parameters
--
-
-
-
Optional options: GetSummaryDataOptions
---Collection of options to change the behavior of the call.
-
-
Returns Promise<DataTable>
-A data table containing the summary data for the worksheet.
-
- -
-
getSummaryDataReaderAsync
- -
-
-
-
-
-
-
- ----
Gets a summary data table reader for this worksheet. - Only one active DataTableReader for summary data is supported.
-
-Note: The
-getSummaryDataAsyncandgetSummaryDataReaderAsyncmethods return the data that is currently - in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is - the underlying data without the additional fields and processing you have added in Tableau, use - the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.
-Parameters
--
-
-
-
Optional pageRowCount: undefined | number
---The number of rows per page. The default and maximum is 10,000 rows.
-
- -
-
Optional options: GetSummaryDataOptions
---Collection of options to change the behavior of the reader.
-
-
Returns Promise<DataTableReader>
-A data table reader to access the summary data for the worksheet.
-The following example shows the methods to get and use the summary data reader for all rows in a worksheet.
-const dataTableReader = await worksheet.getSummaryDataReaderAsync(); -for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) { - let dataTablePage = await dataTableReader.getPageAsync(currentPage); - // ... process current page .... -} -await dataTableReader.releaseAsync();
- -
-
getUnderlyingDataAsync
- -
-
-
-
-
-
-
- ---- -
Gets the underlying data table for this worksheet.
-Parameters
--
-
-
-
Optional options: GetUnderlyingDataOptions
---Collection of options to change the behavior of the call.
-
-
Returns Promise<DataTable>
-A data table containing the underlying data for the worksheet.
-
- -
-
getUnderlyingTableDataAsync
- -
-
-
-
-
-
-
- ---- -
Gets the underlying data table for the given logical table id. - Use the
-getUnderlyingTablesAsyncmethod to identify the logical tables.Parameters
--
-
-
-
logicalTableId: string
---logical table id.
-
- -
-
Optional options: GetUnderlyingDataOptions
---Collection of options to change the behavior of the call.
-
-
Returns Promise<DataTable>
-A data table containing the underlying data for the given logical table id
-
- -
-
getUnderlyingTableDataReaderAsync
- -
-
-
-
-
-
-
- ----
Gets a underlying data table reader for the given logical table id. - Use the
-getUnderlyingTablesAsyncmethod to identify the logical tables. - Only one active DataTableReader per logical table id is supported.
-Note: Use the
-getUnderlyingTableDataReaderAsyncmethod to access the full data, that is - the underlying data without the parameters, calculated fields, and processing you might - have added in Tableau. To access just the data that is currently in the viz, with parameters, - calculated fields, and sorting applied use the Worksheet.getSummaryDataAsync and - Worksheet.getSummaryDataReaderAsync methods.
-The
-getUnderlyingTableDataReaderAsyncmethod attempts to prepare all the rows of the underlying table to be read as pages. - However, there is a limit to the number of rows that can be prepared. The default limit is 1 million rows of data. - You can change the default limit with the Tableau Server (Cloud) or Tableau Desktop option: ExtensionsAndEmbeddingReaderRowLimit. - If the underlying table has many columns,getUnderlyingTableDataReaderAsynccan be sped up by only requesting - native data values in the GetUnderlyingDataOptions.Parameters
--
-
-
-
logicalTableId: string
---logical table id.
-
- -
-
Optional pageRowCount: undefined | number
---The number of rows per page. The default and maximum is 10,000 rows.
-
- -
-
Optional options: GetUnderlyingDataOptions
---Collection of options to change the behavior of the reader.
-
-
Returns Promise<DataTableReader>
-A data table reader to access the underlying data for the given logical table id.
-The following example shows getting the first page of underlying data.
-// Call to get the underlying logical tables used by the worksheet -const underlyingTablesData = await worksheet.getUnderlyingTablesAsync(); -const logicalTableId = underlyingTablesData[0].id; -// Use the above logicalTableId to get the underlying data reader on the active sheet -const dataTableReader = await worksheet.getUnderlyingTableDataReaderAsync(logicalTableId); -const page = await dataTableReader.getPageAsync(0); -// ... process first page of data table ... -await dataTableReader.releaseAsync();
- -
-
getUnderlyingTablesAsync
- -
-
-
-
-
-
-
- ---- -
Gets the underlying logical tables used by the worksheet. The resulting logical tables are determined by the measures in the worksheet. - If a worksheet's data source contains multiple logical tables and the worksheet contains only measures from one logical table, this API - will return one logical table.
-Returns Promise<Array<LogicalTable>>
-An array of logical tables corresponding to the measures referenced by the worksheet.
-// Call to get the underlying logical tables used by the worksheet -worksheet.getUnderlyingTablesAsync().then(function (logicalTables) { - // Get the first logical table's id - const logicalTableId = logicalTables[0].id; - - // Use the above logicalTableId to then get worksheet's underlying data - // by calling worksheet.getUnderlyingTableDataAsync(logicalTableId) - -});
-
getVisualSpecificationAsync
- -
-
-
-
-
-
-
- ---- -
Returns the visual specification for the worksheet, which can be used to get - the mappings from fields to encodings backing the visual within the worksheet
-Returns Promise<VisualSpecification>
-Promise containing the VisualSpecification
-
-
removeAnnotationAsync
- -
-
-
-
-
-
-
- ---- -
Removes the corresponding annotation from the worksheet it belongs to. - This is intended to be passed a Annotation object received from getAnnotationsAsync.
-Parameters
--
-
-
-
annotation: Annotation
---The annotation to remove.
-
-
Returns Promise<void>
-Empty promise that resolves when the annotation is removed.
-
- -
-
removeEventListener
- -
-
-
-
-
-
-
- ----
Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the
-addEventListenermethod. Alternatively, use the function - returned from the call toaddEventListenerto unregister the event listener. - For more information, see Events and Event Handling.Parameters
--
-
-
-
eventType: TableauEventType
-
- -
-
handler: TableauEventHandlerFn
-
-
Returns boolean
-Whether or not an event listener was removed.
-
- -
-
selectMarksByValueAsync
- -
-
-
-
-
-
-
- ---- -
Selects the marks specified by value using the SelectionCriteria interface. - This is intended for manual construction of the desired selections.
-Parameters
--
-
-
-
selectionCriteria: Array<SelectionCriteria>
---A list of criteria for which marks to select.
-
- -
-
updateType: SelectionUpdateType
---The type of selection to make: add, remove, or replace.
-
-
Returns Promise<void>
-Empty promise that resolves when the selection is complete.
-
- -
-
Viz Extensions Methods
-getTooltipTextAsync
- -
-
-
-
-
-
-
- ----
Method to get the text of the tooltip that would be displayed for a given tuple id. Currently supported for web only.
-You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. - For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.
-Passing in an invalid tuple id will not throw. -
-let navigatedTuple = -1; -let updateScreenReaderElement = (screenReadertext) => { - // updates an element to be read out by screen readers -}; - -let updateNavigatedTuple = (keyboardEvent) => { - switch (keyboardEvent.key) { - case 'ArrowLeft': - navigatedTuple = navigatedTuple - 1; - break; - case 'ArrowRight': - navigatedTuple = navigatedTuple + 1; - break; - default: - break; - } - // do any work to show visual indication of a mark being navigated to -}; - -svg.on('keydown', (keyboardEvent) => { - updateNavigatedTuple(keyboardEvent); - tableau.extensions.worksheetContent.worksheet - .getTooltipTextAsync(navigatedTuple) - .then((response) => { - console.log(response.result); - updateScreenReaderElement(response.result); - }) - .catch((error) => console.log('Failed to get tooltip text because of: ', error)); -});Parameters
--
-
-
-
tupleId: number
-
-
Returns Promise<String>
-Returns promise that resolves to a string describing the tooltip text for a given tuple id and rejects on error
-
- -
-
hoverTupleAsync
- -
-
-
-
-
-
-
- ----
Method to execute hover actions and render tooltip for a given tuple representing a mark in the visualization. - If the tooltip parameter is included it will show the tooltip when the mark is hovered over. - If null or no tooltip parameter is passed, no tooltip is shown. - Hover actions are run by default, but passing false for the allowHoverActions parameter will prevent their execution.
-The
-hoveredTupleparameter is a tuple id. You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. - For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.Passing in an invalid tuple id will not throw and will clear the tooltip. -
-svg.on('mousemove', (mouseEvent) => { - const myHoveredTuple = 10; - tableau.extensions.worksheetContent.worksheet.hoverTupleAsync(myHoveredTuple, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } }) - .then(() => console.log('Done')) - .catch((error) => console.log('Failed to hover because of: ', error)); - });Parameters
--
-
-
-
hoveredTuple: number
-
- -
-
Optional tooltip: TooltipContext | null
-
- -
-
Optional allowHoverActions: undefined | false | true
-
-
Returns Promise<void>
-Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error
-
- -
-
leaveMarkNavigationAsync
- -
-
-
-
-
-
-
- ----
Notifies the scene of a desire to leave mark-level keyboard navigation and return to scene-level keyboard navigation. - Used when implementing keyboard navigation within a visualization, an integral part of building accessibility into a visualization. - Currently supported for the web only. -
-svg.on('keyup', (keyboardEvent) => { - if (keyboardEvent.key == "Escape") { - tableau.extensions.worksheetContent.worksheet - .leaveMarkNavigationAsync() - .then(() => console.log('Done')) - .catch((error) => console.log('Failed to leave mark-level keyboard navigation because of: ', error)); - } -});Returns Promise<void>
-Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error
-
-
selectTuplesAsync
- -
-
-
-
-
-
-
- ----
Method to modify selection, execute select actions, and render tooltip for a given list of tuples representing a mark or marks in the visualization. - If the tooltip parameter is included it will show the tooltip when the mark or marks are selected. If not, no tooltip is shown.
-The
-selectedTuplesparameter is an array of tuple ids. You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. - For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.Passing in an invalid tuple id will not throw and will clear the tooltip. -
-svg.on('click', (mouseEvent) => { -const myClickedTuples = [10]; -const ctrlKeyPressed = !!mouseEvent.ctrlKey; -const selectOption = ctrlKeyPressed ? tableau.SelectOptions.Toggle : tableau.SelectOptions.Simple; - -tableau.extensions.worksheetContent.worksheet.selectTuplesAsync(myClickedTuples, selectOption, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } }) - .then(() => console.log('Done')) - .catch((error) => console.log('Failed to select because of: ', error)); -});Parameters
--
-
-
-
selectedTuples: Array<number>
-
- -
-
selectOption: SelectOptions
-
- -
-
Optional tooltip: TooltipContext
-
-
Returns Promise<void>
-Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error
-
- -
-
-
-
-
-
- Interface WorksheetContent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/interfaces/worksheetformattingchangedevent.html b/website/static/api/interfaces/worksheetformattingchangedevent.html
deleted file mode 100644
index dc12fc49..00000000
--- a/website/static/api/interfaces/worksheetformattingchangedevent.html
+++ /dev/null
@@ -1,293 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The WorksheetContent namespace is the namespace associated with Viz Extensions.
- The WorksheetContent namespace contains the Worksheet interface. Use the Worksheet Interface to
- access worksheet objects and to add or remove event listeners.
Hierarchy
--
-
- - WorksheetContent - -
Index
-
-
-
-
- Properties
--
-
- worksheet -
Properties
-worksheet
- - -
-
-
-
-
-
-
-
- Interface WorksheetFormattingChangedEvent
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/modules.html b/website/static/api/modules.html
new file mode 100644
index 00000000..18d4adcb
--- /dev/null
+++ b/website/static/api/modules.html
@@ -0,0 +1,25 @@
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An event raised when the worksheet's formatting changes. - Note that this event is also raised when the workbook's formatting changes.
-Hierarchy
--
-
-
- TableauWorksheetEvent
-
-
-
- - WorksheetFormattingChangedEvent - -
-
Index
-
-
-
-
- Properties
--
-
- formatting -
- sheet -
- type -
- worksheet -
Properties
-formatting
- - -
-
-
- sheet
- - -
-
-
- type
- - -
-
-
- worksheet
- - -
-
-
- Tableau Extensions API
Enumerations
- AnalyticsObjectType
- AnnotationType
- ClassNameKey
- ColumnType
- DashboardLayoutChange
- DashboardObjectType
- DashboardObjectVisibilityType
- DataFormatType
- DataType
- DateRangeType
- DialogStyle
- EncodingType
- ErrorCodes
- ExtensionContext
- ExtensionMode
- FieldAggregationType
- FieldRoleType
- FilterDomainType
- FilterNullOption
- FilterType
- FilterUpdateType
- HierarchicalLevelSelectionState
- IncludeDataValuesOption
- MarkType
- NegativeNumberFormat
- NumberFormatUnits
- ParameterValueType
- PeriodType
- QuickTableCalcType
- ReplaySpeedType
- SelectionUpdateType
- SelectOptions
- SheetType
- SortDirection
- TableauEventType
- TrendLineModelType
- VizImageEncodingType
- VizImagePaletteType
- VizImageSizeSettingAlignmentType
- VizImageSizeSettingType
- VizImageSortDirectionType
Interfaces - All Extensions
- Annotation
- CategoricalDomain
- CategoricalFilter
- Column
- ConnectionSummary
- DataFormattingOptions
- DataSource
- DataSourceUnderlyingDataOptions
- DataTable
- DataTableReader
- DataValue
- DialogMessageEvent
- DialogOptions
- Encoding
- Environment
- EventListenerManager
- Extensions
- Field
- FieldInstance
- Filter
- FilterChangedEvent
- FilterOptions
- FormattingSheet
- GetSummaryDataOptions
- GetUnderlyingDataOptions
- HierarchicalFilter
- HierarchicalFilterDataValue
- HierarchicalLevelDetail
- HierarchicalLevels
- LogicalTable
- MarkInfo
- MarksCollection
- MarksSelectedEvent
- MarksSpecification
- Parameter
- ParameterChangedEvent
- ParameterDomainRestriction
- Point
- RangeDomain
- RangeFilter
- RangeFilterOptions
- RangeValue
- RelativeDateFilter
- RelativeDateFilterOptions
- SelectionCriteria
- Settings
- SettingsChangedEvent
- Sheet
- Size
- SummaryDataChangedEvent
- TableauError
- TableauEvent
- TableauSheetEvent
- TableauWorksheetEvent
- TableSummary
- UI
- VisualSpecification
- Workbook
- WorkbookFormatting
- WorkbookFormattingChangedEvent
- Worksheet
- WorksheetFormatting
- WorksheetFormattingChangedEvent
Interfaces - Dashboard Extensions
Interfaces - Viz Extensions
Type Aliases - All Extensions
Type Aliases - Dashboard Extensions
Variables
-
-
-
-
- Module Tableau
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/website/static/api/types/CategoricalValue.html b/website/static/api/types/CategoricalValue.html
new file mode 100644
index 00000000..c90ef929
--- /dev/null
+++ b/website/static/api/types/CategoricalValue.html
@@ -0,0 +1,26 @@
+
-
-
-
-
-
-
-
-
-
-
-
- Zone
-
-
-
-
-
-
-
-
-
-
-
-
- Const Zone
-
-
-
-
-
-
-
-
-
-
- The tableau namespace exists for organization and to avoid polluting - the global namespace. It contains no constructs other than sub-namespaces and the Tableau enumerations.
-Index
-
-
-
-
-
-
-
-
-
-
- Enumerations
--
-
- Analytics
Object Type
- - Annotation
Type
- - Class
Name Key
- - Column
Type
- - Dashboard
Layout Change
- - Dashboard
Object Type
- - Dashboard
Object Visibility Type
- - Data
Type
- - Date
Range Type
- - Dialog
Style
- - Encoding
Type
- - Error
Codes
- - Extension
Context
- - Extension
Mode
- - Field
Aggregation Type
- - Field
Role Type
- - Filter
Domain Type
- - Filter
Null Option
- - Filter
Type
- - Filter
Update Type
- - Hierarchical
Level Selection State
- - Include
Data Values Option
- - Mark
Type
- - Parameter
Value Type
- - Period
Type
- - Quick
Table Calc Type
- - Replay
Speed Type
- - Select
Options
- - Selection
Update Type
- - Sheet
Type
- - Sort
Direction
- - Tableau
Event Type
- - Trend
Line Model Type
- - Viz
Image Encoding Type
- - Viz
Image Palette Type
- - Viz
Image Size Setting Alignment Type
- - Viz
Image Size Setting Type
- - Viz
Image Sort Direction Type
-
Type aliases
- -Variables
--
-
- extensions -
Object literals
- -Type aliases
-ZoneVisibilityType
-
-
-
-
-
-
-
- ZoneVisibilityType
-Variables
-Let extensions
- - -Object literals
-Const ZoneVisibilityType
-
-
- Type Alias CategoricalValue
CategoricalValue: string | string[]
Categorical values for selection.
+Type Alias DashboardLayoutChangeDetails
Map object that is used for the DashboardLayoutChangedEvent.
+Type Alias DashboardObjectPositionAndSizeUpdateArray
Array object that can be passed into moveAndResizeDashboardObjects.
+Type Alias DashboardObjectVisibilityMap
Map object that can be passed into setDashboardObjectVisibilityAsync.
+Type Alias DataFormat
type DataFormat = {
axisOptions?: DataFormattingOptions;
defaultOptions: DataFormattingOptions;
subtotalsOptions?: DataFormattingOptions;
totalsOptions?: DataFormattingOptions;
}
axisOptions?: DataFormattingOptions;
defaultOptions: DataFormattingOptions;
subtotalsOptions?: DataFormattingOptions;
totalsOptions?: DataFormattingOptions;
}
Index
Properties
Type Alias TableauEventHandlerFn
Callback function which will be invoked when an event notification is emitted.
+Type declaration
- (event: TableauEvent): void
Parameters
- event: TableauEvent
Class representing the event which occurred.
+
Returns void
- event: TableauEvent
Type Alias TableauEventUnregisterFn
TableauEventUnregisterFn: () => boolean
Function which can be invoked to remove an event handler registration. This will be +returned when registering an event and makes unregistering simpler.
+Type declaration
- (): boolean
Returns boolean
Whether or not the unregistration was successful.
+
Type Alias ZoneVisibilityMap
Map object that can be passed into setZoneVisibilityAsync.
+Type Alias ZoneVisibilityType
ZoneVisibilityType
+
Enum that represents the changes that occur to a dashboard object.
+