Skip to content

Commit c63cd17

Browse files
committed
Review: Drop obsolete "single" from object datasource
1 parent 9183380 commit c63cd17

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-property-types.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This defines a property's type. A `type` must be one of the following:
6060
* [file](#file)
6161
* [datasource](#datasource)
6262
* [List data source](#list-datasource)
63-
* [Single object data source](#single-object-datasource)
63+
* [Object data source](#object-datasource)
6464
* [selection](#selection)
6565

6666
### XML Elements
@@ -745,7 +745,7 @@ Then the Studio Pro UI for the property appears like this:
745745

746746
### Datasource {#datasource}
747747

748-
The datasource property allows widgets to work with data from the Mendix Platform. It comes in two variants controlled by the `isList` attribute: a **list data source** (`isList="true"`) for working with collections of objects, and a **single object data source** (`isList="false"`) for working with a single object.
748+
The datasource property allows widgets to work with data from the Mendix Platform. It comes in two variants controlled by the `isList` attribute: a **list data source** (`isList="true"`) for working with collections of objects, and an **object data source** (`isList="false"`) for working with a single object.
749749

750750
If no data source has been configured by the user, any properties that are linked to the datasource property are automatically omitted from the props passed to the client component (even if they are marked as required).
751751

@@ -755,7 +755,7 @@ If no data source has been configured by the user, any properties that are linke
755755
|----------------|----------|----------------|------------------------------------------------------------------------------------------------------------|
756756
| `type` | Yes | String | Must be `datasource` |
757757
| `key` | Yes | String | See [key](#key) |
758-
| `isList` | Yes | Boolean | `true` for a list data source, `false` for a single object data source |
758+
| `isList` | Yes | Boolean | `true` for a list data source, `false` for an object data source |
759759
| `required` | No | Boolean | This decides if the user is required to specify a datasource, `true` by default |
760760
| `defaultType` | No | String | Default type for the property, see [Default Data Sources](#data-source-defaults) |
761761
| `defaultValue` | No | String | Default value for the property, see [Default Data Sources](#data-source-defaults) |
@@ -769,7 +769,7 @@ The format of `defaultValue` depends on the chosen `defaultType`:
769769
| Data source type | Format | Example | Supported for |
770770
|--------------------------|-------------|-----------------------------------------------------------------------|------------------------------------|
771771
| `Database` `Association` | Entity Path | `ModuleName.EntityName` or `ModuleName.A/ModuleName.A_B/ModuleName.B` | List data source |
772-
| `Microflow` `Nanoflow` | Document ID | `ModuleName.DocumentName` | List and single object data source |
772+
| `Microflow` `Nanoflow` | Document ID | `ModuleName.DocumentName` | List and object data source |
773773

774774
#### List Data Source {#list-datasource}
775775

@@ -790,15 +790,15 @@ Then the Studio Pro UI for the property appears like this:
790790

791791
{{< figure src="/attachments/apidocs-mxsdk/apidocs/pluggable-widgets/pluggable-widgets-property-types/datasource-list.png" class="no-border" >}}
792792

793-
#### Single Object Data Source {#single-object-datasource}
793+
#### Object Data Source {#object-datasource}
794794

795795
{{% alert color="info" %}}
796-
The single object data source was introduced in Mendix [11.11](/releasenotes/studio-pro/11.11/).
796+
The object data source was introduced in Mendix [11.11](/releasenotes/studio-pro/11.11/).
797797
{{% /alert %}}
798798

799-
A single object data source (`isList="false"`) allows a widget to work with a single object. The client component receives a prop of type [`DynamicValue<ObjectItem>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value).
799+
An object data source (`isList="false"`) allows a widget to work with a single object. The client component receives a prop of type [`DynamicValue<ObjectItem>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value).
800800

801-
A widget may have at most one single object data source property.
801+
A widget may have at most one object data source property.
802802

803803
The available source types differ from list data sources:
804804

@@ -826,7 +826,7 @@ Then the Studio Pro UI for the property appears like this:
826826

827827
The [`action`](#action), [`attribute`](#attribute), [`association`](#association), [`expression`](#expression), [`text template`](#texttemplate), [`widgets`](#widgets), and [`selection`](#selection) properties can be linked to a data source using the `dataSource` attribute on those properties. The client type received by the component depends on the data source type:
828828

829-
| Property type | List data source client type | Single object data source client type |
829+
| Property type | List data source client type | Object data source client type |
830830
|:---------------|:-----------------------------|:--------------------------------------|
831831
| `action` | [`ListActionValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listactionvalue) | [`ActionValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#action-value) |
832832
| `attribute` | [`ListAttributeValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listattributevalue) | [`EditableValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value) |
@@ -852,7 +852,7 @@ The selection property allows a widget to read and set a selection that can be u
852852
| `onChange` | No | Property Path | The path to an [`action`](#action) property that will be run by the Mendix Platform when the selection is changed by the widget |
853853

854854
{{% alert color="warning" %}}
855-
The `dataSource` attribute must refer to a [list data source](#list-datasource). Linking a selection property to a single object data source is not supported.
855+
The `dataSource` attribute must refer to a [list data source](#list-datasource). Linking a selection property to an object data source is not supported.
856856
{{% /alert %}}
857857

858858
#### XML Elements

0 commit comments

Comments
 (0)