Coveo FieldTable Component (CoveoFieldTable)

The FieldTable component displays a set of FieldValue components in a table that can optionally be expandable and minimizable. This component automatically takes care of not displaying empty field values.

This component is a result template component (see Result Templates).

Example:

// This is the FieldTable component itself, which holds a list of table rows.
// Each row is a FieldValue component.
<table class='CoveoFieldTable'>
   // Items
   <tr data-field='@sysdate' data-caption='Date' data-helper='dateTime' />
   <tr data-field='@sysauthor' data-caption='Author' />
   <tr data-field='@clickuri' data-html-value='true' data-caption='URL' data-helper='anchor' data-helper-options='{text: \"<%= raw.syssource %>\" , target:\"_blank\"}'>
</table>

Index

Methods

Properties

Accessors

Component Options

Constructors

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

expand

  • expand(anim?: boolean): void

  • Expands (shows) the FieldTable,

    Parameters

    • Default value anim: boolean = false

      Specifies whether to show a sliding animation when expanding the FieldTable.

    Returns void

getBindings

minimize

  • minimize(anim?: boolean): void

  • Minimizes (collapses) the FieldTable.

    Parameters

    • Default value anim: boolean = false

      Specifies whether to show a sliding animation when minimizing the FieldTable.

    Returns void

toggle

  • toggle(anim?: boolean): void

  • Toggles between expanding (showing) and minimizing (collapsing) the FieldTable.

    Parameters

    • Default value anim: boolean = false

      Specifies whether to show a sliding animation when toggling the display of the FieldTable.

    Returns void

updateToggleHeight

  • updateToggleHeight(): void

  • Updates the toggle height if the content was dynamically resized, so that the expanding and minimizing animation can match the new content size.

    Returns void

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

bind: ComponentEvents

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 different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

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.

Static ID

ID: string

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

Accessors

usageAnalytics

Component Options

allowMinimization

allowMinimization: boolean

Specifies whether to allow the minimization (collapsing) of the FieldTable.

If you set this option to false, the component will not create the Minimize / Expand toggle links.

See also FieldTable.options.expandedTitle, FieldTable.options.minimizedTitle and FieldTable.options.minimizedByDefault.

Default value is true.

Default

true

Markup configuration example(s) :
data-allow-minimization='true'
data-allow-minimization='false'

expandedTitle

expandedTitle: string

If FieldTable.options.allowMinimization is true, specifies the caption to show on the Minimize link (the link that appears when the FieldTable is expanded).

Default value is "Details".

Only effective when

allowMinimization is truthy

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

minimizedByDefault

minimizedByDefault: boolean

If FieldTable.options.allowMinimization is true, specifies whether to minimize the table by default.

Default value is undefined, and the FieldTable will collapse by default if the result it is associated with has a non-empty excerpt.

Only effective when

allowMinimization is truthy

Markup configuration example(s) :
data-minimized-by-default='true'
data-minimized-by-default='false'

minimizedTitle

minimizedTitle: string

If FieldTable.options.allowMinimization is true, specifies the caption to show on the Expand link (the link that appears when the FieldTable is minimized).

Default value is "Details".

Only effective when

allowMinimization is truthy

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

Constructors

constructor

  • Creates a new FieldTable.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: IFieldTableOptions

      The options for the FieldTable 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.

    Returns FieldTable