@genesislcap/foundation-entity-management 14.373.2 → 14.374.1

package/docs/api/foundation-entity-management.list.md

@@ -0,0 +1,988 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [List](./foundation-entity-management.list.md)
+
+## List class
+
+**Signature:**
+
+```typescript
+export declare class List extends List_base 
+```
+**Extends:** List\_base
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[actionButtonsConfig](./foundation-entity-management.list.actionbuttonsconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[asyncAdd](./foundation-entity-management.list.asyncadd.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[asyncRemove](./foundation-entity-management.list.asyncremove.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[asyncUpdate](./foundation-entity-management.list.asyncupdate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[columns](./foundation-entity-management.list.columns.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ColDef\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[connect](./foundation-entity-management.list.connect.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Connect
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[createEvent](./foundation-entity-management.list.createevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[criteria](./foundation-entity-management.list.criteria.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[customActions](./foundation-entity-management.list.customactions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[CustomAction](./foundation-entity-management.customaction.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[datasource](./foundation-entity-management.list.datasource.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridProGenesisDatasource
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[datasourceConfig](./foundation-entity-management.list.datasourceconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[datasourceType](./foundation-entity-management.list.datasourcetype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+DatasourceType
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[deleteEvent](./foundation-entity-management.list.deleteevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disablePolling](./foundation-entity-management.list.disablepolling.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[enableCellFlashing](./foundation-entity-management.list.enablecellflashing.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[enableFilterBar](./foundation-entity-management.list.enablefilterbar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[enableRowFlashing](./foundation-entity-management.list.enablerowflashing.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[fields](./foundation-entity-management.list.fields.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[grid](./foundation-entity-management.list.grid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ZeroGridPro
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[gridAutosizing](./foundation-entity-management.list.gridautosizing.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.
+
+
+</td></tr>
+<tr><td>
+
+[gridOptions](./foundation-entity-management.list.gridoptions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridOptions
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[headerCaseType](./foundation-entity-management.list.headercasetype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridProCaseType
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hideDelete](./foundation-entity-management.list.hidedelete.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hideEdit](./foundation-entity-management.list.hideedit.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isServerSideDatasource](./foundation-entity-management.list.isserversidedatasource.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isSnapshot](./foundation-entity-management.list.issnapshot.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[maxRows](./foundation-entity-management.list.maxrows.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[maxView](./foundation-entity-management.list.maxview.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[movingView](./foundation-entity-management.list.movingview.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[orderBy](./foundation-entity-management.list.orderby.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[persistColumnStateKey](./foundation-entity-management.list.persistcolumnstatekey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[persistFilterModelKey](./foundation-entity-management.list.persistfiltermodelkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[pollingInterval](./foundation-entity-management.list.pollinginterval.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[pollTriggerEvents](./foundation-entity-management.list.polltriggerevents.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[prefix](./foundation-entity-management.list.prefix.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Name of the design system prefix that will be used in renderers.
+
+
+</td></tr>
+<tr><td>
+
+[request](./foundation-entity-management.list.request.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[requestAutoSetup](./foundation-entity-management.list.requestautosetup.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resourceName](./foundation-entity-management.list.resourcename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[reverse](./foundation-entity-management.list.reverse.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[rowSelection](./foundation-entity-management.list.rowselection.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[sizeColumnsToContent](./foundation-entity-management.list.sizecolumnstocontent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Auto-sizes a column based on its contents
+
+
+</td></tr>
+<tr><td>
+
+[sizeColumnsToFit](./foundation-entity-management.list.sizecolumnstofit.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Resizes columns to take available space
+
+
+</td></tr>
+<tr><td>
+
+[statusBarConfig](./foundation-entity-management.list.statusbarconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridProStatusBarConfig
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[title](./foundation-entity-management.list.title.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[updateEvent](./foundation-entity-management.list.updateevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[viewNumber](./foundation-entity-management.list.viewnumber.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[connectedCallback()](./foundation-entity-management.list.connectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[delete(e)](./foundation-entity-management.list.delete.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disconnectedCallback()](./foundation-entity-management.list.disconnectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[handleCellEditRequest(event)](./foundation-entity-management.list.handlecelleditrequest.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[handleRowClicked(e)](./foundation-entity-management.list.handlerowclicked.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[handleRowContextMenu(e)](./foundation-entity-management.list.handlerowcontextmenu.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[handleRowDblClicked(e)](./foundation-entity-management.list.handlerowdblclicked.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[handleRowSelected(e)](./foundation-entity-management.list.handlerowselected.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[handleSelectionChanged(e)](./foundation-entity-management.list.handleselectionchanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+