diff --git a/.gitignore b/.gitignore index a7ee0fb7..337110b5 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,6 @@ npm-debug.log dist/ .DS_Store + +# ignore local npmrc files +.npmrc diff --git a/Samples-Typescript/DashboardLayout/DashboardLayout.trex b/Samples-Typescript/DashboardLayout/DashboardLayout.trex new file mode 100644 index 00000000..39b11050 --- /dev/null +++ b/Samples-Typescript/DashboardLayout/DashboardLayout.trex @@ -0,0 +1,19 @@ + + + + en_US + + Dashboard Layout Sample + + 1.7 + + http://localhost:8765/Samples-Typescript/DashboardLayout/dashboardLayout.html + + iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAAB3RJTUUH4QgLDTYEcBRoeAAABp9JREFUeNrlm01sHEUWx//vVbs79gThjAd2iflIAkEcEARfEciBSYLEbbV8SJaDEpIAMQgkViuirA8IskKcdiEJX3G0C5dNpAVxQLIyiYw4YYIQBw4RBoMgBBIbCRtnOsx0vbcHd9sTZ3r8ge2p2bQ0B/+7unp+1dX/eX71ivL5TgAwAAQAxR/rsiYidvv2btq6ddcqVRwE8JCqgoigqgAAIvpKVbf29v51cHDwUxWRav2pWbdujcH04cUnPFc1EZGOjtv5hRdebv3tt9I+IupWVSaiGBxgJqhqlpnPj42NnchmsxpFUbX+mJORiE9E8eigorEzmohEHR23U1/fO63j47/+nYh2qqpJ4CcHgKEKMPOxIPBfef75PeUwDNPuoclozGxgXdMq4X/5ZWwfEe1Q1crZO/UKENGxIPCfKBbD4U2bNvo17qEeAHYJNA3+jjtuW2x4TgbAAmhyATRNy+XauK/vndaxsfEXFwk+0SIv/kNR/d2rOzwAc+TIu5ExnCeiR2vA9weB3zNXeM/zImutSUzQWfgYUpnNlapa6eCVP3slIjoShheGN2++Z1b4q6/+Q3T69Jng7Nlz0hAmODFxhq+4ol1S4AHAF5Fe3286u2PH1v5Dh9724nOX9Hf8+IfllpaWm8Mw3E2Eo4wGMMGVK1cLM6fBJ9q6cjna39W1c0tX14PW9/2q8JlMy01hGL4C4GlV/IsxHRnVHTRNi2G5BnyirbPWHty+vSe/YcOt5Pv+JfDFYrgfwBYAUNX1jGkTrDtoLU1E7CzwybEWwBsvvfSPe9evvxHGsKbAg4imwk1yBRTVTRCe5xlr7WzwibYGwOsHDry1O4qi/pnwAMDMEBEkL5YToGlaGP7E1tpaJlhNW2ut3e953rZiMfxnJXxlu4aIBJub/1gyxngiMlf4RLvRWnsQgF+tHRGp8yZYKAyUgiC4RVW75gmfaCtQ3UDLqnrUaRMsFAZKK1asuKVcLr+pqncuAD5NswAONzc3P+lsJDgD/q5Fhu/L5bJ/C8Nw1EkTXHr4tr3nzo2Obtx4NzlngssDPzKaz3d6xrBbJriM8E00mUayzvw7vEB4JaL3VfUDZjYARERgjGFrrY01FZGJtrZsoQI+ua9xIhJcKDwzHWU2T5dKpbP9/e/RNdes1h9++J7b26+TH388QwBw/fVrdGjoFJ869aXOgPcQJ0TQyPDd3Q+Pbtq0sQnTma0IF2e4Es2bCY965wQXA/67777nBX4XBlA/E6wzvEG8SFIXE3QAPtGWPyfoELyH+BXAZQq/vCboIPzymaCD8Mtngo7CJ9rSmqDj8Etrgg0Av3Qm2CDwS2OCDQK/NCbYQPCJtngm2IDwi2eCDQq/OCbYwPC/3wQbGD7dBEUkuuqqHHd0bLDbtj0iJ09+wu3t15XiFFM0mXY6zfff/+dSc3PDwieaoXy+M6mgrKzGWjU+Pp5nNq1xchEAWESsMcZYa4WZPVXtmseKjWvwF+cEK+vwkmosa22yNj8FlSxRz3Oh0kl4JCY4nyLEBWiuwk+a4PnzRXsZwk+ZIKlaam1dtSquvb1c4BONiJmzqvoiEe26zOA9ABER0X+I8CfVqcWE3wsPZnqf2ezq7n74Z5fhEQdCD4poNXgBcGEhAyKiH5TL5XOOwzMAZlWli+vtpwuPmflxAF/PdzYwM6dVajqkEQDLafBB4PdYa//d1OQ9parDc4WPD4n7dQG0lmbiJ6Uz4Z8oFsPhzZvv8ffs+Uu/MaYHwDdzhIeIYGLijFOFFymaXlQ9NbPeXkSijz/+xPT07DxGRI8T0bdzeRWMMbxy5WpxCDTdBIloSCR9s4G1loaGvsZzzz1zAsBjyUyoNRustXZGdUa9QWua4CPM/Krvp282KJVK3ueff6GHDx84bozZDWB4FhN0CbR2JLhly708PPytd+21qyNjTM2LiAiFwkDZ87xt1trXAATVZgMz77LWvpXPd85l20pdI0G21uratTfMCg8AhcJAOZNpucla+0AaPIBIRCYGB080hAl6ACAis15UreS8CrwFcLitLXu8UPgw2YvoAmjNSHDWJzUP+L5crm3vyMjoyMDAR67DT5ogZskJzhe+SilavUFrR4KYzglectGzzz4ZZTKZm4vF8NX/M/hEq7owwgCQybREvb37gmKxuBvAfcD0NpNKwwNwKJfLTpWfVoHnKl/CFU05fvoUN9D4ExWLIZ88+dkFIjoK4KsEXkSmBkBV/xsEwd6RkZ9H8/lOJiKN+7mkP1e1/wFtM6PWK/V/BwAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxNy0wOC0xMVQxMzo1NDowNC0wNDowMMrC9wEAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTctMDgtMTFUMTM6NTQ6MDQtMDQ6MDC7n0+9AAAAAElFTkSuQmCC + + + + Dashboard Layout Sample + + + diff --git a/Samples-Typescript/DashboardLayout/dashboardLayout.html b/Samples-Typescript/DashboardLayout/dashboardLayout.html new file mode 100644 index 00000000..c2253baa --- /dev/null +++ b/Samples-Typescript/DashboardLayout/dashboardLayout.html @@ -0,0 +1,28 @@ + + + + Dashboard Layout Sample + + + + + + + + + + + + + + +
+

Dashboard Layout Sample

+ +
+

Dashboard Changes

+
+
+
+ + diff --git a/Samples-Typescript/DashboardLayout/dashboardLayout.ts b/Samples-Typescript/DashboardLayout/dashboardLayout.ts new file mode 100644 index 00000000..29e6fbe9 --- /dev/null +++ b/Samples-Typescript/DashboardLayout/dashboardLayout.ts @@ -0,0 +1,154 @@ +import { DashboardLayoutChange, DashboardLayoutChangedEvent, DashboardObject, TableauEvent } from '@tableau/extensions-api-types'; + +// Wrap everything in an anonymous function to avoid polluting the global namespace +(async () => { + class DashboardLayout { + public dashboardObjects: DashboardObject[]; + private self: DashboardLayout; + + // Avoid globals. + constructor(private _$: JQueryStatic) {} + + /** + * Initializes the extension + */ + public async initialize() { + console.log('Waiting for DOM ready'); + await this._$.ready; + console.log('Initializing extension API'); + await tableau.extensions.initializeAsync(); + + const dashboard = tableau.extensions.dashboardContent.dashboard; + this.dashboardObjects = dashboard.objects; + console.log(this.dashboardObjects); + + // enabling dashboard event button + this._$('#dashboard-event-btn').prop('disabled', false); + this._$('#dashboard-event-btn').click(this.onEventButtonClick.bind(this)); + } + + // When changes are made to the dashboard we get all the details for each of the + // dashboard objects that were changed and compare it with their previous values. + // The dashboardLayoutChangeDetails property is a map of dashboard obj3ct ids to + // an array of dashboard layout changes. + // Dashboard layout change events are invoked when dashboard objects are resized, + // repositioned, added, and more. See DashboardLayoutChange in the API documentation + // for all possible actions. + // Extension reloads when worksheets are added / removed. + private onDashboardLayoutChange(event: TableauEvent) { + console.log(event); + const dashboardEvent = event as DashboardLayoutChangedEvent; + const dashboardEventDetails = dashboardEvent.dashboardLayoutChangeDetails; + const dashboard = tableau.extensions.dashboardContent.dashboard; + + // updating dashboard objects and storing the previous dashboard objects for referrence. + const oldDashboardObjects = this.dashboardObjects; + this.dashboardObjects = dashboard.objects; + + // An empty dashboard layout change event may be invoked when loading an extension from the manifest. + // In this case we ignore it and return. + if (dashboardEventDetails === undefined || dashboardEventDetails.size === 0) { + return; + } + + // Emptying previous content from the UI's change list. + this._$('#dashboard-layout-change-list').empty(); + + // Updating UI's change list to display information on the current dashboard event. + dashboardEventDetails.forEach((changesMade: DashboardLayoutChange[], dashboardObjectId: number) => { + // getting dashboard object from its id + const dashboardObject = dashboard.getDashboardObjectById(dashboardObjectId); + + // building a div for the changes made to this dashboard object. + const changesDiv = this._$('
'); + + // checking if this dashboard object was added as part of the event. + if (changesMade.includes(tableau.DashboardLayoutChange.Added)) { + const toAppend = this._$('
'); + toAppend.text(`Dashboard Object ${dashboardObjectId} added: "${dashboardObject.name}"`); + changesDiv.append(toAppend); + this._$('#dashboard-layout-change-list').append(changesDiv); + return; + } + + // getting old dashboard object before event to compare it with the current one. + const oldDashboardObject = oldDashboardObjects.find(o => o.id === dashboardObjectId); + + // checking if this dashboard object was removed as part of the event. + if (changesMade.includes(tableau.DashboardLayoutChange.Removed)) { + const toAppend = this._$('
'); + toAppend.text(`Dashboard Object ${dashboardObjectId} removed: "${oldDashboardObject.name}"`); + changesDiv.append(toAppend); + this._$('#dashboard-layout-change-list').append(changesDiv); + return; + } + + // the following dashboard changes are not mutually exclusive, so we list them together. + const h6 = this._$('
'); + h6.text(`Dashboard Object ${dashboardObjectId}: "${dashboardObject.name}"`); + changesDiv.append(h6); + const ul = this._$('
diff --git a/docs/enums/tableau.classnamekey.html b/docs/enums/tableau.classnamekey.html new file mode 100644 index 00000000..8baa96b6 --- /dev/null +++ b/docs/enums/tableau.classnamekey.html @@ -0,0 +1,352 @@ + + + + + + ClassNameKey | Dashboard Extensions + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration ClassNameKey

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

DashboardTitle

+
DashboardTitle: = "tableau-dashboard-title"
+ +
+
+ +

StoryTitle

+
StoryTitle: = "tableau-story-title"
+ +
+
+ +

Tooltip

+
Tooltip: = "tableau-tooltip"
+ +
+
+ +

Worksheet

+
Worksheet: = "tableau-worksheet"
+ +
+
+ +

WorksheetTitle

+
WorksheetTitle: = "tableau-worksheet-title"
+ +
+
+
+ +
+
+ +
+ + + + + diff --git a/docs/enums/tableau.columntype.html b/docs/enums/tableau.columntype.html index 3c9e13e6..9cbd7b8d 100644 --- a/docs/enums/tableau.columntype.html +++ b/docs/enums/tableau.columntype.html @@ -121,6 +121,9 @@

Discrete

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • diff --git a/docs/enums/tableau.dashboardlayoutchange.html b/docs/enums/tableau.dashboardlayoutchange.html new file mode 100644 index 00000000..0ff29b8c --- /dev/null +++ b/docs/enums/tableau.dashboardlayoutchange.html @@ -0,0 +1,422 @@ + + + + + + DashboardLayoutChange | Dashboard Extensions + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Enumeration DashboardLayoutChange

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Enum that represents the changes that occur to a dashboard object.

    +
    +
    +
    +
    +

    Index

    +
    + +
    +
    +
    +

    Enumeration members

    +
    + +

    Added

    +
    Added: = "added"
    + +
    +
    +

    A dashboard object was added

    +
    +
    +
    +
    + +

    IsFloatingChanged

    +
    IsFloatingChanged: = "is-floating-changed"
    + +
    +
    +

    A dashboard object's floating state changed

    +
    +
    +
    +
    + +

    IsVisibleChanged

    +
    IsVisibleChanged: = "is-visible-changed"
    + +
    +
    +

    A dashboard object's visibility changed

    +
    +
    +
    +
    + +

    NameChanged

    +
    NameChanged: = "name-changed"
    + +
    +
    +

    A dashboard object was renamed

    +
    +
    +
    +
    + +

    PositionChanged

    +
    PositionChanged: = "position-changed"
    + +
    +
    +

    A dashboard object's position changed

    +
    +
    +
    +
    + +

    Removed

    +
    Removed: = "removed"
    + +
    +
    +

    A dashboard object was removed

    +
    +
    +
    +
    + +

    SizeChanged

    +
    SizeChanged: = "size-changed"
    + +
    +
    +

    A dashboard object's size changed

    +
    +
    +
    +
    +
    + +
    +
    + +
    + + + + + diff --git a/docs/enums/tableau.dashboardobjecttype.html b/docs/enums/tableau.dashboardobjecttype.html index adf5beae..e6cbc493 100644 --- a/docs/enums/tableau.dashboardobjecttype.html +++ b/docs/enums/tableau.dashboardobjecttype.html @@ -105,7 +105,7 @@

    Blank

    Blank: = "blank"
    @@ -115,7 +115,7 @@

    Extension

    Extension: = "extension"
    @@ -125,7 +125,7 @@

    Image

    Image: = "image"
    @@ -135,7 +135,7 @@

    Legend

    Legend: = "legend"
    @@ -145,7 +145,7 @@

    PageFilter

    PageFilter: = "page-filter"
    @@ -155,7 +155,7 @@

    ParameterControl

    ParameterControl: = "parameter-control"
    @@ -165,7 +165,7 @@

    QuickFilter

    QuickFilter: = "quick-filter"
    @@ -175,7 +175,7 @@

    Text

    Text: = "text"
    @@ -185,7 +185,7 @@

    Title

    Title: = "title"
    @@ -195,7 +195,7 @@

    WebPage

    WebPage: = "web-page"
    @@ -205,7 +205,7 @@

    Worksheet

    Worksheet: = "worksheet"
    @@ -227,9 +227,15 @@

    Worksheet

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • diff --git a/docs/enums/tableau.dashboardobjectvisibilitytype.html b/docs/enums/tableau.dashboardobjectvisibilitytype.html new file mode 100644 index 00000000..822122d8 --- /dev/null +++ b/docs/enums/tableau.dashboardobjectvisibilitytype.html @@ -0,0 +1,332 @@ + + + + + + DashboardObjectVisibilityType | Dashboard Extensions + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Enumeration DashboardObjectVisibilityType

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Enum that represents the visibility state of a dashboard object.

    +
    +
    +
    since
    +

    1.7.0

    +
    +
    +
    +
    +
    +

    Index

    +
    +
    +
    +

    Enumeration members

    + +
    +
    +
    +
    +
    +

    Enumeration members

    +
    + +

    Hide

    +
    Hide: = "hide"
    + +
    +
    +

    Used for turning off the visibility of a dashboard object.

    +
    +
    +
    +
    + +

    Show

    +
    Show: = "show"
    + +
    +
    +

    Used for turning on the visibility of a dashboard object.

    +
    +
    +
    +
    +
    + +
    +
    + +
    + + + + + diff --git a/docs/enums/tableau.datatype.html b/docs/enums/tableau.datatype.html index e8cd172f..523aa48a 100644 --- a/docs/enums/tableau.datatype.html +++ b/docs/enums/tableau.datatype.html @@ -101,7 +101,7 @@

    Bool

    Bool: = "bool"
    @@ -111,7 +111,7 @@

    Date

    Date: = "date"
    @@ -121,7 +121,7 @@

    DateTime

    DateTime: = "date-time"
    @@ -131,7 +131,7 @@

    Float

    Float: = "float"
    @@ -141,7 +141,7 @@

    Int

    Int: = "int"
    @@ -151,7 +151,7 @@

    Spatial

    Spatial: = "spatial"
    @@ -161,7 +161,7 @@

    String

    String: = "string"
    @@ -183,12 +183,21 @@

    String

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • diff --git a/docs/enums/tableau.daterangetype.html b/docs/enums/tableau.daterangetype.html index 714c5d23..0350dce7 100644 --- a/docs/enums/tableau.daterangetype.html +++ b/docs/enums/tableau.daterangetype.html @@ -100,7 +100,7 @@

    Current

    Current: = "current"
    @@ -110,7 +110,7 @@

    Last

    Last: = "last"
    @@ -120,7 +120,7 @@

    LastN

    LastN: = "last-n"
    @@ -130,7 +130,7 @@

    Next

    Next: = "next"
    @@ -140,7 +140,7 @@

    NextN

    NextN: = "next-n"
    @@ -150,7 +150,7 @@

    ToDate

    ToDate: = "to-date"
    @@ -172,12 +172,21 @@

    ToDate

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -253,6 +262,9 @@

    ToDate

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -271,12 +283,15 @@

    ToDate

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.encodingtype.html b/docs/enums/tableau.encodingtype.html index 3b57e0cc..6b05ce80 100644 --- a/docs/enums/tableau.encodingtype.html +++ b/docs/enums/tableau.encodingtype.html @@ -101,7 +101,7 @@

    Angle

    Angle: = "angle"
    @@ -111,7 +111,7 @@

    Color

    Color: = "color"
    @@ -121,7 +121,7 @@

    Column

    Column: = "column"
    @@ -131,7 +131,7 @@

    Detail

    Detail: = "detail"
    @@ -141,7 +141,7 @@

    Filter

    Filter: = "filter"
    @@ -151,7 +151,7 @@

    Label

    Label: = "label"
    @@ -161,7 +161,7 @@

    MarksType

    MarksType: = "marks-type"
    @@ -171,7 +171,7 @@

    MeasureValues

    MeasureValues: = "measure-values"
    @@ -181,7 +181,7 @@

    Page

    Page: = "page"
    @@ -191,7 +191,7 @@

    Path

    Path: = "path"
    @@ -201,7 +201,7 @@

    Row

    Row: = "row"
    @@ -211,7 +211,7 @@

    Shape

    Shape: = "shape"
    @@ -221,7 +221,7 @@

    Size

    Size: = "size"
    @@ -231,7 +231,7 @@

    Tooltip

    Tooltip: = "tooltip"
    @@ -253,12 +253,21 @@

    Tooltip

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -358,6 +367,9 @@

    Tooltip

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -376,12 +388,15 @@

    Tooltip

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.errorcodes.html b/docs/enums/tableau.errorcodes.html index 94856d7b..2300bd01 100644 --- a/docs/enums/tableau.errorcodes.html +++ b/docs/enums/tableau.errorcodes.html @@ -314,12 +314,21 @@

    VisibilityError

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -416,6 +425,9 @@

    VisibilityError

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -434,12 +446,15 @@

    VisibilityError

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.extensioncontext.html b/docs/enums/tableau.extensioncontext.html index 83434f69..7fa2cab4 100644 --- a/docs/enums/tableau.extensioncontext.html +++ b/docs/enums/tableau.extensioncontext.html @@ -128,12 +128,21 @@

    Server

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -197,6 +206,9 @@

    Server

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -215,12 +227,15 @@

    Server

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.extensionmode.html b/docs/enums/tableau.extensionmode.html index 47f56d19..9c417a33 100644 --- a/docs/enums/tableau.extensionmode.html +++ b/docs/enums/tableau.extensionmode.html @@ -128,12 +128,21 @@

    Viewing

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -197,6 +206,9 @@

    Viewing

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -215,12 +227,15 @@

    Viewing

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.fieldaggregationtype.html b/docs/enums/tableau.fieldaggregationtype.html index 2a77730e..b91205c3 100644 --- a/docs/enums/tableau.fieldaggregationtype.html +++ b/docs/enums/tableau.fieldaggregationtype.html @@ -133,7 +133,7 @@

    Attr

    Attr: = "attr"
    @@ -143,7 +143,7 @@

    Avg

    Avg: = "avg"
    @@ -153,7 +153,7 @@

    Count

    Count: = "count"
    @@ -163,7 +163,7 @@

    Countd

    Countd: = "countd"
    @@ -173,7 +173,7 @@

    Day

    Day: = "day"
    @@ -183,7 +183,7 @@

    End

    End: = "end"
    @@ -193,7 +193,7 @@

    Hour

    Hour: = "hour"
    @@ -203,7 +203,7 @@

    InOut

    InOut: = "in-out"
    @@ -213,7 +213,7 @@

    Kurtosis

    Kurtosis: = "kurtosis"
    @@ -223,7 +223,7 @@

    Max

    Max: = "max"
    @@ -233,7 +233,7 @@

    Mdy

    Mdy: = "mdy"
    @@ -243,7 +243,7 @@

    Median

    Median: = "median"
    @@ -253,7 +253,7 @@

    Min

    Min: = "min"
    @@ -263,7 +263,7 @@

    Minute

    Minute: = "minute"
    @@ -273,7 +273,7 @@

    Month

    Month: = "month"
    @@ -283,7 +283,7 @@

    MonthYear

    MonthYear: = "month-year"
    @@ -293,7 +293,7 @@

    None

    None: = "none"
    @@ -303,7 +303,7 @@

    Qtr

    Qtr: = "qtr"
    @@ -313,7 +313,7 @@

    Quart1

    Quart1: = "quart1"
    @@ -323,7 +323,7 @@

    Quart3

    Quart3: = "quart3"
    @@ -333,7 +333,7 @@

    Second

    Second: = "second"
    @@ -343,7 +343,7 @@

    Skewness

    Skewness: = "skewness"
    @@ -353,7 +353,7 @@

    Stdev

    Stdev: = "stdev"
    @@ -363,7 +363,7 @@

    Stdevp

    Stdevp: = "stdevp"
    @@ -373,7 +373,7 @@

    Sum

    Sum: = "sum"
    @@ -383,7 +383,7 @@

    TruncDay

    TruncDay: = "trunc-day"
    @@ -393,7 +393,7 @@

    TruncHour

    TruncHour: = "trunc-hour"
    @@ -403,7 +403,7 @@

    TruncMinute

    TruncMinute: = "trunc-minute"
    @@ -413,7 +413,7 @@

    TruncMonth

    TruncMonth: = "trunc-month"
    @@ -423,7 +423,7 @@

    TruncQtr

    TruncQtr: = "trunc-qtr"
    @@ -433,7 +433,7 @@

    TruncSecond

    TruncSecond: = "trunc-second"
    @@ -443,7 +443,7 @@

    TruncWeek

    TruncWeek: = "trunc-week"
    @@ -453,7 +453,7 @@

    TruncYear

    TruncYear: = "trunc-year"
    @@ -463,7 +463,7 @@

    User

    User: = "user"
    @@ -473,7 +473,7 @@

    Var

    Var: = "var"
    @@ -483,7 +483,7 @@

    Varp

    Varp: = "varp"
    @@ -493,7 +493,7 @@

    Week

    Week: = "week"
    @@ -503,7 +503,7 @@

    Weekday

    Weekday: = "weekday"
    @@ -513,7 +513,7 @@

    Year

    Year: = "year"
    @@ -535,12 +535,21 @@

    Year

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -715,6 +724,9 @@

    Year

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -733,12 +745,15 @@

    Year

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.fieldroletype.html b/docs/enums/tableau.fieldroletype.html index 34ec3a69..fdcad4d5 100644 --- a/docs/enums/tableau.fieldroletype.html +++ b/docs/enums/tableau.fieldroletype.html @@ -97,7 +97,7 @@

    Dimension

    Dimension: = "dimension"
    @@ -107,7 +107,7 @@

    Measure

    Measure: = "measure"
    @@ -117,7 +117,7 @@

    Unknown

    Unknown: = "unknown"
    @@ -139,12 +139,21 @@

    Unknown

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -211,6 +220,9 @@

    Unknown

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -229,12 +241,15 @@

    Unknown

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.filterdomaintype.html b/docs/enums/tableau.filterdomaintype.html index 5a3356c4..e9bf5680 100644 --- a/docs/enums/tableau.filterdomaintype.html +++ b/docs/enums/tableau.filterdomaintype.html @@ -96,7 +96,7 @@

    Database

    Database: = "database"
    @@ -111,7 +111,7 @@

    Relevant

    Relevant: = "relevant"
    @@ -139,12 +139,21 @@

    Relevant

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -208,6 +217,9 @@

    Relevant

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -226,12 +238,15 @@

    Relevant

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.filternulloption.html b/docs/enums/tableau.filternulloption.html index 0e6ba31c..df4ed365 100644 --- a/docs/enums/tableau.filternulloption.html +++ b/docs/enums/tableau.filternulloption.html @@ -98,7 +98,7 @@

    AllValues

    AllValues: = "all-values"
    @@ -108,7 +108,7 @@

    NonNullValues

    NonNullValues: = "non-null-values"
    @@ -118,7 +118,7 @@

    NullValues

    NullValues: = "null-values"
    @@ -140,12 +140,21 @@

    NullValues

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -212,6 +221,9 @@

    NullValues

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -230,12 +242,15 @@

    NullValues

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.filtertype.html b/docs/enums/tableau.filtertype.html index b09a498d..d19557f3 100644 --- a/docs/enums/tableau.filtertype.html +++ b/docs/enums/tableau.filtertype.html @@ -98,7 +98,7 @@

    Categorical

    Categorical: = "categorical"
    @@ -108,7 +108,7 @@

    Hierarchical

    Hierarchical: = "hierarchical"
    @@ -118,7 +118,7 @@

    Range

    Range: = "range"
    @@ -128,7 +128,7 @@

    RelativeDate

    RelativeDate: = "relative-date"
    @@ -150,12 +150,21 @@

    RelativeDate

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -225,6 +234,9 @@

    RelativeDate

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -243,12 +255,15 @@

    RelativeDate

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.filterupdatetype.html b/docs/enums/tableau.filterupdatetype.html index 46514f47..436d96a2 100644 --- a/docs/enums/tableau.filterupdatetype.html +++ b/docs/enums/tableau.filterupdatetype.html @@ -98,7 +98,7 @@

    Add

    Add: = "add"
    @@ -108,7 +108,7 @@

    All

    All: = "all"
    @@ -118,7 +118,7 @@

    Remove

    Remove: = "remove"
    @@ -128,7 +128,7 @@

    Replace

    Replace: = "replace"
    @@ -150,12 +150,21 @@

    Replace

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -225,6 +234,9 @@

    Replace

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -243,12 +255,15 @@

    Replace

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.includedatavaluesoption.html b/docs/enums/tableau.includedatavaluesoption.html index 4b55a46d..289a32e9 100644 --- a/docs/enums/tableau.includedatavaluesoption.html +++ b/docs/enums/tableau.includedatavaluesoption.html @@ -106,7 +106,7 @@

    AllValues

    AllValues: = "all-values"
    @@ -121,7 +121,7 @@

    OnlyFormattedValues

    OnlyFormattedValues: = "only-formatted-values"
    @@ -136,7 +136,7 @@

    OnlyNativeValues

    OnlyNativeValues: = "only-native-values"
    diff --git a/docs/enums/tableau.marktype.html b/docs/enums/tableau.marktype.html index 77be0fc1..acf4768f 100644 --- a/docs/enums/tableau.marktype.html +++ b/docs/enums/tableau.marktype.html @@ -105,7 +105,7 @@

    Area

    Area: = "area"
    @@ -115,7 +115,7 @@

    Bar

    Bar: = "bar"
    @@ -125,7 +125,7 @@

    Circle

    Circle: = "circle"
    @@ -135,7 +135,7 @@

    GanttBar

    GanttBar: = "gantt-bar"
    @@ -145,7 +145,7 @@

    Line

    Line: = "line"
    @@ -155,7 +155,7 @@

    Map

    Map: = "map"
    @@ -165,7 +165,7 @@

    Pie

    Pie: = "pie"
    @@ -175,7 +175,7 @@

    Polygon

    Polygon: = "polygon"
    @@ -185,7 +185,7 @@

    Shape

    Shape: = "shape"
    @@ -195,7 +195,7 @@

    Square

    Square: = "square"
    @@ -205,7 +205,7 @@

    Text

    Text: = "text"
    @@ -227,12 +227,21 @@

    Text

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -323,6 +332,9 @@

    Text

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -341,12 +353,15 @@

    Text

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.parametervaluetype.html b/docs/enums/tableau.parametervaluetype.html index 7248247f..73cb0b3b 100644 --- a/docs/enums/tableau.parametervaluetype.html +++ b/docs/enums/tableau.parametervaluetype.html @@ -98,7 +98,7 @@

    All

    All: = "all"
    @@ -108,7 +108,7 @@

    List

    List: = "list"
    @@ -118,7 +118,7 @@

    Range

    Range: = "range"
    @@ -140,12 +140,21 @@

    Range

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -212,6 +221,9 @@

    Range

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -230,12 +242,15 @@

    Range

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.periodtype.html b/docs/enums/tableau.periodtype.html index 1b2b483f..78bdfb23 100644 --- a/docs/enums/tableau.periodtype.html +++ b/docs/enums/tableau.periodtype.html @@ -102,7 +102,7 @@

    Days

    Days: = "days"
    @@ -112,7 +112,7 @@

    Hours

    Hours: = "hours"
    @@ -122,7 +122,7 @@

    Minutes

    Minutes: = "minutes"
    @@ -132,7 +132,7 @@

    Months

    Months: = "months"
    @@ -142,7 +142,7 @@

    Quarters

    Quarters: = "quarters"
    @@ -152,7 +152,7 @@

    Seconds

    Seconds: = "seconds"
    @@ -162,7 +162,7 @@

    Weeks

    Weeks: = "weeks"
    @@ -172,7 +172,7 @@

    Years

    Years: = "years"
    @@ -194,12 +194,21 @@

    Years

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -281,6 +290,9 @@

    Years

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -299,12 +311,15 @@

    Years

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.quicktablecalctype.html b/docs/enums/tableau.quicktablecalctype.html index cd7eb619..c56901aa 100644 --- a/docs/enums/tableau.quicktablecalctype.html +++ b/docs/enums/tableau.quicktablecalctype.html @@ -99,7 +99,7 @@

    CompoundGrowthRate

    CompoundGrowthRate: = "compound-growth-rate"
    @@ -109,7 +109,7 @@

    Difference

    Difference: = "difference"
    @@ -119,7 +119,7 @@

    MovingAverage

    MovingAverage: = "moving-average"
    @@ -129,7 +129,7 @@

    PercentDifference

    PercentDifference: = "percent-difference"
    @@ -139,7 +139,7 @@

    PercentOfTotal

    PercentOfTotal: = "percent-of-total"
    @@ -149,7 +149,7 @@

    Percentile

    Percentile: = "percentile"
    @@ -159,7 +159,7 @@

    Rank

    Rank: = "rank"
    @@ -169,7 +169,7 @@

    RunningTotal

    RunningTotal: = "running-total"
    @@ -179,7 +179,7 @@

    Undefined

    Undefined: = "undefined"
    @@ -189,7 +189,7 @@

    YTDGrowth

    YTDGrowth: = "ytd-growth"
    @@ -199,7 +199,7 @@

    YTDTotal

    YTDTotal: = "ytd-total"
    @@ -209,7 +209,7 @@

    YearOverYearGrowth

    YearOverYearGrowth: = "year-over-year-growth"
    @@ -231,12 +231,21 @@

    YearOverYearGrowth

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -330,6 +339,9 @@

    YearOverYearGrowth

    diff --git a/docs/enums/tableau.replayspeedtype.html b/docs/enums/tableau.replayspeedtype.html new file mode 100644 index 00000000..62aec4e7 --- /dev/null +++ b/docs/enums/tableau.replayspeedtype.html @@ -0,0 +1,351 @@ + + + + + + ReplaySpeedType | Dashboard Extensions + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Enumeration ReplaySpeedType

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Enum that represents the replay speed of an animation.

    +
    +
    +
    since
    +

    1.7.0

    +
    +
    +
    +
    +
    +

    Index

    +
    +
    +
    +

    Enumeration members

    + +
    +
    +
    +
    +
    +

    Enumeration members

    +
    + +

    Fast

    +
    Fast: = "fast"
    + +
    +
    +

    Used for setting the replay speed of an animation to 2.0x.

    +
    +
    +
    +
    + +

    Normal

    +
    Normal: = "normal"
    + +
    +
    +

    Used for setting the replay speed of an animation to 1.0x.

    +
    +
    +
    +
    + +

    Slow

    +
    Slow: = "slow"
    + +
    +
    +

    Used for setting the replay speed of an animation to 0.5x.

    +
    +
    +
    +
    +
    + +
    +
    + +
    + + + + + diff --git a/docs/enums/tableau.selectionupdatetype.html b/docs/enums/tableau.selectionupdatetype.html index 94b9734a..c191993e 100644 --- a/docs/enums/tableau.selectionupdatetype.html +++ b/docs/enums/tableau.selectionupdatetype.html @@ -97,7 +97,7 @@

    Add

    Add: = "select-add"
    @@ -107,7 +107,7 @@

    Remove

    Remove: = "select-remove"
    @@ -117,7 +117,7 @@

    Replace

    Replace: = "select-replace"
    @@ -139,12 +139,21 @@

    Replace

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -196,6 +205,9 @@

    Replace

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • diff --git a/docs/enums/tableau.sheettype.html b/docs/enums/tableau.sheettype.html index 376361a3..3126c408 100644 --- a/docs/enums/tableau.sheettype.html +++ b/docs/enums/tableau.sheettype.html @@ -97,7 +97,7 @@

    Dashboard

    Dashboard: = "dashboard"
    @@ -107,7 +107,7 @@

    Story

    Story: = "story"
    @@ -117,7 +117,7 @@

    Worksheet

    Worksheet: = "worksheet"
    @@ -139,12 +139,21 @@

    Worksheet

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -196,6 +205,9 @@

    Worksheet

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -229,12 +241,15 @@

    Worksheet

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.sortdirection.html b/docs/enums/tableau.sortdirection.html index 63c65b8a..d37f9b1a 100644 --- a/docs/enums/tableau.sortdirection.html +++ b/docs/enums/tableau.sortdirection.html @@ -89,7 +89,7 @@

    Decreasing

    Decreasing: = "decreasing"
    @@ -99,7 +99,7 @@

    Increasing

    Increasing: = "increasing"
    @@ -121,12 +121,21 @@

    Increasing

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -178,6 +187,9 @@

    Increasing

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -208,12 +220,15 @@

    Increasing

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.tableaueventtype.html b/docs/enums/tableau.tableaueventtype.html index b6fa61f1..8bb91fe7 100644 --- a/docs/enums/tableau.tableaueventtype.html +++ b/docs/enums/tableau.tableaueventtype.html @@ -81,12 +81,12 @@

    Index

    Enumeration members

    @@ -95,47 +95,32 @@

    Enumeration members

    Enumeration members

    - -

    FilterChanged

    -
    FilterChanged: = "filter-changed"
    - -
    -
    -

    Raised when any filter has changed state. You can use this event type with Worksheet objects.

    -
    -
    -
    -
    - -

    FirstInteractive

    -
    FirstInteractive: = "first-interactive"
    + +

    DashboardLayoutChanged

    +
    DashboardLayoutChanged: = "dashboard-layout-changed"
    -

    Fired when a viz first becomes interactive when embedded

    +

    The dashboard layout has changed

    - -

    FirstVizSizeKnown

    -
    FirstVizSizeKnown: = "first-viz-size-known"
    + +

    FilterChanged

    +
    FilterChanged: = "filter-changed"
    -

    Fired when viz size is known when embedded

    +

    Raised when any filter has changed state. You can use this event type with Worksheet objects.

    @@ -145,7 +130,7 @@

    MarkSelectionChanged

    MarkSelectionChanged: = "mark-selection-changed"
    @@ -161,7 +146,7 @@

    ParameterChanged

    ParameterChanged: = "parameter-changed"
    @@ -176,7 +161,7 @@

    SettingsChanged

    SettingsChanged: = "settings-changed"
    @@ -185,6 +170,21 @@

    SettingsChanged

    +
    + +

    WorkbookFormattingChanged

    +
    WorkbookFormattingChanged: = "workbook-formatting-changed"
    + +
    +
    +

    The workbook formatting has changed

    +
    +
    +
    diff --git a/docs/enums/tableau.trendlinemodeltype.html b/docs/enums/tableau.trendlinemodeltype.html index b2ad4e5c..533a1d3c 100644 --- a/docs/enums/tableau.trendlinemodeltype.html +++ b/docs/enums/tableau.trendlinemodeltype.html @@ -91,7 +91,7 @@

    Exponential

    Exponential: = "exponential"
    @@ -101,7 +101,7 @@

    Linear

    Linear: = "linear"
    @@ -111,7 +111,7 @@

    Logarithmic

    Logarithmic: = "logarithmic"
    @@ -121,7 +121,7 @@

    Polynomial

    Polynomial: = "polynomial"
    @@ -143,12 +143,21 @@

    Polynomial

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -200,6 +209,9 @@

    Polynomial

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -236,12 +248,15 @@

    Polynomial

  • VizImageEncodingType
  • -
  • - ZoneVisibilityType +
  • + ZoneVisibilityType
  • extensions
  • +
  • + ZoneVisibilityType +
  • diff --git a/docs/enums/tableau.vizimageencodingtype.html b/docs/enums/tableau.vizimageencodingtype.html index 9ebe8e53..e77e1778 100644 --- a/docs/enums/tableau.vizimageencodingtype.html +++ b/docs/enums/tableau.vizimageencodingtype.html @@ -101,7 +101,7 @@

    Continuous

    Continuous: = "continuous"
    @@ -111,7 +111,7 @@

    Discrete

    Discrete: = "discrete"
    @@ -133,12 +133,21 @@

    Discrete

  • AnalyticsObjectType
  • +
  • + ClassNameKey +
  • ColumnType
  • +
  • + DashboardLayoutChange +
  • DashboardObjectType
  • +
  • + DashboardObjectVisibilityType +
  • DataType
  • @@ -190,6 +199,9 @@

    Discrete

  • QuickTableCalcType
  • +
  • + ReplaySpeedType +
  • SelectionUpdateType
  • @@ -220,12 +232,15 @@

    Discrete

    diff --git a/docs/globals.html b/docs/globals.html index 66012001..d12e29e4 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -80,7 +80,9 @@

    Interfaces

  • ConnectionSummary
  • Dashboard
  • DashboardContent
  • +
  • DashboardLayoutChangedEvent
  • DashboardObject
  • +
  • DashboardObjectPositionAndSizeUpdate
  • DataSource
  • DataSourceUnderlyingDataOptions
  • DataTable
  • @@ -93,6 +95,7 @@

    Interfaces

  • Filter
  • FilterChangedEvent
  • FilterOptions
  • +
  • FormattingSheet
  • GetSummaryDataOptions
  • GetUnderlyingDataOptions
  • HierarchicalFilterOptions
  • @@ -124,6 +127,8 @@

    Interfaces

  • TableauWorksheetEvent
  • UI
  • Workbook
  • +
  • WorkbookFormatting
  • +
  • WorkbookFormattingChangedEvent
  • Worksheet
  • @@ -131,6 +136,9 @@

    Interfaces

    Type aliases

    +
    + +

    getDashboardObjectById

    + + +

    getParametersAsync

    @@ -344,7 +389,7 @@

    getParametersAsync

    @@ -354,6 +399,62 @@

    Returns Promise

    +
    + +

    moveAndResizeDashboardObjectsAsync

    + + +

    removeEventListener

    @@ -365,7 +466,7 @@

    removeEventListener

    @@ -390,6 +491,93 @@

    Returns boolean

    +
    + +

    replayAnimationAsync

    + + +
    +
    + +

    setDashboardObjectVisibilityAsync

    + + +

    setZoneVisibilityAsync

    @@ -400,7 +588,7 @@

    setZoneVisibilityAsync

  • @@ -411,6 +599,9 @@

    setZoneVisibilityAsync

    since

    1.1.0

    +
    +
    deprecated
    +

    use setDashboardObjectVisibilityAsync

    The following example shows how you can update the visibility of multiple (valid, floating) zones in a dashboard

      var zoneVisibilityMap = {};
    @@ -482,12 +673,24 @@ 

    Returns Promise findParameterAsync

  • +
  • + getDashboardObjectById +
  • getParametersAsync
  • +
  • + moveAndResizeDashboardObjectsAsync +
  • removeEventListener
  • +
  • + replayAnimationAsync +
  • +
  • + setDashboardObjectVisibilityAsync +
  • setZoneVisibilityAsync
  • diff --git a/docs/interfaces/dashboardlayoutchangedevent.html b/docs/interfaces/dashboardlayoutchangedevent.html new file mode 100644 index 00000000..753cbed6 --- /dev/null +++ b/docs/interfaces/dashboardlayoutchangedevent.html @@ -0,0 +1,249 @@ + + + + + + DashboardLayoutChangedEvent | Dashboard Extensions + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    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.

    +
    +
    +
    since
    +

    1.7.0 and Tableau 2021.4

    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + TableauEvent +
        +
      • + DashboardLayoutChangedEvent +
      • +
      +
    • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Properties

    + +
    +
    +
    +
    +
    +

    Properties

    +
    + +

    dashboardLayoutChangeDetails

    +
    dashboardLayoutChangeDetails: DashboardLayoutChangeDetails
    + +
    +
    +
    returns
    +

    a map of dashboard object id's to an array of dashboard object layout changes

    +
    +
    +
    +
    +
    + +

    type

    + + +
    +
    +
    returns
    +

    The type of event which this class is representing.

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
    • +
    • Object literal
    • +
    • Variable
    • +
    • Function
    • +
    • Function with type parameter
    • +
    • Index signature
    • +
    • Type alias
    • +
    • Type alias with type parameter
    • +
    +
      +
    • Enumeration
    • +
    • Enumeration member
    • +
    • Property
    • +
    • Method
    • +
    +
      +
    • Interface
    • +
    • Interface with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Index signature
    • +
    +
      +
    • Class
    • +
    • Class with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Accessor
    • +
    • Index signature
    • +
    +
      +
    • Inherited constructor
    • +
    • Inherited property
    • +
    • Inherited method
    • +
    • Inherited accessor
    • +
    +
      +
    • Protected property
    • +
    • Protected method
    • +
    • Protected accessor
    • +
    +
      +
    • Private property
    • +
    • Private method
    • +
    • Private accessor
    • +
    +
      +
    • Static property
    • +
    • Static method
    • +
    +
    +
    +
    +
    + + + + + diff --git a/docs/interfaces/dashboardobject.html b/docs/interfaces/dashboardobject.html index 667a7a4d..205d2bff 100644 --- a/docs/interfaces/dashboardobject.html +++ b/docs/interfaces/dashboardobject.html @@ -108,7 +108,7 @@

    dashboard

    dashboard: Dashboard
    @@ -125,7 +125,7 @@

    id

    id: number
    @@ -145,7 +145,7 @@

    isFloating

    isFloating: boolean
    @@ -165,7 +165,7 @@

    isVisible

    isVisible: boolean
    @@ -185,7 +185,7 @@

    name

    name: string
    @@ -205,7 +205,7 @@

    position

    position: Point
    @@ -222,7 +222,7 @@

    size

    size: Size
    @@ -239,7 +239,7 @@

    type

    @@ -256,7 +256,7 @@

    worksheet

    worksheet: Worksheet | undefined
    diff --git a/docs/interfaces/dashboardobjectpositionandsizeupdate.html b/docs/interfaces/dashboardobjectpositionandsizeupdate.html new file mode 100644 index 00000000..5174cd73 --- /dev/null +++ b/docs/interfaces/dashboardobjectpositionandsizeupdate.html @@ -0,0 +1,300 @@ + + + + + + DashboardObjectPositionAndSizeUpdate | Dashboard Extensions + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Interface DashboardObjectPositionAndSizeUpdate

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    An object to specify a dashboard object and its new position and size in a dashboard.

    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + DashboardObjectPositionAndSizeUpdate +
    • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Properties

    + +
    +
    +
    +
    +
    +

    Properties

    +
    + +

    dashboardObjectID

    +
    dashboardObjectID: number
    + +
    +
    +
    returns
    +

    dashboard object ID

    +
    +
    +
    +
    +
    + +

    height

    +
    height: number
    + +
    +
    +
    returns
    +

    height

    +
    +
    +
    +
    +
    + +

    width

    +
    width: number
    + +
    +
    +
    returns
    +

    width

    +
    +
    +
    +
    +
    + +

    x

    +
    x: number
    + +
    +
    +
    returns
    +

    X coordinate

    +
    +
    +
    +
    +
    + +

    y

    +
    y: number
    + +
    +
    +
    returns
    +

    Y coordinate

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
    • +
    • Object literal
    • +
    • Variable
    • +
    • Function
    • +
    • Function with type parameter
    • +
    • Index signature
    • +
    • Type alias
    • +
    • Type alias with type parameter
    • +
    +
      +
    • Enumeration
    • +
    • Enumeration member
    • +
    • Property
    • +
    • Method
    • +
    +
      +
    • Interface
    • +
    • Interface with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Index signature
    • +
    +
      +
    • Class
    • +
    • Class with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Accessor
    • +
    • Index signature
    • +
    +
      +
    • Inherited constructor
    • +
    • Inherited property
    • +
    • Inherited method
    • +
    • Inherited accessor
    • +
    +
      +
    • Protected property
    • +
    • Protected method
    • +
    • Protected accessor
    • +
    +
      +
    • Private property
    • +
    • Private method
    • +
    • Private accessor
    • +
    +
      +
    • Static property
    • +
    • Static method
    • +
    +
    +
    +
    +
    + + + + + diff --git a/docs/interfaces/datasource.html b/docs/interfaces/datasource.html index 18167fef..7560dcad 100644 --- a/docs/interfaces/datasource.html +++ b/docs/interfaces/datasource.html @@ -90,6 +90,7 @@

    Properties

  • fields
  • id
  • isExtract
  • +
  • isPublished
  • name
  • @@ -101,6 +102,7 @@

    Methods

  • getLogicalTableDataAsync
  • getLogicalTablesAsync
  • getUnderlyingDataAsync
  • +
  • publishedUrl
  • refreshAsync
  • @@ -177,6 +179,26 @@

    isExtract

    +
    + +

    isPublished

    +
    isPublished: boolean | undefined
    + +
    +
    +
    returns
    +

    True if this data source is published to server, false otherwise. Always undefined prior to Tableau 2021.4.

    +
    +
    since
    +

    1.7.0 and Tableau 2021.4

    +
    +
    +
    +

    name

    @@ -207,7 +229,7 @@

    getActiveTablesAsync

  • @@ -235,7 +257,7 @@

    getConnectionSummariesAsync

  • @@ -255,7 +277,7 @@

    getLogicalTableDataAsync

  • @@ -322,7 +344,7 @@

    getLogicalTablesAsync

  • @@ -358,7 +380,7 @@

    getUnderlyingDataAsync

  • @@ -397,6 +419,37 @@

    Returns Promise

  • +
    + +

    publishedUrl

    + + +

    refreshAsync

    @@ -407,7 +460,7 @@

    refreshAsync

  • @@ -457,6 +510,9 @@

    Returns Promise isExtract

  • +
  • + isPublished +
  • name
  • @@ -475,6 +531,9 @@

    Returns Promise getUnderlyingDataAsync +
  • + publishedUrl +
  • refreshAsync
  • diff --git a/docs/interfaces/datasourceunderlyingdataoptions.html b/docs/interfaces/datasourceunderlyingdataoptions.html index b8782ace..3bcfbeb0 100644 --- a/docs/interfaces/datasourceunderlyingdataoptions.html +++ b/docs/interfaces/datasourceunderlyingdataoptions.html @@ -104,7 +104,7 @@

    Optional columnsToInclude
    columnsToInclude: Array<string>
    @@ -119,7 +119,7 @@

    Optional columnsToInclude
    columnsToIncludeById: Array<string>
    @@ -140,7 +140,7 @@

    Optional ignoreAliasesignoreAliases: undefined | false | true

    @@ -155,7 +155,7 @@

    Optional includeData
    includeDataValuesOption: IncludeDataValuesOption
    @@ -177,7 +177,7 @@

    Optional maxRows

    maxRows: undefined | number
    diff --git a/docs/interfaces/environment.html b/docs/interfaces/environment.html index 2a853a71..357d888e 100644 --- a/docs/interfaces/environment.html +++ b/docs/interfaces/environment.html @@ -94,6 +94,7 @@

    Properties

  • mode
  • operatingSystem
  • tableauVersion
  • +
  • workbookFormatting
  • @@ -107,7 +108,7 @@

    apiVersion

    apiVersion: string
    @@ -124,7 +125,7 @@

    context

    @@ -141,7 +142,7 @@

    language

    language: string
    @@ -158,7 +159,7 @@

    locale

    locale: string
    @@ -175,7 +176,7 @@

    mode

    @@ -192,7 +193,7 @@

    operatingSystem

    operatingSystem: string
    @@ -209,7 +210,7 @@

    tableauVersion

    tableauVersion: string
    @@ -220,6 +221,31 @@

    tableauVersion

    +
    + +

    Optional workbookFormatting

    +
    workbookFormatting: WorkbookFormatting
    + +
    +
    +
    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.

    +
    +
    since
    +

    1.7.0 and Tableau 2021.4

    +
    +
    +
    +
    +
    + +

    dashboardObjectId

    +
    dashboardObjectId: number
    + +
    +
    +

    The dashboard object id for the extension that is running.

    +
    +
    +
    since
    +

    1.7.0

    +
    +
    +
    +

    environment

    @@ -209,7 +231,7 @@

    createVizImageAsync

  • @@ -326,6 +348,51 @@

    Returns Promise

  • +
    + +

    setClickThroughAsync

    +
      +
    • setClickThroughAsync(clickThroughEnabled: boolean): Promise<void>
    • +
    +
      +
    • + +
      +
      +

      This method allows for clicks to pass through the extension window on Tableau Server.

      +
      +
      +
      since
      +

      1.7.0 and Tableau 2021.4

      +
      +
      +
      +

      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);
      +    });
      +
    • +
    +