---
schema_version: "1"
id: a4abc1f630799fe644080e6e68989a395e8e906aeee318b971ced55a49f932b3
title: CustomParameter | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/CustomParameter.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/CustomParameter.html
source_site: help.tableau.com
content_type: documentation
content_hash: 330c6bfbe86a1f89df5e75022484d10e80fc548f4744a999d80ce798f76645b7
description: Documentation for Tableau Embedding API
---
- CustomParameter

# Interface CustomParameter

CustomParameters are used to pass along settings, information, etc., that aren't exposed on the tableau-viz element. CustomParameters will override attributes, or filters, set on the tableau-viz element.

- ```
    
    ```

\`\`\`

interface CustomParameter {  
    [name](#name): string;  
    [value](#value): string;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:758

##### Index

### Properties

[name](#name) [value](#value)

## Properties

### name[](#name)

name: string

Name of the parameter to be set.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:762

### value[](#value)

value: string

Valid value for the parameter being set.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:767

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[name](#name)[value](#value)