Coveo DistanceResources Component (CoveoDistanceResources)

The DistanceResources component defines a field that computes the distance according to the current position of the end user.

Components relying on the current distance should be disabled until this component successfully provides a distance.

See also DistanceEvents.

Available since

November 2017 Release (v2.3477.9)

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

getBindings

getLastPositionRequest

setPosition

  • setPosition(latitude: number, longitude: number): void

  • Overrides the current position with the provided values.

    Note:

    Calling this method does not automatically trigger a query.

    Parameters

    • latitude: number

      The latitude to set.

    • longitude: number

      The longitude to set.

    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

cancelQueryUntilPositionResolved

cancelQueryUntilPositionResolved: boolean

Whether to cancel all the queries until the DistanceResources component successfully resolves a position.

Default value is true

Default

true

Markup configuration example(s) :
data-cancel-query-until-position-resolved='true'
data-cancel-query-until-position-resolved='false'

disabledDistanceCssClass

disabledDistanceCssClass: string

The CSS class for components that need to be re-enabled when the DistanceResources component successfully provides a distance.

Default value is coveo-distance-disabled.

Default

coveo-distance-disabled

Markup configuration example(s) :
data-disabled-distance-css-class='foo'

distanceField

distanceField: IFieldOption

Specifies the name of the field in which to store the distance value.

Specifying a value for this option is required for the DistanceResources component to work.

Required

Specifying a value for this option is required for the component to work

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

googleApiKey

googleApiKey: string

The API key to use to request the Google API geolocation service.

If you do not specify a value for this option, the DistanceResources component does not try to request the service.

Markup configuration example(s) :
data-google-api-key='foo'

latitudeField

latitudeField: IFieldOption

Specifies the name of the field that contains the latitude value.

Note:

The field you specify for this option must be an existing numerical field in your index (see Adding and Managing Fields. Otherwise, your query responses will contain a QueryExceptionInvalidQueryFunctionField or QueryExceptionInvalidQueryFunctionFieldType` exception, and the DistanceResources component will be unable to evaluate distances.

Specifying a value for this option is required for the DistanceResources component to work.

Required

Specifying a value for this option is required for the component to work

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

latitudeValue

latitudeValue: number

The latitude to use if no other position was provided.

Note:

You must also specify a longitudeValue if you specify a latitudeValue.

Accepts floating point values
Markup configuration example(s) :
data-latitude-value='10'

longitudeField

longitudeField: IFieldOption

Specifies the name of the field that contains the longitude value.

Note:

The field you specify for this option must be an existing numerical field in your index (see Adding and Managing Fields. Otherwise, your query responses will contain a QueryExceptionInvalidQueryFunctionField or QueryExceptionInvalidQueryFunctionFieldType` exception, and the DistanceResources component will be unable to evaluate distances.

Specifying a value for this option is required for the DistanceResources component to work.

Required

Specifying a value for this option is required for the component to work

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

longitudeValue

longitudeValue: number

The longitude to use if no other position was provided.

Note:

You must also specify a latitudeValue if you specify a longitudeValue.

Accepts floating point values
Markup configuration example(s) :
data-longitude-value='10'

triggerNewQueryOnNewPosition

triggerNewQueryOnNewPosition: boolean

Whether to execute a new query when the DistanceResources component successfully provides a new position.

Default value is false.

Default

false

Markup configuration example(s) :
data-trigger-new-query-on-new-position='true'
data-trigger-new-query-on-new-position='false'

unitConversionFactor

unitConversionFactor: number

The conversion factor to apply to the base distance unit (meter).

Note:

  • If you want to convert distances to kilometers, you should set the unitConversionFactor to 1000.
  • If you want to convert distance to miles, you should set the unitConversionFactor to 1610 (one mile is approximately equal to 1610 meters).

Default value is 1000.

Default

1000

Markup configuration example(s) :
data-unit-conversion-factor='10'

useNavigator

useNavigator: boolean

Whether to request the geolocation service of the web browser.

If not defined, will not try to request the service.

Note:

Recent web browsers typically require a site to be in HTTPS to enable their geolocation service.

If you do not specify a value for this option, the DistanceResources component does not try to request the service.

Markup configuration example(s) :
data-use-navigator='true'
data-use-navigator='false'

Constructors

constructor

  • Creates a new DistanceResources component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IDistanceOptions

      The options for the DistanceResources component.

    • bindings: IComponentBindings

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

    Returns DistanceResources