Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Client APIs"
linktitle: "Client APIs for Pluggable Widgets"
url: /apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/
description: A guide for understanding the client APIs available to pluggable widgets in Mx10.
description: A guide for understanding the client APIs available to pluggable widgets in Mx11.
weight: 20
aliases:
- /apidocs-mxsdk/apidocs/client-apis-for-pluggable-widgets
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,10 @@ The user can use the optional attribute [`allowUpload`](#allow-upload) with defa

#### XML Attributes

{{% alert color="info" %}}
The `allowUpload` attribute was introduced in Mendix [11.8](/releasenotes/studio-pro/11.8/).
{{% /alert %}}

| Attribute | Required | Attribute Type | Description |
|---------------|----------|----------------|-----------------------------------------------------------------------|
| `type` | Yes | String | Must be `image` |
Expand Down Expand Up @@ -480,10 +484,6 @@ Then the Studio Pro UI for the property appears like this:

### Action {#action}

{{% alert color="info" %}}
The `defaultType` and `defaultValue` attributes for Action were introduced in Mendix [10.15](/releasenotes/studio-pro/10.15/).
{{% /alert %}}

The action property type allows a user to configure an action which can do things like call nanoflows, save changes, and open pages.

If a `dataSource` attribute is not specified, the client will receive an `ActionValue` representing the action or `undefined` if the **Do nothing** action was selected.
Expand Down Expand Up @@ -722,6 +722,10 @@ The user can use the optional attribute [`allowUpload`](#allow-upload) with defa

#### XML Attributes

{{% alert color="info" %}}
The `allowUpload` attribute was introduced in Mendix [11.8](/releasenotes/studio-pro/11.8/).
{{% /alert %}}

| Attribute | Required | Attribute Type | Description |
|---------------|----------|----------------|----------------------------------|
| `type` | Yes | String | Must be `file` |
Expand Down Expand Up @@ -767,10 +771,6 @@ Only list datasources are supported, therefore specifying `isList="true"` is req

##### Data Source Defaults {#data-source-defaults}

{{% alert color="info" %}}
The `defaultType` and `defaultValue` attributes for datasources were introduced in Mendix [10.16](/releasenotes/studio-pro/10.16/).
{{% /alert %}}

You can use the `defaultType` and `defaultValue` attributes to configure default data sources for your widget. Unless overridden in Studio Pro, the widget will attempt to configure the data source according to its defaults. Both attributes need to be set for the defaults to be applied.

The format of `defaultValue` depends on the chosen `defaultType`:
Expand All @@ -797,10 +797,6 @@ Then the Studio Pro UI for the property appears like this:

### Selection {#selection}

{{% alert color="info" %}}
The property type was introduced in Mendix [10.7](/releasenotes/studio-pro/10.7/).
{{% /alert %}}

The selection property allows a widget to read and set a selection that can be used in actions, expressions, or a `Listen to` data source of a data view.

#### XML Attributes
Expand Down Expand Up @@ -867,10 +863,6 @@ Label property allows a pluggable widget to have labeling functionality similar

#### setLabel {#setLabel}

{{% alert color="info" %}}
The `setLabel` attribute was introduced in Mendix [10.5](/releasenotes/studio-pro/10.5/).
{{% /alert %}}

You can use `setLabel` to specify which properties can be used to set the `Label` property value.

Configuring the value of a property with the `setLabel` attribute will automatically update the value of `Label`.
Expand Down