Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Return the bindings, or environment, for the current component.
Gets the current FieldValue from the current IQueryResult.
The current FieldValue or null if value is and Object.
Renders a value to HTML using all of the current FieldValue component options.
The value to render.
The element containing the rendered value.
Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
If there is multiple component bound to the current HTMLElement, you must specify the component class.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
A field-based condition that must be satisfied by the query result item for the component to be rendered.
Note: This option uses a distinctive markup configuration syntax allowing multiple conditions to be expressed. Its underlying logic is the same as that of the field value conditions mechanism used by result templates.
Examples: Render the component if the query result item's @documenttype field value is Article or Documentation.
<div class="CoveoFieldValue" data-field="@author" data-condition-field-documenttype="Article, Documentation"></div>
Render the component if the query result item's @documenttype field value is anything but Case.
<div class="CoveoFieldValue" data-field="@author" data-condition-field-not-documenttype="Case"></div>
Render the component if the query result item's @documenttype field value is Article, and if its @author field value is anything but Anonymous.
<div class="CoveoFieldValue" data-field="@author" data-condition-field-documenttype="Article" data-condition-field-not-author="Anonymous"></div>
Default value is undefined.
If FieldValue.options.splitValues is true, specifies the string to use when displaying multi-value
fields in the UI.
The component will insert this string between each value it displays from a multi-value field.
See also FieldValue.options.separator.
Default value is ", ".
data-display-separator='foo'
Specifies the Facet component to toggle when the end user clicks the FieldValue.
Default value is the value of FieldValue.options.field.
Note:
If the target Facet.options.id is is not the same as its Facet.options.field), you must specify this option manually in order to link to the correct Facet.
data-facet='foo'
Specifies the field that the FieldValue should display.
Specifying a value for this parameter is required in order for the FieldValue component to work.
data-field='@foo'
Specifies the helper that the FieldValue should use to display its content.
While several helpers exist by default (see ICoreHelpers), it is also possible for you to create your own custom helpers (see TemplateHelpers).
data-helper='foo'
Specifies the options to call on the specified helper.
Specifies whether the content to display is an HTML element.
Default value is false.
data-html-value='true' data-html-value='false'
If FieldValue.options.splitValues is true, specifies the separator string which separates multi-value
fields in the index.
See FieldValue.options.displaySeparator.
Default value is ";".
data-separator='foo'
Specifies whether to split the FieldValue at each FieldValue.options.separator.
This is useful for splitting groups using a Facet.options.field.
When this option is true, the displayed values are split by the FieldValue.options.displaySeparator.
Default value is false.
data-split-values='true' data-split-values='false'
Specifies a caption to display before the value.
Default value is undefined.
data-text-caption='foo'
Creates a new FieldValue.
The HTMLElement on which to instantiate the component.
The options for the FieldValue component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The result to associate the component with.
The FieldValue component displays the value of a field associated to its parent search result. It is normally usable within a FieldTable.
This component is a result template component (see Result Templates).
A common use of this component is to display a specific field value which also happens to be an existing Facet.options.field. When the user clicks on the FieldValue component, it activates the corresponding Facet.