@genesislcap/grid-pro 14.408.0 → 14.409.0

package/docs/api/grid-pro.multicolumndropdown.md

@@ -1,580 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md)
-
-## MulticolumnDropdown class
-
-A dropdown component that displays its options in a multi-column AG Grid. Search triggers a reqrep and displays the results in the grid dropdown.
-
-**Signature:**
-
-```typescript
-export declare class MulticolumnDropdown extends MulticolumnDropdown_base 
-```
-**Extends:** MulticolumnDropdown\_base
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[baseCriteria?](./grid-pro.multicolumndropdown.basecriteria.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Base criteria that is always applied to requests combined with search criteria via AND. Use this to pre-filter results.
-
-
-</td></tr>
-<tr><td>
-
-[columnDefinitions](./grid-pro.multicolumndropdown.columndefinitions.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ColDef\[\]
-
-
-</td><td>
-
-An array of AG Grid column definitions to use in the grid to display the data
-
-
-</td></tr>
-<tr><td>
-
-[connect](./grid-pro.multicolumndropdown.connect.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Connect
-
-
-</td><td>
-
-The connect service - uses DI by default, but can be manually set for dynamic element creation
-
-
-</td></tr>
-<tr><td>
-
-[defaultSlottedNodes](./grid-pro.multicolumndropdown.defaultslottednodes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Node\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[disabled](./grid-pro.multicolumndropdown.disabled.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether to disable control of the component
-
-
-</td></tr>
-<tr><td>
-
-[displayValue](./grid-pro.multicolumndropdown.displayvalue.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-Value to display in the form field
-
-
-</td></tr>
-<tr><td>
-
-[dropdownPlacement](./grid-pro.multicolumndropdown.dropdownplacement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-'bottom-right' \| 'bottom-left' \| 'top-right' \| 'top-left'
-
-
-</td><td>
-
-Position of the dropdown panel relative to the control. - `'bottom-right'` – default; opens below and aligns to the right edge of the control - `'bottom-left'` – opens below and extends to the left - `'top-right'` – opens above and aligns to the right edge of the control - `'top-left'` – opens above and extends to the left
-
-
-</td></tr>
-<tr><td>
-
-[dropdownWidth](./grid-pro.multicolumndropdown.dropdownwidth.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Optionally specifies the width of the dropdown
-
-
-</td></tr>
-<tr><td>
-
-[filterSearch](./grid-pro.multicolumndropdown.filtersearch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The criteria to search by
-
-
-</td></tr>
-<tr><td>
-
-[grid](./grid-pro.multicolumndropdown.grid.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[GridPro](./grid-pro.gridpro.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[hasSearchKey](./grid-pro.multicolumndropdown.hassearchkey.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[hasSlottedContent](./grid-pro.multicolumndropdown.hasslottedcontent.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[labelKey](./grid-pro.multicolumndropdown.labelkey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The key used as the label displayed in the UI
-
-
-</td></tr>
-<tr><td>
-
-[open](./grid-pro.multicolumndropdown.open.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the dropdown is open or not
-
-
-</td></tr>
-<tr><td>
-
-[optionsElement](./grid-pro.multicolumndropdown.optionselement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[request](./grid-pro.multicolumndropdown.request.md)
-
-
-</td><td>
-
-
-</td><td>
-
-object
-
-
-</td><td>
-
-A request object to pass in the reqrep
-
-
-</td></tr>
-<tr><td>
-
-[requestSupportsAdvancedSearch](./grid-pro.multicolumndropdown.requestsupportsadvancedsearch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Tells whether a given request supports lookup by Groovy Expressions.
-
-
-</td></tr>
-<tr><td>
-
-[resourceName](./grid-pro.multicolumndropdown.resourcename.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The name of the reqrep to get the options from
-
-
-</td></tr>
-<tr><td>
-
-[searchKey?](./grid-pro.multicolumndropdown.searchkey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string \| string\[\]
-
-
-</td><td>
-
-_(Optional)_ The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key="NAME,ID").
-
-
-</td></tr>
-<tr><td>
-
-[selectedRow](./grid-pro.multicolumndropdown.selectedrow.md)
-
-
-</td><td>
-
-
-</td><td>
-
-object
-
-
-</td><td>
-
-Data for the selected row
-
-
-</td></tr>
-<tr><td>
-
-[value](./grid-pro.multicolumndropdown.value.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[valueKey](./grid-pro.multicolumndropdown.valuekey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The key used as the value sent to the server
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[changeHandler(event)](./grid-pro.multicolumndropdown.changehandler.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[columnDefinitionsChanged()](./grid-pro.multicolumndropdown.columndefinitionschanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[connectedCallback()](./grid-pro.multicolumndropdown.connectedcallback.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[disconnectedCallback()](./grid-pro.multicolumndropdown.disconnectedcallback.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[dropdownWidthChanged()](./grid-pro.multicolumndropdown.dropdownwidthchanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[filterSearchChanged()](./grid-pro.multicolumndropdown.filtersearchchanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[openChanged()](./grid-pro.multicolumndropdown.openchanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[requestChanged()](./grid-pro.multicolumndropdown.requestchanged.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[toggle()](./grid-pro.multicolumndropdown.toggle.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/grid-pro.multicolumndropdown.open.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [open](./grid-pro.multicolumndropdown.open.md)
-
-## MulticolumnDropdown.open property
-
-Whether the dropdown is open or not
-
-**Signature:**
-
-```typescript
-open: boolean;
-```

package/docs/api/grid-pro.multicolumndropdown.openchanged.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [openChanged](./grid-pro.multicolumndropdown.openchanged.md)
-
-## MulticolumnDropdown.openChanged() method
-
-**Signature:**
-
-```typescript
-openChanged(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/grid-pro.multicolumndropdown.optionselement.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [optionsElement](./grid-pro.multicolumndropdown.optionselement.md)
-
-## MulticolumnDropdown.optionsElement property
-
-**Signature:**
-
-```typescript
-optionsElement: HTMLElement;
-```

package/docs/api/grid-pro.multicolumndropdown.request.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [request](./grid-pro.multicolumndropdown.request.md)
-
-## MulticolumnDropdown.request property
-
-A request object to pass in the reqrep
-
-**Signature:**
-
-```typescript
-request: object;
-```

package/docs/api/grid-pro.multicolumndropdown.requestchanged.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [requestChanged](./grid-pro.multicolumndropdown.requestchanged.md)
-
-## MulticolumnDropdown.requestChanged() method
-
-**Signature:**
-
-```typescript
-requestChanged(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/grid-pro.multicolumndropdown.requestsupportsadvancedsearch.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [requestSupportsAdvancedSearch](./grid-pro.multicolumndropdown.requestsupportsadvancedsearch.md)
-
-## MulticolumnDropdown.requestSupportsAdvancedSearch property
-
-Tells whether a given request supports lookup by Groovy Expressions.
-
-**Signature:**
-
-```typescript
-requestSupportsAdvancedSearch: boolean;
-```
-
-## Remarks
-
-Only set this to TRUE for GPAL ReqReps when you want to search on multiple fields. Custom ReqReps don't support groovy expressions for criteria match.
-

package/docs/api/grid-pro.multicolumndropdown.resourcename.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [resourceName](./grid-pro.multicolumndropdown.resourcename.md)
-
-## MulticolumnDropdown.resourceName property
-
-The name of the reqrep to get the options from
-
-**Signature:**
-
-```typescript
-resourceName: string;
-```

package/docs/api/grid-pro.multicolumndropdown.searchkey.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [searchKey](./grid-pro.multicolumndropdown.searchkey.md)
-
-## MulticolumnDropdown.searchKey property
-
-The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key="NAME,ID").
-
-**Signature:**
-
-```typescript
-searchKey?: string | string[];
-```

package/docs/api/grid-pro.multicolumndropdown.selectedrow.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MulticolumnDropdown](./grid-pro.multicolumndropdown.md) &gt; [selectedRow](./grid-pro.multicolumndropdown.selectedrow.md)
-
-## MulticolumnDropdown.selectedRow property
-
-Data for the selected row
-
-**Signature:**
-
-```typescript
-selectedRow: object;
-```