Support Menu

Coveo component FieldValue

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.

Index

Component Options

displaySeparator

displaySeparator: string

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 ", ".

Markup configuration example(s) :
data-display-separator='foo'

facet

facet: string

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.

Markup configuration example(s) :
data-facet='foo'

field

Specifies the field that the FieldValue should display.

Specifying a value for this parameter is required in order for the FieldValue component to work.

Markup configuration example(s) :
data-field='@foo'

helper

helper: string

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).

Markup configuration example(s) :
data-helper='foo'

helperOptions

helperOptions: any

Specifies the options to call on the specified helper.

htmlValue

htmlValue: boolean

Specifies whether the content to display is an HTML element.

Default value is false.

Markup configuration example(s) :
data-html-value='true'
data-html-value='false'

separator

separator: string

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 ";".

Markup configuration example(s) :
data-separator='foo'

splitValues

splitValues: boolean

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.

Markup configuration example(s) :
data-split-values='true'
data-split-values='false'

textCaption

textCaption: string

Specifies a caption to display before the value.

Default value is undefined.

Markup configuration example(s) :
data-text-caption='foo'

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void
  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.

    Returns void

enable

  • enable(): void
  • 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.

    Returns void

getBindings

getValue

  • getValue(): any

renderOneValue

  • renderOneValue(value: string): HTMLElement
  • Renders a value to HTML using all of the current FieldValue component options.

    Parameters

    • value: string

      The value to render.

    Returns HTMLElement

    The element containing the rendered value.

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent
  • 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.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton

Constructors

constructor

  • Creates a new FieldValue.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IFieldValueOptions

      The options for the FieldValue component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Optional result: IQueryResult

      The result to associate the component with.

    • Default value fieldValueClassId: string = FieldValue.ID

    Returns FieldValue