IDynamicDataSourceMetadata interface
Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources.
Properties
alias | Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. |
component |
Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. |
description | User-friendly, localized description of the Dynamic Data Source. |
instance |
Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. |
title | User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. |
Property Details
alias
Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources.
alias?: string;
Property Value
string
componentId
Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources.
componentId?: string;
Property Value
string
description
User-friendly, localized description of the Dynamic Data Source.
description?: string;
Property Value
string
instanceId
Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources.
instanceId?: string;
Property Value
string
title
User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component.
title: string;
Property Value
string