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

Added docs for Virtual Dataset
TALXIS · Oct 16, 2024 · ca96001 · ca96001
2 parents c4693ce + 3cb1536
commit ca96001
Show file tree

Hide file tree

Showing 12 changed files with 1,418 additions and 0 deletions.
diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js
@@ -399,6 +399,49 @@ module.exports = config({
                                         ['/en/developer-guide/applications/controls/quicklookupedit.md', 'Quick Lookup Edit'],
                                         ['/en/developer-guide/applications/controls/rating.md', 'Rating'],
                                         ['/en/developer-guide/applications/controls/treeview.md', 'Tree View'],
+                                        {
+                                            title: 'Virtual Dataset',
+                                            collapsable: true,
+                                            children: [
+                                                ['/en/developer-guide/applications/controls/VirtualDataset/general.md', 'General'],
+                                                {
+                                                    title: 'Client Extensibility',
+                                                    collapsable: true,
+                                                    children: [
+                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/general.md', 'General'],
+                                                        {
+                                                            title: 'API',
+                                                            collapsable: true,
+                                                            children: [
+                                                                ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/globals.md', 'General'],
+                                                                {
+                                                                    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']
+                                                                    ]
+                                                                },
+                                                                {
+                                                                    title: 'classes',
+                                                                    collapsable: true,
+                                                                    children: [
+                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/classes/FetchXmlDataProvider.md', 'FetchXmlDataProvider'],
+                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/classes/MemoryDataProvider.md', 'MemoryDataProvider'],
+                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/classes/Record.md', 'Record'],
+                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/classes/Dataset.md', 'Dataset'],
+                                                                        ['/en/developer-guide/applications/controls/VirtualDataset/ClientExtensibility/API/classes/DataProvider.md', 'DataProvider'],
+                                                                    ]
+                                                                }
+                                                            ]
+                                                        }
+                                                    ]
+                                                }
+                                            ]
+                                        },
                                         ['/en/developer-guide/applications/controls/wbs.md', 'WBS - Work Breakdown Structure']
                                     ]
                                 },

diff --git a/src/.vuepress/public/.attachments/applications/Controls/virtualdataset.png b/src/.vuepress/public/.attachments/applications/Controls/virtualdataset.png
diff --git a/...cations/controls/VirtualDataset/ClientExtensibility/API/classes/DataProvider.md b/...cations/controls/VirtualDataset/ClientExtensibility/API/classes/DataProvider.md
@@ -0,0 +1,63 @@
+Base class for all Data Providers.
+
+## Extended by
+
+- [`FetchXmlDataProvider`](FetchXmlDataProvider.md)
+- [`MemoryDataProvider`](MemoryDataProvider.md)
+
+## Implements
+
+- [`IDataProvider`](../interfaces/IDataProvider.md)
+
+## Constructors
+
+### new DataProvider()
+
+> **new DataProvider**(`dataSource`, `columns`, `options`?): [`DataProvider`](DataProvider.md)
+
+Creates an instance of DataProvider.
+
+#### Parameters
+
+• **dataSource**: `any`
+
+• **columns**: `Column` & `object`[]
+
+• **options?**: [`IDataProviderOptions`](../interfaces/IDataProviderOptions.md)
+
+#### Returns
+
+[`DataProvider`](DataProvider.md)
+
+#### Defined in
+
+src/utils/dataset/data-providers/DataProvider.ts:41
+
+
+### addEventListener()
+
+> **addEventListener**\<`K`\>(`event`, `eventListener`): `void`
+
+Allows to define listener method that will trigger when specific event occurs.
+
+#### Type Parameters
+
+• **K** *extends* keyof [`IDataProviderEventListeners`](../interfaces/IDataProviderEventListeners.md)
+
+#### Parameters
+
+• **event**: `K`
+
+• **eventListener**: [`IDataProviderEventListeners`](../interfaces/IDataProviderEventListeners.md)\[`K`\]
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IDataProvider`](../interfaces/IDataProvider.md).[`addEventListener`](../interfaces/IDataProvider.md#addeventlistener)
+
+#### Defined in
+
+src/utils/dataset/data-providers/DataProvider.ts:139