@genesislcap/foundation-comms 14.302.0 → 14.302.1-alpha-945e484.0

package/docs/api/foundation-comms.datasourcemetadata.md

@@ -14,13 +14,155 @@ export interface DatasourceMetadata
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [availableIndexes](./foundation-comms.datasourcemetadata.availableindexes.md) | <code>readonly</code> | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] |  |
-|  [customRequestFields](./foundation-comms.datasourcemetadata.customrequestfields.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] |  |
-|  [fetchMetadataRequired](./foundation-comms.datasourcemetadata.fetchmetadatarequired.md) |  | boolean |  |
-|  [fieldMetadata](./foundation-comms.datasourcemetadata.fieldmetadata.md) | <code>readonly</code> | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] |  |
-|  [originalFieldDef](./foundation-comms.datasourcemetadata.originalfielddef.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] |  |
-|  [requestFields](./foundation-comms.datasourcemetadata.requestfields.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] |  |
-|  [startStreamRequired](./foundation-comms.datasourcemetadata.startstreamrequired.md) |  | boolean |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[availableIndexes](./foundation-comms.datasourcemetadata.availableindexes.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[customRequestFields](./foundation-comms.datasourcemetadata.customrequestfields.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[fetchMetadataRequired](./foundation-comms.datasourcemetadata.fetchmetadatarequired.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[fieldMetadata](./foundation-comms.datasourcemetadata.fieldmetadata.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[originalFieldDef](./foundation-comms.datasourcemetadata.originalfielddef.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[requestFields](./foundation-comms.datasourcemetadata.requestfields.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[startStreamRequired](./foundation-comms.datasourcemetadata.startstreamrequired.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.datasourceoptions.md

@@ -14,21 +14,311 @@ export interface DatasourceOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [criteria?](./foundation-comms.datasourceoptions.criteria.md) |  | string | _(Optional)_ The criteria used to filter data in the datasource. |
-|  [disablePolling?](./foundation-comms.datasourceoptions.disablepolling.md) |  | boolean | _(Optional)_ Whether to disable polling when using request/reply |
-|  [fields?](./foundation-comms.datasourceoptions.fields.md) |  | string | _(Optional)_ The fields to include in the returned data. |
-|  [isSnapshot?](./foundation-comms.datasourceoptions.issnapshot.md) |  | boolean | _(Optional)_ Whether the datasource is a snapshot or not. |
-|  [maxRows?](./foundation-comms.datasourceoptions.maxrows.md) |  | number | _(Optional)_ The maximum number of rows to return from the datasource. |
-|  [maxView?](./foundation-comms.datasourceoptions.maxview.md) |  | number | _(Optional)_ The maximum number of rows to track as part of a client "view" |
-|  [movingView?](./foundation-comms.datasourceoptions.movingview.md) |  | boolean | _(Optional)_ Defines the behaviour of the client view when new rows are received in real time. |
-|  [orderBy?](./foundation-comms.datasourceoptions.orderby.md) |  | string | _(Optional)_ The field to use for sorting the data. |
-|  [pollingInterval?](./foundation-comms.datasourceoptions.pollinginterval.md) |  | number | _(Optional)_ The polling interval to use when using request/reply. |
-|  [pollTriggerEvents?](./foundation-comms.datasourceoptions.polltriggerevents.md) |  | string\[\] | _(Optional)_ Array of event names that will trigger an additional poll. |
-|  [request?](./foundation-comms.datasourceoptions.request.md) |  | any | _(Optional)_ The request to send to the server. |
-|  [requestAutoSetup?](./foundation-comms.datasourceoptions.requestautosetup.md) |  | boolean | _(Optional)_ Whether the Datasource service will setup RQUEST object based on metadata. |
-|  [resourceName?](./foundation-comms.datasourceoptions.resourcename.md) |  | string | _(Optional)_ The name of the resource to use for the datasource. |
-|  [reverse?](./foundation-comms.datasourceoptions.reverse.md) |  | boolean | _(Optional)_ Whether to return the data in reverse order or not. |
-|  [viewNumber?](./foundation-comms.datasourceoptions.viewnumber.md) |  | number | _(Optional)_ The current page/"view" number being displayed. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[criteria?](./foundation-comms.datasourceoptions.criteria.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The criteria used to filter data in the datasource.
+
+
+</td></tr>
+<tr><td>
+
+[disablePolling?](./foundation-comms.datasourceoptions.disablepolling.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to disable polling when using request/reply
+
+
+</td></tr>
+<tr><td>
+
+[fields?](./foundation-comms.datasourceoptions.fields.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The fields to include in the returned data.
+
+
+</td></tr>
+<tr><td>
+
+[isSnapshot?](./foundation-comms.datasourceoptions.issnapshot.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the datasource is a snapshot or not.
+
+
+</td></tr>
+<tr><td>
+
+[maxRows?](./foundation-comms.datasourceoptions.maxrows.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum number of rows to return from the datasource.
+
+
+</td></tr>
+<tr><td>
+
+[maxView?](./foundation-comms.datasourceoptions.maxview.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum number of rows to track as part of a client "view"
+
+
+</td></tr>
+<tr><td>
+
+[movingView?](./foundation-comms.datasourceoptions.movingview.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Defines the behaviour of the client view when new rows are received in real time.
+
+
+</td></tr>
+<tr><td>
+
+[orderBy?](./foundation-comms.datasourceoptions.orderby.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The field to use for sorting the data.
+
+
+</td></tr>
+<tr><td>
+
+[pollingInterval?](./foundation-comms.datasourceoptions.pollinginterval.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The polling interval to use when using request/reply.
+
+
+</td></tr>
+<tr><td>
+
+[pollTriggerEvents?](./foundation-comms.datasourceoptions.polltriggerevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Array of event names that will trigger an additional poll.
+
+
+</td></tr>
+<tr><td>
+
+[request?](./foundation-comms.datasourceoptions.request.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+_(Optional)_ The request to send to the server.
+
+
+</td></tr>
+<tr><td>
+
+[requestAutoSetup?](./foundation-comms.datasourceoptions.requestautosetup.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the Datasource service will setup RQUEST object based on metadata.
+
+
+</td></tr>
+<tr><td>
+
+[resourceName?](./foundation-comms.datasourceoptions.resourcename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The name of the resource to use for the datasource.
+
+
+</td></tr>
+<tr><td>
+
+[reverse?](./foundation-comms.datasourceoptions.reverse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to return the data in reverse order or not.
+
+
+</td></tr>
+<tr><td>
+
+[viewNumber?](./foundation-comms.datasourceoptions.viewnumber.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The current page/"view" number being displayed.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.dataupdate.md

@@ -14,9 +14,83 @@ export interface DataUpdate
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [add?](./foundation-comms.dataupdate.add.md) |  | Array<any> | _(Optional)_ |
-|  [drop?](./foundation-comms.dataupdate.drop.md) |  | Array<any> | _(Optional)_ |
-|  [modify?](./foundation-comms.dataupdate.modify.md) |  | Array<any> | _(Optional)_ |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[add?](./foundation-comms.dataupdate.add.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Array&lt;any&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[drop?](./foundation-comms.dataupdate.drop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Array&lt;any&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[modify?](./foundation-comms.dataupdate.modify.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Array&lt;any&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.dataview.md

@@ -14,10 +14,102 @@ export interface Dataview
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [columnsMetadata?](./foundation-comms.dataview.columnsmetadata.md) |  | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | _(Optional)_ An array of objects representing the metadata of each column in the dataview. |
-|  [data](./foundation-comms.dataview.data.md) |  | any\[\] | An array of data objects representing the data in the dataview. |
-|  [hideSearch?](./foundation-comms.dataview.hidesearch.md) |  | boolean | _(Optional)_ A boolean indicating whether the search functionality should be hidden in the UI. |
-|  [update?](./foundation-comms.dataview.update.md) |  | (data: [DataUpdate](./foundation-comms.dataupdate.md)<!-- -->) =&gt; Promise&lt;void&gt; | _(Optional)_ Function to update the data in the dataview object with an object of optional add, drop, and modify arrays of data. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[columnsMetadata?](./foundation-comms.dataview.columnsmetadata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\]
+
+
+</td><td>
+
+_(Optional)_ An array of objects representing the metadata of each column in the dataview.
+
+
+</td></tr>
+<tr><td>
+
+[data](./foundation-comms.dataview.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any\[\]
+
+
+</td><td>
+
+An array of data objects representing the data in the dataview.
+
+
+</td></tr>
+<tr><td>
+
+[hideSearch?](./foundation-comms.dataview.hidesearch.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ A boolean indicating whether the search functionality should be hidden in the UI.
+
+
+</td></tr>
+<tr><td>
+
+[update?](./foundation-comms.dataview.update.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(data: [DataUpdate](./foundation-comms.dataupdate.md)<!-- -->) =&gt; Promise&lt;void&gt;
+
+
+</td><td>
+
+_(Optional)_ Function to update the data in the dataview object with an object of optional add, drop, and modify arrays of data.
+
+
+</td></tr>
+</tbody></table>