Tableau Embedding API
    Preparing search index...

    Enumeration SharedErrorCodes

    Index

    Enumeration Members

    ApiExecutionError CrosstabCreationError DataCreationError ImplementationError InternalError InvalidAggregationFieldName InvalidFilterFieldName InvalidFilterFieldValue InvalidParameter InvalidSelectionDate InvalidSelectionFieldName InvalidSelectionSheet InvalidSelectionValue NotActiveSheet PDFCreationError PowerPointCreationError ServerError Timeout

    Enumeration Members

    ApiExecutionError: "api-execution-error"

    Can occur when two incompatible calls are triggered together.

    CrosstabCreationError: "crosstab-creation-error"

    A CSV or Excel file failed to be created in Viz.exportCrosstabAsync().

    DataCreationError: "data-creation-error"

    A CSV file failed to be created in Viz.exportDataAsync().

    ImplementationError: "wrong-implementation"

    Property or Function is not supported within the Tableau API.

    InternalError: "internal-error"

    An error occurred within the Tableau API. Contact Tableau Support.

    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".

    InvalidFilterFieldName: "invalid-filter-name"

    A filter operation was attempted on a field that does not exist in the data source.

    InvalidFilterFieldValue: "invalid-filter-fieldValue"

    A filter operation was attempted using a value that 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.

    InvalidSelectionDate: "invalid-selection-date"

    An invalid date value was specified in a Sheet.selectMarksAsync() call for a date field.

    InvalidSelectionFieldName: "invalid-selection-fieldName"

    A field was specified in a Sheet.selectMarksAsync() call that does not exist in the data source.

    InvalidSelectionSheet: "invalid-selection-sheet"

    A parameter did not include a valid sheet selection for exporting.

    InvalidSelectionValue: "invalid-selection-value"

    An invalid value was specified in a Sheet.selectMarksAsync() call.

    NotActiveSheet: "not-active-sheet"

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

    PDFCreationError: "pdf-creation-error"

    A PDF file failed to be created in Viz.exportPDFAsync().

    PowerPointCreationError: "powerpoint-creation-error"

    A PowerPoint file failed to be created in Viz.exportPowerPointAsync().

    ServerError: "server-error"

    A general-purpose server error occurred. Details are contained in the Error object.

    Timeout: "timeout"

    Can occur when an api call times out.

    Settings

    Member Visibility

    On This Page

    Enumeration Members