grid-pro.multicolumndropdown

Home > @genesislcap/grid-pro > MulticolumnDropdown

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:

export declare class MulticolumnDropdown extends MulticolumnDropdown_base 

Extends: MulticolumnDropdown_base

Properties

Property	Modifiers	Type	Description
baseCriteria?		string	(Optional) Base criteria that is always applied to requests combined with search criteria via AND. Use this to pre-filter results.
columnDefinitions		ColDef[]	An array of AG Grid column definitions to use in the grid to display the data
connect		Connect	The connect service - uses DI by default, but can be manually set for dynamic element creation
defaultSlottedNodes		Node[]
disabled		boolean	Whether to disable control of the component
displayValue	readonly	any	Value to display in the form field
dropdownPlacement		'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'	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
dropdownWidth		number	Optionally specifies the width of the dropdown
filterSearch		string	The criteria to search by
grid		GridPro
hasSearchKey	readonly	boolean
hasSlottedContent	readonly	boolean
labelKey		string	The key used as the label displayed in the UI
open		boolean	Whether the dropdown is open or not
optionsElement		HTMLElement
request		object	A request object to pass in the reqrep
requestSupportsAdvancedSearch		boolean	Tells whether a given request supports lookup by Groovy Expressions.
resourceName		string	The name of the reqrep to get the options from
searchKey?		string | string[]	(Optional) The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key="NAME,ID").
selectedRow		object	Data for the selected row
value		string
valueKey		string	The key used as the value sent to the server

Methods

Method	Modifiers	Description
changeHandler(event)
columnDefinitionsChanged()
connectedCallback()
disconnectedCallback()
dropdownWidthChanged()
filterSearchChanged()
openChanged()
requestChanged()
toggle()