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-10/pluggable-widgets/pluggable-widgets-client-apis/_index.md
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-client-apis/pluggable-widgets-client-apis-list-values.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ description: A guide to understanding the list of objects for the datasource pro
6
6
7
7
## Introduction
8
8
9
-
`ListValue` is used to represent a list of objects for the [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#datasource) property. Corresponding list item values represent properties of different types linked to a [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#datasource) property.
9
+
`ListValue` is used to represent a list of objects for the [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#datasource) property. Corresponding list item values represent properties of different types linked to a [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#datasource) property.
10
10
11
11
## ListValue {#listvalue}
12
12
13
-
When a [`datasource`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#datasource) property with `isList="true"` is configured for a widget, the client component gets a list of objects represented as a `ListValue`. This type allows detailed access and control over the data source.
13
+
When a [`datasource`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#datasource) property with `isList="true"` is configured for a widget, the client component gets a list of objects represented as a `ListValue`. This type allows detailed access and control over the data source.
14
14
15
15
```ts
16
16
exportinterfaceObjectItem {
@@ -315,7 +315,7 @@ It is possible to reload items of a datasource. The `reload()` method triggers a
315
315
316
316
### Working With Actual Data
317
317
318
-
The `items` property contains all the requested data items of the datasource. However, it is not possible to access domain data directly from `ListValue`, as every object is represented only by GUID in the `items` array. Instead, a list of items may be used in combination with other properties, for example with a property of type [`attribute`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#attribute), [`action`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#action), or [`widgets`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#widgets). See the next section for detailed information about working with different property types in combination with `ListValue`.
318
+
The `items` property contains all the requested data items of the datasource. However, it is not possible to access domain data directly from `ListValue`, as every object is represented only by GUID in the `items` array. Instead, a list of items may be used in combination with other properties, for example with a property of type [`attribute`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#attribute), [`action`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#action), or [`widgets`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#widgets). See the next section for detailed information about working with different property types in combination with `ListValue`.
In this code sample, checks of status `myDataSource` and availability of items are omitted for simplicity. See the [ActionValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#actionvalue) for more information about the usage of `ActionValue`.
393
+
In this code sample, checks of status `myDataSource` and availability of items are omitted for simplicity. See the [ActionValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#actionvalue) for more information about the usage of `ActionValue`.
394
394
395
395
### ListAttributeValue {#listattributevalue}
396
396
397
-
`ListAttributeValue` represents an [attribute property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#attribute) that is linked to a data source.
397
+
`ListAttributeValue` represents an [attribute property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#attribute) that is linked to a data source.
398
398
This allows the client component to access attribute values on individual items from a `ListValue`. `ListAttributeValue` is an object and its definition is as follows:
399
399
400
400
```ts
@@ -435,7 +435,7 @@ The following code sample shows how to get an `EditableValue<string>` that repre
Note: in this code sample checks of status of `myDataSource` and availability of items are omitted for simplicity. See [EditableValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value) for more information about usage of `EditableValue`.
438
+
Note: in this code sample checks of status of `myDataSource` and availability of items are omitted for simplicity. See [EditableValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#editable-value) for more information about usage of `EditableValue`.
439
439
440
440
#### Attribute ID, Sortable and Filterable Flags {#listattributevalue-id-sortable-filterable}
441
441
@@ -445,7 +445,7 @@ Fields `sortable` and `filterable` specify if the attribute could be used for so
445
445
446
446
#### Attribute Type
447
447
448
-
The [attribute](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#attribute) property defines which attribute types can be configured for that property. For example, an attribute property may be configured to allow attributes of type `String` and `Integer` in order to present progress. While this is convenient for users, it may require additional work for developers by processing different data types.
448
+
The [attribute](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#attribute) property defines which attribute types can be configured for that property. For example, an attribute property may be configured to allow attributes of type `String` and `Integer` in order to present progress. While this is convenient for users, it may require additional work for developers by processing different data types.
449
449
450
450
It is possible to determine the type of attribute by checking the `type` field on an attribute property. The following code sample shows how to check the attribute type on the property named `myAttributeOnDatasource`:
451
451
@@ -463,11 +463,11 @@ if (this.props.myAttributeOnDatasource.type === "String") {
463
463
464
464
The `formatter` field represents the default formatter used on values obtained by the `get` function.
465
465
466
-
The optional `universe` field represents an array of possible values for an attribute. For more information, see the `universe` field of [EditableValue](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value).
466
+
The optional `universe` field represents an array of possible values for an attribute. For more information, see the `universe` field of [EditableValue](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#editable-value).
467
467
468
468
### ListReferenceValue and ListReferenceSetValue {#listassociationvalue}
469
469
470
-
`ListReferenceValue` and `ListReferenceSetValue` are both used to represent an [association property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#association) that is linked to a data source. This allows the client component to access associated values of individual items from a `ListValue`. `ListReferenceValue` and `ListReferenceSetValue` are both objects and their definitions are as follows:
470
+
`ListReferenceValue` and `ListReferenceSetValue` are both used to represent an [association property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#association) that is linked to a data source. This allows the client component to access associated values of individual items from a `ListValue`. `ListReferenceValue` and `ListReferenceSetValue` are both objects and their definitions are as follows:
This will return an `ObjectItem` representing the associated object, because in this example the widget is configured to allow only singular associations. If you want to access the individual attribute values of this associated object, you may use an attribute property linked to the selectable objects data source and pass the associated object to it. For more information, see [Obtaining Attribute Value section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#obtaining-attribute-value).
508
+
This will return an `ObjectItem` representing the associated object, because in this example the widget is configured to allow only singular associations. If you want to access the individual attribute values of this associated object, you may use an attribute property linked to the selectable objects data source and pass the associated object to it. For more information, see [Obtaining Attribute Value section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values-10/#obtaining-attribute-value).
509
509
510
-
Please note these code samples omit checks of `myDataSource` status and availability of items for simplicity. See [DynamicValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value) for more information on the usages of `DynamicValue`.
510
+
Please note these code samples omit checks of `myDataSource` status and availability of items for simplicity. See [DynamicValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#dynamic-value) for more information on the usages of `DynamicValue`.
511
511
512
512
#### Association ID and Filterable Flags {#listassociationvalue-id-filterable}
513
513
@@ -517,7 +517,7 @@ The `filterable` field specifies if the association can be used for filtering. T
517
517
518
518
#### Association Type {#association-type}
519
519
520
-
The [association](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#association) property determines which association types could be configured for that property. For example, an association property may be configured to allow associations of type `Reference` and not `ReferenceSet`.
520
+
The [association](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#association) property determines which association types could be configured for that property. For example, an association property may be configured to allow associations of type `Reference` and not `ReferenceSet`.
521
521
522
522
It is possible to determine the type of association by checking the `type` field on an association property. This is useful if the property has been configured to allow both references and reference sets. The following code sample shows how to check the association type on the property named `myAssociationOnDatasource`:
523
523
@@ -532,7 +532,7 @@ if (this.props.myAssociationOnDatasource.type === "Reference") {
532
532
533
533
### ListWidgetValue {#listwidgetvalue}
534
534
535
-
`ListWidgetValue` represents a [widget property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#widgets) that is linked to a data source. This allows the client component to render child widgets with items from a `ListValue`.
535
+
`ListWidgetValue` represents a [widget property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#widgets) that is linked to a data source. This allows the client component to render child widgets with items from a `ListValue`.
536
536
`ListWidgetValue` is an object and its definition is as follows:
537
537
538
538
```ts
@@ -560,7 +560,7 @@ When the `widgets` property is not required, there may not be any child widgets
560
560
561
561
### ListExpressionValue {#listexpressionvalue}
562
562
563
-
`ListExpressionValue` represents an [expression property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#expression) or [text template property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#texttemplate) that is linked to a data source. This allows the client component to access expression or text template values for individual items from a `ListValue`. `ListExpressionValue` is an object and its definition is as follows:
563
+
`ListExpressionValue` represents an [expression property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#expression) or [text template property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#texttemplate) that is linked to a data source. This allows the client component to access expression or text template values for individual items from a `ListValue`. `ListExpressionValue` is an object and its definition is as follows:
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-config-api.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Errors that are related to the configuration module are shown in the Widget Deve
21
21
22
22
To customize the properties available in Studio Pro for the pluggable widget, the module should export a `getProperties` function. Two parameters are passed to this function:
23
23
24
-
* The current configured values, following the [Values API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis/#values)
24
+
* The current configured values, following the [Values API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis-10/#values)
25
25
* The default property configuration
26
26
27
27
```typescript
@@ -565,7 +565,7 @@ type DropZoneProps = BaseProps & {
565
565
566
566
Thedropzonepreviewtypecan be used to add drop zones to the widget preview. It requires a widget property of type `widgets` to be able to store the information about the containing widgets. If the property has a data source, a header will be shown inside the dropzone containing information about the data source. This header is optional and can be hidden by setting `showDataSourceHeader` to `false`.
@@ -599,7 +599,7 @@ type SelectableProps = BaseProps & {
599
599
600
600
Theselectablepreviewtypecan be used to make an instance of an object list selectable. If an object instance is made selectable, it will behave similar to a widget. Its properties will be shown in the `Properties` section and can also be edited in a pop-up by double-clicking the section that is visualized by the `child` properties. Note that this only works in combination with a property of type `object`.
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-native-dependencies.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Where you place the file depends on your situation:
23
23
24
24
### Naming Conventions
25
25
26
-
For pluggable widgets, the declaration file should be named after the [Widget Definition XML File](/apidocs-mxsdk/apidocs/pluggable-widgets/#widget-definition), but should use a *.json* extension.
26
+
For pluggable widgets, the declaration file should be named after the [Widget Definition XML File](/apidocs-mxsdk/apidocs/pluggable-widgets-10/#widget-definition), but should use a *.json* extension.
27
27
28
28
For JavaScript actions, the declaration file should be named after the name of a `.js` file of the action, but should use a *.json* extension.
29
29
@@ -62,5 +62,5 @@ It is not possible to include different versions of the same native dependency i
62
62
63
63
## Read More
64
64
65
-
*[Pluggable Widget API Documentation](/apidocs-mxsdk/apidocs/pluggable-widgets/)
65
+
*[Pluggable Widget API Documentation](/apidocs-mxsdk/apidocs/pluggable-widgets-10/)
66
66
*[Build JavaScript Actions for Native Mobile](/howto/extensibility/create-native-javascript-action/)
0 commit comments