class cgxp.FullTextSearch(config)

Config Options

Configuration properties.


Number Width in pixels of the search combobox. Default is 200.


String Text to use when the field is empty (i18n).


Boolean Tells whether to group the results by layer_name. If set to true, the data returned by the service is intended to include such a field. If set to true, Ext/ux/form/GroupComboBox.js needs to be included as part of the built file if any. Defaults to false.


Object Option object to configure search limit parameters sent to the text search service. The possible properties are:

  • limit - Number The maximum number of results in the response.
  • partitionlimit - Number The maximum number of results per layer/group in the response.

partitionlimit is typically used when the grouping option is to true, to limit the number of results in each group.

If the limits option is unspecified the limit parameters sent in search requests depend whether grouping is true or false:

  • If grouping is false then limit is set to 20, and partitionlimit is not set.
  • If grouping is true then limit is set to 40, and partitionlimit is set to 10.

Any provided limits object is applied to the default values. For example, if grouping is true and if the limits option is set to {limit: 50} then limit will be set to 50 and partitionlimit will be set to 10 in search requests.


String Text to display while loading results (i18n).


Boolean Whether to display a tooltip above the search box. Default is true.


Number Duration in milliseconds after which the tooltip is hidden. Default is 15000.


String Optional id of an element to place the tooltip in. Default is search-tip


String Text for the tooltip title (i18n). Only applies if tooltip is true.


Number Width in pixels of the tooltip window. Default is 500.

Table Of Contents

Previous topic


Next topic


This Page