IgxComboBaseDirective

new IgxComboBaseDirective(): IgxComboBaseDirective

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1044

Returns IgxComboBaseDirective

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:694

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:560

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:235

Sets aria-labelledby attribute value.

<igx-combo [ariaLabelledBy]="'label1'">
ariaLabelledBy: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:450

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:759

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:550

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:540

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:580

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:479

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:463

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:717

Gets/Sets the custom filtering function of the combo.

filterFunction: object

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:441

Example

<igx-comb #combo [data]="localData" [filterFunction]="filterFunction"></igx-combo>

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:650

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:671

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:627

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:305

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:604

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:530

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:520

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

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:171

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:321

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:570

selectionChanged: EventEmitter<any>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1042

selectionChanging: EventEmitter<any>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1041

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:141

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>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:738

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

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:360

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:219

Gets drop down state.

let state = this.combo.collapsed;
get collapsed(): boolean

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:906

Returns boolean

Combo data source.

<!--set-->
<igx-combo [data]='items'></igx-combo>
get data(): any[] | null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:332

Returns any[] | null

set data(val: any[] | null): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:335

Parameters

  • val: any[] | null

Returns void

Enables/disables filtering in the list. The default is false.

get disableFiltering(): boolean

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:147

Returns boolean

set disableFiltering(value: boolean): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:150

Parameters

  • value: boolean

Returns void

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:384

Returns string

set displayKey(val: string): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:363

Parameters

  • val: string

Returns void

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:870

Returns string

get filteredData(): any[] | null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1548

Returns any[] | null

set filteredData(val: any[] | null): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1549

Parameters

  • val: any[] | null

Returns void

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:981

Returns IComboFilteringOptions

set filteringOptions(value: IComboFilteringOptions): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:984

Parameters

Returns void

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:409

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:397

Parameters

  • val: string

Returns void

Sets groups sorting order.

get groupSortingDirection(): SortingDirection

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:425

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:428

Parameters

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:188

Returns string

set id(value: string): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:192

Parameters

  • value: string

Returns void

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:283

Returns number

set itemHeight(val: number): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:287

Parameters

  • val: number

Returns void

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:251

Returns number

set itemsMaxHeight(val: number): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:258

Parameters

  • val: number

Returns void

Gets/Sets the resource strings.

get resourceStrings(): IComboResourceStrings

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:504

Returns IComboResourceStrings

set resourceStrings(value: IComboResourceStrings): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:507

Parameters

Returns void

set searchValue(val: string): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:805

Parameters

  • val: string

Returns void

Get current selection state

get selection(): any[]

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1226

Returns any[]

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:918

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:929

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:489

Returns IgxInputGroupType

set type(val: IgxInputGroupType): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:493

Parameters

Returns void

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:833

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:845

Parameters

Returns void

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:858

Returns any[]

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:882

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:893

Parameters

Returns void

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:1207

Returns void

deselect(args: tuple | [items, event]): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1558

Parameters

  • args: tuple | [items, event]

Returns void

focusSearchInput(opening: boolean): any

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1553

Parameters

  • opening: boolean

Returns any

handleOpened(): any

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1551

Returns any

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:1051

Returns void

onArrowDown(event: Event): any

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1552

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:1189

Returns void

select(newItem: any): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1555

Parameters

  • newItem: any

Returns void

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:1169

Returns void

Triggers change detection on the combo view

triggerCheck(): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1214

Returns void

writeValue(value: any): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1560

Parameters

  • value: any

Returns void