Salesforce Docs Portal

EmbeddingErrorCodes | Tableau Embedding API

Enumeration EmbeddingErrorCodes

All error codes used by the Embedding API.

Index

Enumeration Members

AuthFailed BrowserNotCapable DownloadWorkbookNotAllowed EventInitializationError FilterCannotBePerformed FilterMissingOrNotImplemented ImplementationError IncompatibleVersionError IndexOutOfRange InternalError InvalidCustomViewName InvalidDateParameter invalidFilterFieldNameOrValue InvalidParameter InvalidSize InvalidSizeBehavior InvalidSizeBehaviorOnWorksheet InvalidTimeDimension InvalidUrl MissingMaxSize MissingMinMaxSize MissingMinSize MissingParameter MissingRangeNForRelativeDateFilters NotActiveSheet NoUrlForHiddenWorksheet NoUrlOrParentElementNotFound NullOrEmptyParameter SheetNotInWorkbook StaleDataReference StoryPointIdMismatch UnknownAuthError UnknownDialogType UnsupportedEventName VizAlreadyInManager

Enumeration Members

AuthFailed: "auth-failed"

Raised when a request to the auth endpoint fails.

BrowserNotCapable: "browser-not-capable"

The browser is not capable of supporting the Tableau Embedding API

DownloadWorkbookNotAllowed: "download-workbook-not-allowed"

The permissions on a workbook or a view do not allow downloading the workbook.

EventInitializationError: "event-initialization-error"

Unknown error during event initialization

FilterCannotBePerformed: "filter-cannot-be-performed"

Thrown when an error occurs while attempting to perform a filter operation.

FilterMissingOrNotImplemented: "filter-missing-not-implemented"

Can occur if the API interacts with a filter that has been removed from the worksheet. Can also occurs if a FilterType has not been implemented.

ImplementationError: "wrong-implementation"

Function is not supported in the embedding api.

IncompatibleVersionError: "incompatible-version-error"

Version of the embedding api not supported by the version of tableau

IndexOutOfRange: "index-out-of-range"

Thrown when attempting to switch to a sheet by index that does not exist in the workbook.

InternalError: "internal-error"

Thrown when an error occurs within the Tableau Embedding API. Contact Tableau Support.

InvalidCustomViewName: "invalid-custom-view-name"

An operation was attempted on a custom view that does not exist.

InvalidDateParameter: "invalid-date-parameter"

An invalid date was specified in a method that required a date parameter.

invalidFilterFieldNameOrValue: "invalid-filter-field-name"

Either a filter operation was attempted on a field that does not exist in the data source, or the value supplied in the filter operation is the wrong data type or format.

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.

InvalidSize: "invalid-size"

A negative size was specified or the maxSize value is less than minSize in Sheet.changeSizeAsync().

InvalidSizeBehavior: "invalid-size-behavior"

A behavior value was found that is not included in the SheetSizeBehavior enum.

InvalidSizeBehaviorOnWorksheet: "invalid-size-behavior-on-worksheet"

A behavior other than SheetSizeBehavior.Automatic was specified in Sheet.changeSizeAsync() when the sheet is a Worksheet instance.

InvalidTimeDimension: "invalid-time-dimension"

The currently applied time dimension could not be determined or is invalid.

InvalidUrl: "invalid-url"

The URL specified in the Viz class constructor is not valid.

MissingMaxSize: "missing-max-size"

The maxSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.AtMost.

MissingMinMaxSize: "missing-min-max-size"

The minSize or maxSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.Range.

MissingMinSize: "missing-min-size"

The minSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.AtLeast.

MissingParameter: "missing-parameter"

Can occur if the embedding app interacts with a parameter that has been removed from the worksheet.

MissingRangeNForRelativeDateFilters: "missing-range-n-for-relative-date-filters"

The rangeN field is missing for a relative date filter of type LASTN or NEXTN.

NotActiveSheet: "not-active-sheet"

An operation was attempted on a sheet that is not active or embedded within the active dashboard.

NoUrlForHiddenWorksheet: "no-url-for-hidden-worksheet"

An attempt was made to access Sheet.getUrl() on a hidden sheet. Hidden sheets do not have URLs.

NoUrlOrParentElementNotFound: "no-url-or-parent-element-not-found"

One or both of the parentElement or the URL parameters is not specified in the Viz constructor.

NullOrEmptyParameter: "null-or-empty-parameter"

A required parameter was not specified, null, or an empty string/array.

SheetNotInWorkbook: "sheet-not-in-workbook"

An operation was attempted on a sheet that does not exist in the workbook.

StaleDataReference: "stale-data-reference"

An operation is performed on a CustomView object that is no longer valid (it has been removed).

StoryPointIdMismatch: "storypoint-id-mismatch"

Can occur if story point ids no longer match.

UnknownAuthError: "unknown-auth-error"

Unknown error triggered during the auth flow.

UnknownDialogType: "unknown-dialog-type"

Unknown TableauDialogType passed in to Viz.displayDialogAsync.

UnsupportedEventName: "unsupported-event-name"

An unknown event name was specified in the call to Viz.addEventListener or Viz.removeEventListener.

VizAlreadyInManager: "viz-already-in-manager"

A Viz object has already been created as a child of the parentElement specified in the Viz constructor.

Settings

Member Visibility

On This Page

Enumeration Members