--- schema_version: "1" id: 7816891cf229670d012fdd6e358039c986c19d97d0cd0d3416dc1ef73b8cc932 title: EmbeddingErrorCodes | Tableau Embedding API collection: tableau version: current locale: en-us portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/enums/EmbeddingErrorCodes.md canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/EmbeddingErrorCodes.html source_site: help.tableau.com content_type: documentation content_hash: 4a3c71393dd257def61477c5ed37e5b1b0726caa689e775a38f071bace25c236 description: Documentation for Tableau Embedding API --- - EmbeddingErrorCodes # Enumeration EmbeddingErrorCodes All error codes used by the Embedding API. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:27 ##### Index ### Enumeration Members [AuthFailed](#authfailed) [BrowserNotCapable](#browsernotcapable) [DownloadWorkbookNotAllowed](#downloadworkbooknotallowed) [EventInitializationError](#eventinitializationerror) [FilterCannotBePerformed](#filtercannotbeperformed) [FilterMissingOrNotImplemented](#filtermissingornotimplemented) [ImplementationError](#implementationerror) [IncompatibleVersionError](#incompatibleversionerror) [IndexOutOfRange](#indexoutofrange) [InternalError](#internalerror) [InvalidCustomViewName](#invalidcustomviewname) [InvalidDateParameter](#invaliddateparameter) [invalidFilterFieldNameOrValue](#invalidfilterfieldnameorvalue) [InvalidParameter](#invalidparameter) [InvalidSize](#invalidsize) [InvalidSizeBehavior](#invalidsizebehavior) [InvalidSizeBehaviorOnWorksheet](#invalidsizebehavioronworksheet) [InvalidTimeDimension](#invalidtimedimension) [InvalidUrl](#invalidurl) [MissingMaxSize](#missingmaxsize) [MissingMinMaxSize](#missingminmaxsize) [MissingMinSize](#missingminsize) [MissingParameter](#missingparameter) [MissingRangeNForRelativeDateFilters](#missingrangenforrelativedatefilters) [NotActiveSheet](#notactivesheet) [NoUrlForHiddenWorksheet](#nourlforhiddenworksheet) [NoUrlOrParentElementNotFound](#nourlorparentelementnotfound) [NullOrEmptyParameter](#nulloremptyparameter) [SheetNotInWorkbook](#sheetnotinworkbook) [StaleDataReference](#staledatareference) [StoryPointIdMismatch](#storypointidmismatch) [UnknownAuthError](#unknownautherror) [UnknownDialogType](#unknowndialogtype) [UnsupportedEventName](#unsupportedeventname) [VizAlreadyInManager](#vizalreadyinmanager) ## Enumeration Members ### AuthFailed[](#authfailed) AuthFailed: "auth-failed" Raised when a request to the auth endpoint fails. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:31 ### BrowserNotCapable[](#browsernotcapable) BrowserNotCapable: "browser-not-capable" The browser is not capable of supporting the Tableau Embedding API - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:35 ### DownloadWorkbookNotAllowed[](#downloadworkbooknotallowed) DownloadWorkbookNotAllowed: "download-workbook-not-allowed" The permissions on a workbook or a view do not allow downloading the workbook. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:39 ### EventInitializationError[](#eventinitializationerror) EventInitializationError: "event-initialization-error" Unknown error during event initialization - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:163 ### FilterCannotBePerformed[](#filtercannotbeperformed) FilterCannotBePerformed: "filter-cannot-be-performed" Thrown when an error occurs while attempting to perform a filter operation. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:43 ### FilterMissingOrNotImplemented[](#filtermissingornotimplemented) 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](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterType.html) has not been implemented. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:178 ### ImplementationError[](#implementationerror) ImplementationError: "wrong-implementation" Function is not supported in the embedding api. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:155 ### IncompatibleVersionError[](#incompatibleversionerror) IncompatibleVersionError: "incompatible-version-error" Version of the embedding api not supported by the version of tableau - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:167 ### IndexOutOfRange[](#indexoutofrange) IndexOutOfRange: "index-out-of-range" Thrown when attempting to switch to a sheet by index that does not exist in the workbook. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:47 ### InternalError[](#internalerror) InternalError: "internal-error" Thrown when an error occurs within the Tableau Embedding API. Contact Tableau Support. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:51 ### InvalidCustomViewName[](#invalidcustomviewname) InvalidCustomViewName: "invalid-custom-view-name" An operation was attempted on a custom view that does not exist. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:55 ### InvalidDateParameter[](#invaliddateparameter) InvalidDateParameter: "invalid-date-parameter" An invalid date was specified in a method that required a date parameter. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:59 ### invalidFilterFieldNameOrValue[](#invalidfilterfieldnameorvalue) 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. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:64 ### InvalidParameter[](#invalidparameter) 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. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:69 ### InvalidSize[](#invalidsize) InvalidSize: "invalid-size" A negative size was specified or the maxSize value is less than minSize in Sheet.changeSizeAsync(). - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:77 ### InvalidSizeBehavior[](#invalidsizebehavior) InvalidSizeBehavior: "invalid-size-behavior" A behavior value was found that is not included in the SheetSizeBehavior enum. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:86 ### InvalidSizeBehaviorOnWorksheet[](#invalidsizebehavioronworksheet) InvalidSizeBehaviorOnWorksheet: "invalid-size-behavior-on-worksheet" A behavior other than SheetSizeBehavior.Automatic was specified in Sheet.changeSizeAsync() when the sheet is a Worksheet instance. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:91 ### InvalidTimeDimension[](#invalidtimedimension) InvalidTimeDimension: "invalid-time-dimension" The currently applied time dimension could not be determined or is invalid. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:73 ### InvalidUrl[](#invalidurl) InvalidUrl: "invalid-url" The URL specified in the Viz class constructor is not valid. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:95 ### MissingMaxSize[](#missingmaxsize) MissingMaxSize: "missing-max-size" The maxSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.AtMost. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:99 ### MissingMinMaxSize[](#missingminmaxsize) MissingMinMaxSize: "missing-min-max-size" The minSize or maxSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.Range. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:107 ### MissingMinSize[](#missingminsize) MissingMinSize: "missing-min-size" The minSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.AtLeast. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:103 ### MissingParameter[](#missingparameter) MissingParameter: "missing-parameter" Can occur if the embedding app interacts with a parameter that has been removed from the worksheet. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:111 ### MissingRangeNForRelativeDateFilters[](#missingrangenforrelativedatefilters) MissingRangeNForRelativeDateFilters: "missing-range-n-for-relative-date-filters" The rangeN field is missing for a relative date filter of type LASTN or NEXTN. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:115 ### NotActiveSheet[](#notactivesheet) NotActiveSheet: "not-active-sheet" An operation was attempted on a sheet that is not active or embedded within the active dashboard. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:127 ### NoUrlForHiddenWorksheet[](#nourlforhiddenworksheet) NoUrlForHiddenWorksheet: "no-url-for-hidden-worksheet" An attempt was made to access Sheet.getUrl() on a hidden sheet. Hidden sheets do not have URLs. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:119 ### NoUrlOrParentElementNotFound[](#nourlorparentelementnotfound) 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. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:123 ### NullOrEmptyParameter[](#nulloremptyparameter) NullOrEmptyParameter: "null-or-empty-parameter" A required parameter was not specified, null, or an empty string/array. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:131 ### SheetNotInWorkbook[](#sheetnotinworkbook) SheetNotInWorkbook: "sheet-not-in-workbook" An operation was attempted on a sheet that does not exist in the workbook. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:135 ### StaleDataReference[](#staledatareference) StaleDataReference: "stale-data-reference" An operation is performed on a CustomView object that is no longer valid (it has been removed). - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:139 ### StoryPointIdMismatch[](#storypointidmismatch) StoryPointIdMismatch: "storypoint-id-mismatch" Can occur if story point ids no longer match. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:183 ### UnknownAuthError[](#unknownautherror) UnknownAuthError: "unknown-auth-error" Unknown error triggered during the auth flow. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:143 ### UnknownDialogType[](#unknowndialogtype) UnknownDialogType: "unknown-dialog-type" Unknown [TableauDialogType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/TableauDialogType.html) passed in to Viz.displayDialogAsync. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:172 ### UnsupportedEventName[](#unsupportedeventname) UnsupportedEventName: "unsupported-event-name" An unknown event name was specified in the call to Viz.addEventListener or Viz.removeEventListener. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:147 ### VizAlreadyInManager[](#vizalreadyinmanager) VizAlreadyInManager: "viz-already-in-manager" A Viz object has already been created as a child of the parentElement specified in the Viz constructor. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:151 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Enumeration Members [AuthFailed](#authfailed)[BrowserNotCapable](#browsernotcapable)[DownloadWorkbookNotAllowed](#downloadworkbooknotallowed)[EventInitializationError](#eventinitializationerror)[FilterCannotBePerformed](#filtercannotbeperformed)[FilterMissingOrNotImplemented](#filtermissingornotimplemented)[ImplementationError](#implementationerror)[IncompatibleVersionError](#incompatibleversionerror)[IndexOutOfRange](#indexoutofrange)[InternalError](#internalerror)[InvalidCustomViewName](#invalidcustomviewname)[InvalidDateParameter](#invaliddateparameter)[invalidFilterFieldNameOrValue](#invalidfilterfieldnameorvalue)[InvalidParameter](#invalidparameter)[InvalidSize](#invalidsize)[InvalidSizeBehavior](#invalidsizebehavior)[InvalidSizeBehaviorOnWorksheet](#invalidsizebehavioronworksheet)[InvalidTimeDimension](#invalidtimedimension)[InvalidUrl](#invalidurl)[MissingMaxSize](#missingmaxsize)[MissingMinMaxSize](#missingminmaxsize)[MissingMinSize](#missingminsize)[MissingParameter](#missingparameter)[MissingRangeNForRelativeDateFilters](#missingrangenforrelativedatefilters)[NotActiveSheet](#notactivesheet)[NoUrlForHiddenWorksheet](#nourlforhiddenworksheet)[NoUrlOrParentElementNotFound](#nourlorparentelementnotfound)[NullOrEmptyParameter](#nulloremptyparameter)[SheetNotInWorkbook](#sheetnotinworkbook)[StaleDataReference](#staledatareference)[StoryPointIdMismatch](#storypointidmismatch)[UnknownAuthError](#unknownautherror)[UnknownDialogType](#unknowndialogtype)[UnsupportedEventName](#unsupportedeventname)[VizAlreadyInManager](#vizalreadyinmanager)