Merge pull request #128 from brYch97/users/dominik.brych/VirtualDataset

Updated Virtual Dataset docs
TALXIS · Oct 22, 2024 · 90179ef · 90179ef
2 parents a6288a6 + 8cecdf7
commit 90179ef
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 4 deletions.
diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js
@@ -418,11 +418,9 @@ module.exports = config({
                                                                     title: 'interfaces',
                                                                     collapsable: true,
                                                                     children: [
-                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/interfaces/IDataset.md', 'IDataset'],
                                                                         ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/interfaces/IDatasetEventListeners.md', 'IDatasetEventListeners'],
-                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/interfaces/IDataProvider.md', 'IDataProvider'],
                                                                         ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/interfaces/IDataProviderEventListeners.md', 'IDataProviderEventListeners'],
-                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/interfaces/IRecord.md', 'IRecord']
+                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/interfaces/IDataProviderOptions.md', 'IDataProviderOptions'],
                                                                     ]
                                                                 },
                                                                 {

diff --git a/...trols/VirtualDataset/ClientExtensibility/API/interfaces/IDataProviderOptions.md b/...trols/VirtualDataset/ClientExtensibility/API/interfaces/IDataProviderOptions.md
@@ -0,0 +1,37 @@
+Additional options for Data Provider.
+
+## Properties
+
+### entityMetadata?
+
+> `optional` **entityMetadata**: `DeepPartial`\<`EntityMetadata`\>
+
+Can be used to define/override Entity Metadata.
+
+#### Defined in
+
+src/utils/dataset/data-providers/interfaces.ts:225
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Sets the title describing the provider.
+
+#### Defined in
+
+src/utils/dataset/data-providers/interfaces.ts:215
+
+***
+
+### userSettings?
+
+> `optional` **userSettings**: `UserSettings` \| `UserSettings`
+
+Only needs to be passed if the provider is running in an environment without User Settings present in window.Xrm (for example local PCF harness).
+
+#### Defined in
+
+src/utils/dataset/data-providers/interfaces.ts:220
diff --git a/src/en/developer-guide/applications/controls/VirtualDataset/general.md b/src/en/developer-guide/applications/controls/VirtualDataset/general.md
@@ -177,7 +177,7 @@ The [PCF Dataset Column interface](https://learn.microsoft.com/en-us/power-apps/
 
 Depending on which provider you choose, a different minimal amount of props is required for the column to show in the UI:
 
-- FetchXml Provider: `name` and `isHidden`
+- FetchXml Provider: `name`
 - Memory Provider: `name`, `displayName` and [`dataType`](https://learn.microsoft.com/en-us/power-apps/developer/component-framework/manifest-schema-reference/type)
 
 You can also specify virtual columns by ending the column name with `__virtual` suffix. This will let the provider know that it should not try to fetch any metadata for the column and it is up to you to specify them. You can then perform actions (`setValue`, `getValue`) on this column, just like on the classic one.