devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
859 lines (616 loc) • 25.6 kB
TypeScript
/*!
* devextreme-angular
* Version: 20.2.5
* Build date: Fri Jan 15 2021
*
* Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-angular
*/
import { TransferState } from '@angular/platform-browser';
import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core';
import DevExpress from 'devextreme/bundles/dx.all';
import { dxPopupOptions } from 'devextreme/ui/popup';
import DxTagBox from 'devextreme/ui/tag_box';
import { ControlValueAccessor } from '@angular/forms';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
import { DxiButtonComponent } from 'devextreme-angular/ui/nested';
import { DxiItemComponent } from 'devextreme-angular/ui/nested';
/**
* The TagBox UI component is an editor that allows an end user to select multiple items from a drop-down list.
*/
export declare class DxTagBoxComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxTagBox;
/**
* Specifies whether the UI component allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation.
*/
acceptCustomValue: boolean;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
accessKey: string;
/**
* Specifies whether or not the UI component changes its state when interacting with a user.
*/
activeStateEnabled: boolean;
/**
* Specifies how the UI component applies values.
*/
applyValueMode: string;
/**
* Allows you to add custom buttons to the input text field.
*/
buttons: Array<string | DevExpress.ui.dxTextEditorButton>;
/**
* Binds the UI component to data.
*/
dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<DevExpress.ui.CollectionWidgetItem | any>;
/**
* Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.
*/
deferRendering: boolean;
/**
* Specifies whether the UI component responds to user interaction.
*/
disabled: boolean;
/**
* Specifies the data field whose values should be displayed.
*/
displayExpr: Function | string;
/**
* Specifies a custom template for the drop-down button.
*/
dropDownButtonTemplate: any;
/**
* Configures the drop-down field which holds the content.
*/
dropDownOptions: dxPopupOptions;
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
elementAttr: any;
/**
* Specifies a custom template for the text field. Must contain the TextBox UI component.
*/
fieldTemplate: any;
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
focusStateEnabled: boolean;
/**
* Specifies whether data items should be grouped.
*/
grouped: boolean;
/**
* Specifies a custom template for group captions.
*/
groupTemplate: any;
/**
* Specifies the UI component's height.
*/
height: number | Function | string;
/**
* A Boolean value specifying whether or not to hide selected items.
*/
hideSelectedItems: boolean;
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
hint: string;
/**
* Specifies whether the UI component changes its state when a user pauses on it.
*/
hoverStateEnabled: boolean;
/**
* Specifies the attributes to be passed on to the underlying HTML element.
*/
inputAttr: any;
/**
* Specifies or indicates whether the editor's value is valid.
*/
isValid: boolean;
/**
* An array of items displayed by the UI component.
*/
items: Array<any | {
disabled?: boolean;
html?: string;
template?: any;
text?: string;
visible?: boolean;
}>;
/**
* Specifies a custom template for items.
*/
itemTemplate: any;
/**
* Specifies the limit on displayed tags. On exceeding it, the UI component replaces all tags with a single multi-tag that displays the number of selected items.
*/
maxDisplayedTags: number;
/**
* Specifies the maximum number of characters you can enter into the textbox.
*/
maxLength: number | string;
/**
* The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true.
*/
minSearchLength: number;
/**
* A Boolean value specifying whether or not the UI component is multiline.
*/
multiline: boolean;
/**
* The value to be assigned to the `name` attribute of the underlying HTML element.
*/
name: string;
/**
* The text or HTML markup displayed by the UI component if the item collection is empty.
*/
noDataText: string;
/**
* Specifies whether or not the drop-down editor is displayed.
*/
opened: boolean;
/**
* Specifies whether a user can open the drop-down list by clicking a text field.
*/
openOnFieldClick: boolean;
/**
* The text that is provided as a hint in the select box editor.
*/
placeholder: string;
/**
* Specifies whether the editor is read-only.
*/
readOnly: boolean;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled: boolean;
/**
* Specifies whether to allow searching.
*/
searchEnabled: boolean;
/**
* Specifies the name of a data source item field or an expression whose value is compared to the search criterion.
*/
searchExpr: Function | string | Array<Function | string>;
/**
* Specifies a comparison operation used to search UI component items.
*/
searchMode: string;
/**
* Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.
*/
searchTimeout: number;
/**
* Specifies the mode in which all items are selected.
*/
selectAllMode: string;
/**
* Gets the currently selected items.
*/
selectedItems: Array<string | number | any>;
/**
* Specifies whether to display the Clear button in the UI component.
*/
showClearButton: boolean;
/**
* Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value.
*/
showDataBeforeSearch: boolean;
/**
* Specifies whether the drop-down button is visible.
*/
showDropDownButton: boolean;
/**
* Specifies whether the multi-tag is shown without ordinary tags.
*/
showMultiTagOnly: boolean;
/**
* Specifies whether or not to display selection controls.
*/
showSelectionControls: boolean;
/**
* Specifies how the UI component's text field is styled.
*/
stylingMode: string;
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
tabIndex: number;
/**
* Specifies a custom template for tags.
*/
tagTemplate: any;
/**
* The read-only property that holds the text displayed by the UI component input element.
*/
text: string;
/**
* Information on the broken validation rule. Contains the first item from the validationErrors array.
*/
validationError: any;
/**
* An array of the validation rules that failed.
*/
validationErrors: Array<any>;
/**
* Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
*/
validationMessageMode: string;
/**
* Indicates or specifies the current validation status.
*/
validationStatus: string;
/**
* Specifies the selected items.
*/
value: Array<string | number | any>;
/**
* Specifies which data field provides unique values to the UI component's value.
*/
valueExpr: Function | string;
/**
* Specifies whether the UI component is visible.
*/
visible: boolean;
/**
* Specifies the UI component's width.
*/
width: number | Function | string;
/**
* Specifies whether text that exceeds the drop-down list width should be wrapped.
*/
wrapItemText: boolean;
/**
* A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.
*/
onChange: EventEmitter<any>;
/**
* A function that is executed once the drop-down editor is closed.
*/
onClosed: EventEmitter<any>;
/**
* A function that is executed when the UI component's content is ready and each time the content is changed.
*/
onContentReady: EventEmitter<any>;
/**
* A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true.
*/
onCustomItemCreating: EventEmitter<any>;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<any>;
/**
* A function that is executed when the Enter key has been pressed while the UI component is focused.
*/
onEnterKey: EventEmitter<any>;
/**
* A function that is executed when the UI component gets focus.
*/
onFocusIn: EventEmitter<any>;
/**
* A function that is executed when the UI component loses focus.
*/
onFocusOut: EventEmitter<any>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<any>;
/**
* A function that is executed each time the UI component's input is changed while the UI component is focused.
*/
onInput: EventEmitter<any>;
/**
* A function that is executed when a list item is clicked or tapped.
*/
onItemClick: EventEmitter<any>;
/**
* A function that is executed when a user is pressing a key on the keyboard.
*/
onKeyDown: EventEmitter<any>;
/**
* A function that is executed when a user presses a key on the keyboard.
* @deprecated The `keyPress` event is removed from the web standards and will be deprecated in modern browsers soon. Refer to the MDN topic for details.
*/
onKeyPress: EventEmitter<any>;
/**
* A function that is executed when a user releases a key on the keyboard.
*/
onKeyUp: EventEmitter<any>;
/**
* A function that is executed before the multi-tag is rendered.
*/
onMultiTagPreparing: EventEmitter<any>;
/**
* A function that is executed once the drop-down editor is opened.
*/
onOpened: EventEmitter<any>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<any>;
/**
* A function that is executed when the 'Select All' check box value is changed. Applies only if showSelectionControls is true.
*/
onSelectAllValueChanged: EventEmitter<any>;
/**
* A function that is executed when a list item is selected or selection is canceled.
*/
onSelectionChanged: EventEmitter<any>;
/**
* A function that is executed after the UI component's value is changed.
*/
onValueChanged: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
acceptCustomValueChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
accessKeyChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
activeStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
applyValueModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
buttonsChange: EventEmitter<Array<string | DevExpress.ui.dxTextEditorButton>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<DevExpress.ui.CollectionWidgetItem | any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
deferRenderingChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
displayExprChange: EventEmitter<Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dropDownButtonTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dropDownOptionsChange: EventEmitter<dxPopupOptions>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
elementAttrChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
fieldTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
focusStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
groupedChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
groupTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
heightChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hideSelectedItemsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hoverStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
inputAttrChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
isValidChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
itemsChange: EventEmitter<Array<any | {
disabled?: boolean;
html?: string;
template?: any;
text?: string;
visible?: boolean;
}>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
itemTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxDisplayedTagsChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxLengthChange: EventEmitter<number | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minSearchLengthChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
multilineChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
nameChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
noDataTextChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
openedChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
openOnFieldClickChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
placeholderChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
readOnlyChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rtlEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
searchEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
searchExprChange: EventEmitter<Function | string | Array<Function | string>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
searchModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
searchTimeoutChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
selectAllModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
selectedItemsChange: EventEmitter<Array<string | number | any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showClearButtonChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showDataBeforeSearchChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showDropDownButtonChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showMultiTagOnlyChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showSelectionControlsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
stylingModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tabIndexChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tagTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
textChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationErrorChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationErrorsChange: EventEmitter<Array<any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationMessageModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationStatusChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
valueChange: EventEmitter<Array<string | number | any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
valueExprChange: EventEmitter<Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
visibleChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
wrapItemTextChange: EventEmitter<boolean>;
/**
*
*/
onBlur: EventEmitter<any>;
change(_: any): void;
touched: (_: any) => void;
buttonsChildren: QueryList<DxiButtonComponent>;
itemsChildren: QueryList<DxiItemComponent>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxTagBox;
writeValue(value: any): void;
setDisabledState(isDisabled: boolean): void;
registerOnChange(fn: (_: any) => void): void;
registerOnTouched(fn: () => void): void;
_createWidget(element: any): void;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
setupChanges(prop: string, changes: SimpleChanges): void;
ngDoCheck(): void;
_setOption(name: string, value: any): void;
}
export declare class DxTagBoxModule {
}