You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-client-apis/_index.md
+73Lines changed: 73 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -161,6 +161,79 @@ There is a way to use more the convenient `displayValue` and `setTextValue` whi
161
161
162
162
The optional field `universe` is used to indicate the set of all possible values that can be passed to a `setValue` if a set is limited. Currently, `universe` is provided only when the edited value is of the Boolean or enumeration [types](/refguide/attributes/#type).
163
163
164
+
#### Formatter Details {#formatter-details}
165
+
166
+
The `formatter` field on `EditableValue` is defined as follows:
const formatted =customFormatter.format(myDateAttribute.value); // e.g. "March 2026"
227
+
}
228
+
```
229
+
230
+
For enumeration and Boolean attributes, `format` converts the raw value into a human-readable caption as configured in Studio Pro:
231
+
232
+
```ts
233
+
// myEnumAttribute is an EditableValue<string>
234
+
const caption =myEnumAttribute.formatter.format(myEnumAttribute.value); // e.g. "In Progress"
235
+
```
236
+
164
237
### EditableFileValue {#editable-file-value}
165
238
166
239
`EditableFileValue` is used to represent file values, that can be changed by a pluggable widget client component and is passed only to [file](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#file). It is defined as follows:
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-9/pluggable-widgets/pluggable-widgets-client-apis-9/_index.md
+73Lines changed: 73 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,6 +133,79 @@ There is a way to use more the convenient `displayValue` and `setTextValue` whi
133
133
134
134
The optional field `universe` is used to indicate the set of all possible values that can be passed to a `setValue` if a set is limited. Currently, `universe` is provided only when the edited attribute is of the Boolean or enumeration [types](/refguide9/attributes/#type).
135
135
136
+
#### Formatter Details {#formatter-details}
137
+
138
+
The `formatter` field on `EditableValue` is defined as follows:
const formatted =customFormatter.format(myDateAttribute.value); // e.g. "March 2026"
199
+
}
200
+
```
201
+
202
+
For enumeration and Boolean attributes, `format` converts the raw value into a human-readable caption as configured in Studio Pro:
203
+
204
+
```ts
205
+
// myEnumAttribute is an EditableValue<string>
206
+
const caption =myEnumAttribute.formatter.format(myEnumAttribute.value); // e.g. "In Progress"
207
+
```
208
+
136
209
### ModifiableValue {#modifiable-value}
137
210
138
211
`ModifiableValue` is used to represent values that can be changed by a pluggable widget client component. It is passed only to [association properties](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-9/#association), and is defined as follows:
0 commit comments