@genesislcap/grid-pro 14.405.0 → 14.406.0-workspaces.2

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

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getMulticolumnDropdownTemplate](./grid-pro.getmulticolumndropdowntemplate.md)
+
+## getMulticolumnDropdownTemplate() function
+
+Get a Design System prefixed Multicolumn Dropdown template.
+
+**Signature:**
+
+```typescript
+getMulticolumnDropdownTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<MulticolumnDropdown, any>
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+designSystem
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The design system prefix to use. Defaults to 'foundation'.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+import("@microsoft/fast-element").ViewTemplate&lt;[MulticolumnDropdown](./grid-pro.multicolumndropdown.md)<!-- -->, any&gt;
+
+A Multicolumn Dropdown component template prefixed with the correct design system.
+

package/docs/api/grid-pro.md

@@ -232,6 +232,17 @@ A status bar component that shows a "Load More" button when more rows are availa
 Implementation for the Local Storage State Persistence interface.
 
 
+</td></tr>
+<tr><td>
+
+[MulticolumnDropdown](./grid-pro.multicolumndropdown.md)
+
+
+</td><td>
+
+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.
+
+
 </td></tr>
 <tr><td>
 
@@ -623,6 +634,17 @@ A function that returns a Foundation Action Renderer for configuring the compone
 A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem.
 
 
+</td></tr>
+<tr><td>
+
+[foundationMulticolumnDropdown(overrideDefinition)](./grid-pro.foundationmulticolumndropdown.md)
+
+
+</td><td>
+
+A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.
+
+
 </td></tr>
 <tr><td>
 
@@ -778,6 +800,17 @@ Returns the filter params for enum fields based on the detected filter type.
 Get a Design System prefixed The Grid Pro template.
 
 
+</td></tr>
+<tr><td>
+
+[getMulticolumnDropdownTemplate(designSystem)](./grid-pro.getmulticolumndropdowntemplate.md)
+
+
+</td><td>
+
+Get a Design System prefixed Multicolumn Dropdown template.
+
+
 </td></tr>
 <tr><td>
 
@@ -886,6 +919,17 @@ A directive that renders a set of grid-pro-column elements from a given input bi
 Merges two arrays, one of `ColDef` and one of `ColumnState`<!-- -->, and deduplicates them.
 
 
+</td></tr>
+<tr><td>
+
+[wasClickOutsideElement(event, target)](./grid-pro.wasclickoutsideelement.md)
+
+
+</td><td>
+
+Checks if the given mouse event occurred outside the target element.
+
+
 </td></tr>
 </tbody></table>
 
@@ -1521,6 +1565,28 @@ Default grid options
 Grid Pro default configuration.
 
 
+</td></tr>
+<tr><td>
+
+[DISPLAY\_NONE\_CLASS](./grid-pro.display_none_class.md)
+
+
+</td><td>
+
+Class name used to hide elements with display:none
+
+
+</td></tr>
+<tr><td>
+
+[dropdownWidthVar](./grid-pro.dropdownwidthvar.md)
+
+
+</td><td>
+
+The CSS variable to use for specifying the dropdown's width
+
+
 </td></tr>
 <tr><td>
 
@@ -1649,6 +1715,39 @@ The Genesis Datasource events names.
 Logger for the grid-pro package
 
 
+</td></tr>
+<tr><td>
+
+[multicolumnDropdownStyles](./grid-pro.multicolumndropdownstyles.md)
+
+
+</td><td>
+
+Multicolumn Dropdown styles.
+
+
+</td></tr>
+<tr><td>
+
+[multicolumnDropdownTemplate](./grid-pro.multicolumndropdowntemplate.md)
+
+
+</td><td>
+
+The default Multicolumn Dropdown template using the 'foundation' design system prefix.
+
+
+</td></tr>
+<tr><td>
+
+[optionsClass](./grid-pro.optionsclass.md)
+
+
+</td><td>
+
+The CSS class to use for the options element's class in the dropdown
+
+
 </td></tr>
 <tr><td>
 

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

@@ -0,0 +1,13 @@
+<!-- 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; [baseCriteria](./grid-pro.multicolumndropdown.basecriteria.md)
+
+## MulticolumnDropdown.baseCriteria property
+
+Base criteria that is always applied to requests combined with search criteria via AND. Use this to pre-filter results.
+
+**Signature:**
+
+```typescript
+baseCriteria?: string;
+```

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

@@ -0,0 +1,50 @@
+<!-- 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; [changeHandler](./grid-pro.multicolumndropdown.changehandler.md)
+
+## MulticolumnDropdown.changeHandler() method
+
+**Signature:**
+
+```typescript
+changeHandler(event: Event): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+event
+
+
+</td><td>
+
+Event
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,13 @@
+<!-- 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; [columnDefinitions](./grid-pro.multicolumndropdown.columndefinitions.md)
+
+## MulticolumnDropdown.columnDefinitions property
+
+An array of AG Grid column definitions to use in the grid to display the data
+
+**Signature:**
+
+```typescript
+columnDefinitions: ColDef[];
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [columnDefinitionsChanged](./grid-pro.multicolumndropdown.columndefinitionschanged.md)
+
+## MulticolumnDropdown.columnDefinitionsChanged() method
+
+**Signature:**
+
+```typescript
+columnDefinitionsChanged(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,15 @@
+<!-- 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; [connect](./grid-pro.multicolumndropdown.connect.md)
+
+## MulticolumnDropdown.connect property
+
+The connect service - uses DI by default, but can be manually set for dynamic element creation
+
+**Signature:**
+
+```typescript
+get connect(): Connect;
+
+set connect(value: Connect);
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [connectedCallback](./grid-pro.multicolumndropdown.connectedcallback.md)
+
+## MulticolumnDropdown.connectedCallback() method
+
+**Signature:**
+
+```typescript
+connectedCallback(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,11 @@
+<!-- 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; [defaultSlottedNodes](./grid-pro.multicolumndropdown.defaultslottednodes.md)
+
+## MulticolumnDropdown.defaultSlottedNodes property
+
+**Signature:**
+
+```typescript
+defaultSlottedNodes: Node[];
+```

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

@@ -0,0 +1,13 @@
+<!-- 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; [disabled](./grid-pro.multicolumndropdown.disabled.md)
+
+## MulticolumnDropdown.disabled property
+
+Whether to disable control of the component
+
+**Signature:**
+
+```typescript
+disabled: boolean;
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [disconnectedCallback](./grid-pro.multicolumndropdown.disconnectedcallback.md)
+
+## MulticolumnDropdown.disconnectedCallback() method
+
+**Signature:**
+
+```typescript
+disconnectedCallback(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,13 @@
+<!-- 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; [displayValue](./grid-pro.multicolumndropdown.displayvalue.md)
+
+## MulticolumnDropdown.displayValue property
+
+Value to display in the form field
+
+**Signature:**
+
+```typescript
+get displayValue(): any;
+```

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

@@ -0,0 +1,13 @@
+<!-- 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; [dropdownPlacement](./grid-pro.multicolumndropdown.dropdownplacement.md)
+
+## MulticolumnDropdown.dropdownPlacement property
+
+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
+
+**Signature:**
+
+```typescript
+dropdownPlacement: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+```

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

@@ -0,0 +1,13 @@
+<!-- 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; [dropdownWidth](./grid-pro.multicolumndropdown.dropdownwidth.md)
+
+## MulticolumnDropdown.dropdownWidth property
+
+Optionally specifies the width of the dropdown
+
+**Signature:**
+
+```typescript
+dropdownWidth: number;
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [dropdownWidthChanged](./grid-pro.multicolumndropdown.dropdownwidthchanged.md)
+
+## MulticolumnDropdown.dropdownWidthChanged() method
+
+**Signature:**
+
+```typescript
+dropdownWidthChanged(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,13 @@
+<!-- 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; [filterSearch](./grid-pro.multicolumndropdown.filtersearch.md)
+
+## MulticolumnDropdown.filterSearch property
+
+The criteria to search by
+
+**Signature:**
+
+```typescript
+filterSearch: string;
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [filterSearchChanged](./grid-pro.multicolumndropdown.filtersearchchanged.md)
+
+## MulticolumnDropdown.filterSearchChanged() method
+
+**Signature:**
+
+```typescript
+filterSearchChanged(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,11 @@
+<!-- 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; [grid](./grid-pro.multicolumndropdown.grid.md)
+
+## MulticolumnDropdown.grid property
+
+**Signature:**
+
+```typescript
+grid: GridPro;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [hasSearchKey](./grid-pro.multicolumndropdown.hassearchkey.md)
+
+## MulticolumnDropdown.hasSearchKey property
+
+**Signature:**
+
+```typescript
+get hasSearchKey(): boolean;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [hasSlottedContent](./grid-pro.multicolumndropdown.hasslottedcontent.md)
+
+## MulticolumnDropdown.hasSlottedContent property
+
+**Signature:**
+
+```typescript
+get hasSlottedContent(): boolean;
+```

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

@@ -0,0 +1,13 @@
+<!-- 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; [labelKey](./grid-pro.multicolumndropdown.labelkey.md)
+
+## MulticolumnDropdown.labelKey property
+
+The key used as the label displayed in the UI
+
+**Signature:**
+
+```typescript
+labelKey: string;
+```