---
schema_version: "1"
id: 5be7d149ba230b7f27e26a8e01ed69bf06ddddab3756efc35b9794f7887528a3
title: ParameterDomainRestriction | Tableau Embedding API
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/ParameterDomainRestriction.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/ParameterDomainRestriction.html
source_site: help.tableau.com
content_type: documentation
content_hash: 60ca905c6aadb486ecb7dc84444c0db4d737d7e8a0e772b13bac5e8c3549ea46
description: Documentation for Tableau Embedding API
---
- ParameterDomainRestriction

# Interface ParameterDomainRestriction

Represents the allowable set of values which a parameter can be set to.

interface ParameterDomainRestriction {  
    [allowableValues](#allowablevalues)?: [DataValue](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\];  
    [dateStepPeriod](#datestepperiod)?: [PeriodType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/PeriodType.html);  
    [maxValue](#maxvalue)?: [DataValue](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataValue.html);  
    [minValue](#minvalue)?: [DataValue](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataValue.html);  
    [stepSize](#stepsize)?: number;  
    [type](#type): [ParameterValueType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/ParameterValueType.html);  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:51

##### Index

### Properties

[allowableValues?](#allowablevalues) [dateStepPeriod?](#datestepperiod) [maxValue?](#maxvalue) [minValue?](#minvalue) [stepSize?](#stepsize) [type](#type)

## Properties

### `Optional` `Readonly`allowableValues[](#allowablevalues)

allowableValues?: [DataValue](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\]

#### Returns[](#returns)

If `ParameterValueType.List`, the array will be the list of values which the parameter is allowed to take.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:61

### `Optional` `Readonly`dateStepPeriod[](#datestepperiod)

dateStepPeriod?: [PeriodType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/PeriodType.html)

#### Returns[](#returns-1)

If `ParameterValueType.Range`, this defines the step date period used in the Parameter UI control slider. Note that if you specify a new value for the parameter, using the `changeValueAsync()` method, that does not align on the `dateStepPeriod` interval, the value will be set to the closest, earlier date.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:87

### `Optional` `Readonly`maxValue[](#maxvalue)

maxValue?: [DataValue](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataValue.html)

#### Returns[](#returns-2)

If `ParameterValueType.Range`, the value will be the upper bound of allowable values for the parameter.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:71

### `Optional` `Readonly`minValue[](#minvalue)

minValue?: [DataValue](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataValue.html)

#### Returns[](#returns-3)

If `ParameterValueType.Range`, the value will be the lower bound of allowable values for the parameter.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:66

### `Optional` `Readonly`stepSize[](#stepsize)

stepSize?: number

#### Returns[](#returns-4)

If `ParameterValueType.Range`, the value will define the step size used in the parameter UI control slider. Note that if you specify a new value for the parameter, using the `changeValueAsync()` method, that does not align on the `stepSize` interval, the value will be set to the closest, lower interval. For example, if the `stepSize` was 5 and the steps were 1, 5, 10, if the new value specified was 8, the value 5 would be used instead.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:80

### `Readonly`type[](#type)

type: [ParameterValueType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/ParameterValueType.html)

#### Returns[](#returns-5)

The type of restriction we have on the parameter's domain. This value will effect what other properties are configured on this object.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/ParameterInterfaces.ts:56

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[allowableValues](#allowablevalues)[dateStepPeriod](#datestepperiod)[maxValue](#maxvalue)[minValue](#minvalue)[stepSize](#stepsize)[type](#type)