DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable> Interface
Request type for distinct values' requests.
Extends
- Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>>
Properties
| Name | Type | Description | |
|---|---|---|---|
| descriptor | TDescriptor | Content descriptor for customizing the returned content | |
| fieldDescriptor | FieldDescriptor | Descriptor for a field distinct values are requested for | |
| keys | TKeySet | Input keys for getting the content |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| imodel | TIModel | Paged | iModel to request data from |
| locale | string | undefined | Paged | Optional locale to use when formatting / localizing data |
| paging | PageOptions | undefined | Paged | Optional paging parameters |
| rulesetOrId | string | Ruleset | Paged | Ruleset or id of the ruleset to use when requesting data |
| rulesetVariables | TRulesetVariable[] | undefined | Paged | Ruleset variables to use when requesting data |
| unitSystem | UnitSystemKey | undefined | Paged | Unit system to use when formatting property values with units. |
Defined in
Last Updated: 13 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.