Constructors
Section titled "Constructors"IgxComboBaseDirective
new IgxComboBaseDirective(): IgxComboBaseDirective Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1003
Returns IgxComboBaseDirective
Properties
Section titled "Properties"addItemTemplate
Section titled "addItemTemplate"The custom template, if any, that should be used when rendering the ADD BUTTON in the combo drop down
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.addItemTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboAddItem>
<button type="button" igxButton="contained" class="combo__add-button">
Click to add item
</button>
</ng-template>
</igx-combo> addItemTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:687
addition
Section titled "addition"Emitted when an item is being added to the data collection
<igx-combo (addition)='handleAdditionEvent($event)'></igx-combo> addition: EventEmitter<IComboItemAdditionEvent> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:553
allowCustomValues
Section titled "allowCustomValues"Controls whether custom values can be added to the collection
// get
let comboAllowsCustomValues = this.combo.allowCustomValues;<!--set-->
<igx-combo [allowCustomValues]='true'></igx-combo> allowCustomValues: boolean = false Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:230
ariaLabelledBy
Section titled "ariaLabelledBy"Sets aria-labelledby attribute value.
<igx-combo [ariaLabelledBy]="'label1'"> ariaLabelledBy: string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:444
clearIconTemplate
Section titled "clearIconTemplate"The custom template, if any, that should be used when rendering the combo CLEAR button
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.clearIconTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboClearIcon>
<igx-icon>clear</igx-icon>
</ng-template>
</igx-combo> clearIconTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:752
closed
Section titled "closed"Emitted after the dropdown is closed
<igx-combo (closed)='handleClosed($event)'></igx-combo> closed: EventEmitter<IBaseEventArgs> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:543
closing
Section titled "closing"Emitted before the dropdown is closed
<igx-combo (closing)='handleClosing($event)'></igx-combo> closing: EventEmitter<IBaseCancelableBrowserEventArgs> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:533
dataPreLoad
Section titled "dataPreLoad"Emitted when new chunk of data is loaded from the virtualization
<igx-combo (dataPreLoad)='handleDataPreloadEvent($event)'></igx-combo> dataPreLoad: EventEmitter<IForOfState> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:573
disableClear
Section titled "disableClear"Disables the clear button. The default is false.
// get
let myComboDisableClear = this.combo.disableClear;<!--set-->
<igx-combo [disableClear]="true"></igx-combo> disableClear: boolean = false Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:473
disabled
Section titled "disabled"Disables the combo. The default is false.
<igx-combo [disabled]="'true'"> disabled: boolean = false Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:457
document
Section titled "document"document: Document Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:117
dropdown
Section titled "dropdown"dropdown: IgxComboDropDownComponent Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:999
emptyTemplate
Section titled "emptyTemplate"The custom template, if any, that should be used when rendering the ADD BUTTON in the combo drop down
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.emptyTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboEmpty>
<div class="combo--empty">
There are no items to display
</div>
</ng-template>
</igx-combo> emptyTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:710
filterFunction
Section titled "filterFunction"Gets/Sets the custom filtering function of the combo.
filterFunction: object Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:435
Example
<igx-comb #combo [data]="localData" [filterFunction]="filterFunction"></igx-combo> footerTemplate
Section titled "footerTemplate"The custom template, if any, that should be used when rendering the FOOTER for the combo items list
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.footerTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboFooter>
<div class="combo__footer">
This is a custom footer
</div>
</ng-template>
</igx-combo> footerTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:643
headerItemTemplate
Section titled "headerItemTemplate"The custom template, if any, that should be used when rendering HEADER ITEMS for groups in the combo list
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.headerItemTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboHeaderItem let-item let-key="groupKey">
<div class="custom-item--group">Group header for {{ item[key] }}</div>
</ng-template>
</igx-combo> headerItemTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:664
headerTemplate
Section titled "headerTemplate"The custom template, if any, that should be used when rendering the HEADER for the combo items list
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.headerTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboHeader>
<div class="combo__header">
This is a custom header
</div>
</ng-template>
</igx-combo> headerTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:620
itemsWidth
Section titled "itemsWidth"Configures the drop down list width
// get
let myComboItemsWidth = this.combo.itemsWidth;<!--set-->
<igx-combo [itemsWidth] = '"180px"'></igx-combo> itemsWidth: string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:300
itemTemplate
Section titled "itemTemplate"The custom template, if any, that should be used when rendering ITEMS in the combo list
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.itemTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboItem let-item let-key="valueKey">
<div class="custom-item">
<div class="custom-item__name">{{ item[key] }}</div>
<div class="custom-item__cost">{{ item.cost }}</div>
</div>
</ng-template>
</igx-combo> itemTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:597
opened
Section titled "opened"Emitted after the dropdown is opened
<igx-combo (opened)='handleOpened($event)'></igx-combo> opened: EventEmitter<IBaseEventArgs> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:523
opening
Section titled "opening"Emitted before the dropdown is opened
<igx-combo opening='handleOpening($event)'></igx-combo> opening: EventEmitter<IBaseCancelableBrowserEventArgs> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:513
overlaySettings
Section titled "overlaySettings"Set custom overlay settings that control how the combo's list of items is displayed. Set:
<igx-combo [overlaySettings]="customOverlaySettings"></igx-combo>const customSettings = { positionStrategy: { settings: { target: myTarget } } };
combo.overlaySettings = customSettings;Get any custom overlay settings used by the combo:
const comboOverlaySettings: OverlaySettings = myCombo.overlaySettings; overlaySettings: OverlaySettings = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:166
placeholder
Section titled "placeholder"Defines the placeholder value for the combo value field
// get
let myComboPlaceholder = this.combo.placeholder;<!--set-->
<igx-combo [placeholder]='newPlaceHolder'></igx-combo> placeholder: string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:316
searchInputUpdate
Section titled "searchInputUpdate"Emitted when the value of the search input changes (e.g. typing, pasting, clear, etc.)
<igx-combo (searchInputUpdate)='handleSearchInputEvent($event)'></igx-combo> searchInputUpdate: EventEmitter<IComboSearchInputEventArgs> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:563
selectionChanged
Section titled "selectionChanged"selectionChanged: EventEmitter<any> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1001
selectionChanging
Section titled "selectionChanging"selectionChanging: EventEmitter<any> Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1000
showSearchCaseIcon
Section titled "showSearchCaseIcon"Defines whether the caseSensitive icon should be shown in the search input
// get
let myComboShowSearchCaseIcon = this.combo.showSearchCaseIcon;<!--set-->
<igx-combo [showSearchCaseIcon]='true'></igx-combo> showSearchCaseIcon: boolean = false Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:136
toggleIconTemplate
Section titled "toggleIconTemplate"The custom template, if any, that should be used when rendering the combo TOGGLE(open/close) button
// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.toggleIconTemplate = myCustomTemplate;<!-- Set in markup -->
<igx-combo #combo>
...
<ng-template igxComboToggleIcon let-collapsed>
<igx-icon>{{ collapsed ? 'remove_circle' : 'remove_circle_outline'}}</igx-icon>
</ng-template>
</igx-combo> toggleIconTemplate: TemplateRef<any> = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:731
valueKey
Section titled "valueKey"Determines which column in the data source is used to determine the value.
// get
let myComboValueKey = this.combo.valueKey;<!--set-->
<igx-combo [valueKey]='myKey'></igx-combo> valueKey: string = null Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:354
width
Section titled "width"Sets the style width of the element
// get
let myComboWidth = this.combo.width;<!--set-->
<igx-combo [width]='250px'></igx-combo> width: string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:214
Accessors
Section titled "Accessors"collapsed
Section titled "collapsed"Gets drop down state.
let state = this.combo.collapsed; get collapsed(): boolean Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:897
Returns boolean
Combo data source.
<!--set-->
<igx-combo [data]='items'></igx-combo> get data(): any[] Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:327
Returns any[]
set data(val: any[]): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:330
Parameters
- val:
any[]
Returns void
disableFiltering
Section titled "disableFiltering"Enables/disables filtering in the list. The default is false.
get disableFiltering(): boolean Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:142
Returns boolean
set disableFiltering(value: boolean): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:145
Parameters
- value:
boolean
Returns void
displayKey
Section titled "displayKey"Determines which column in the data source is used to determine the display value.
// get
let myComboDisplayKey = this.combo.displayKey;
// set
this.combo.displayKey = 'val';<!--set-->
<igx-combo [displayKey]='myDisplayKey'></igx-combo> get displayKey(): string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:378
Returns string
set displayKey(val: string): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:357
Parameters
- val:
string
Returns void
displayValue
Section titled "displayValue"The text displayed in the combo input
// get
let comboDisplayValue = this.combo.displayValue; get displayValue(): string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:863
Returns string
filteredData
Section titled "filteredData"get filteredData(): any[] Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1424
Returns any[]
set filteredData(val: any[]): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1425
Parameters
- val:
any[]
Returns void
filteringOptions
Section titled "filteringOptions"Configures the way combo items will be filtered.
// get
let myFilteringOptions = this.combo.filteringOptions;<!--set-->
<igx-combo [filteringOptions]='myFilteringOptions'></igx-combo> get filteringOptions(): IComboFilteringOptions Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:960
Returns IComboFilteringOptions
set filteringOptions(value: IComboFilteringOptions): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:963
Parameters
- value:
IComboFilteringOptions
Returns void
groupKey
Section titled "groupKey"The item property by which items should be grouped inside the items list. Not usable if data is not of type Object[].
// get
let currentGroupKey = this.combo.groupKey; get groupKey(): string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:403
Returns string
The item property by which items should be grouped inside the items list. Not usable if data is not of type Object[].
<!--set-->
<igx-combo [groupKey]='newGroupKey'></igx-combo> set groupKey(val: string): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:391
Parameters
- val:
string
Returns void
groupSortingDirection
Section titled "groupSortingDirection"Sets groups sorting order.
get groupSortingDirection(): SortingDirection Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:419
Example
<igx-combo [groupSortingDirection]="groupSortingDirection"></igx-combo>public groupSortingDirection = SortingDirection.Asc;
Returns SortingDirection
set groupSortingDirection(val: SortingDirection): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:422
Parameters
- val:
SortingDirection
Returns void
Gets/gets combo id.
// get
let id = this.combo.id;<!--set-->
<igx-combo [id]='combo1'></igx-combo> get id(): string Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:183
Returns string
set id(value: string): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:187
Parameters
- value:
string
Returns void
itemHeight
Section titled "itemHeight"Configures the drop down list item height
// get
let myComboItemHeight = this.combo.itemHeight;<!--set-->
<igx-combo [itemHeight]='32'></igx-combo> get itemHeight(): number Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:278
Returns number
set itemHeight(val: number): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:282
Parameters
- val:
number
Returns void
itemsMaxHeight
Section titled "itemsMaxHeight"Configures the drop down list height
// get
let myComboItemsMaxHeight = this.combo.itemsMaxHeight;<!--set-->
<igx-combo [itemsMaxHeight]='320'></igx-combo> get itemsMaxHeight(): number Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:246
Returns number
set itemsMaxHeight(val: number): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:253
Parameters
- val:
number
Returns void
resourceStrings
Section titled "resourceStrings"Gets/Sets the resource strings.
get resourceStrings(): IComboResourceStrings Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:498
Returns IComboResourceStrings
set resourceStrings(value: IComboResourceStrings): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:501
Parameters
- value:
IComboResourceStrings
Returns void
searchValue
Section titled "searchValue"get searchValue(): any Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:798
set searchValue(val: string): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:798
Parameters
- val:
string
Returns void
selection
Section titled "selection"Get current selection state
get selection(): any[] Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1145
Returns any[]
totalItemCount
Section titled "totalItemCount"Gets total count of the virtual data items, when using remote service.
// get
let count = this.combo.totalItemCount; get totalItemCount(): number Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:909
Returns number
Sets total count of the virtual data items, when using remote service.
// set
this.combo.totalItemCount(remoteService.count); set totalItemCount(count: number): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:920
Parameters
- count:
number
Returns void
Sets the visual combo type.
The allowed values are line, box, border and search. The default is box.
<igx-combo [type]="'line'"> get type(): IgxInputGroupType Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:483
Returns IgxInputGroupType
set type(val: IgxInputGroupType): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:487
Parameters
- val:
IgxInputGroupType
Returns void
valid
Section titled "valid"Gets if control is valid, when used in a form
// get
let valid = this.combo.valid; get valid(): IgxInputState Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:826
Returns IgxInputState
Sets if control is valid, when used in a form
// set
this.combo.valid = IgxInputState.INVALID; set valid(valid: IgxInputState): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:838
Parameters
- valid:
IgxInputState
Returns void
value
Section titled "value"The value of the combo
// get
let comboValue = this.combo.value; get value(): any[] Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:851
Returns any[]
virtualizationState
Section titled "virtualizationState"Defines the current state of the virtualized data. It contains startIndex and chunkSize
// get
let state = this.combo.virtualizationState; get virtualizationState(): IForOfState Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:875
Returns IForOfState
Sets the current state of the virtualized data.
// set
this.combo.virtualizationState(state); set virtualizationState(state: IForOfState): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:886
Parameters
- state:
IForOfState
Returns void
Methods
Section titled "Methods"close
Section titled "close"A method that closes the combo.
<button type="button" (click)="combo.close()">Close Combo</button>
<igx-combo #combo></igx-combo> close(): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1126
Returns void
deselect
Section titled "deselect"deselect(args: tuple | [items, event]): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1434
Parameters
- args:
tuple | [items, event]
Returns void
focusSearchInput
Section titled "focusSearchInput"focusSearchInput(opening: boolean): any Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1429
Parameters
- opening:
boolean
Returns any
handleOpened
Section titled "handleOpened"handleOpened(): any Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1427
Returns any
ngAfterViewChecked
Section titled "ngAfterViewChecked"A callback method that is invoked immediately after the default change detector has completed one change-check cycle for a component's view.
ngAfterViewChecked(): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1009
Returns void
onArrowDown
Section titled "onArrowDown"onArrowDown(event: Event): any Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1428
Parameters
- event:
Event
Returns any
A method that opens the combo.
<button type="button" (click)="combo.open()">Open Combo</button>
<igx-combo #combo></igx-combo> open(): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1108
Returns void
select
Section titled "select"select(newItem: any): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1431
Parameters
- newItem:
any
Returns void
toggle
Section titled "toggle"A method that opens/closes the combo.
<button type="button" (click)="combo.toggle()">Toggle Combo</button>
<igx-combo #combo></igx-combo> toggle(): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1088
Returns void
triggerCheck
Section titled "triggerCheck"Triggers change detection on the combo view
triggerCheck(): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1133
Returns void
writeValue
Section titled "writeValue"writeValue(value: any): void Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1436
Parameters
- value:
any