You are here

Home » API reference » Search API ranges 7

README.txt in Search API ranges 7 

Search API Ranges
-------------

This module allows you to enable a block with custom ranges options.
Requires Facet API and Search API facetapi integration.

- go to your Search API index > Facets tab
- for any field of type: integer, decimal, float, Unix timestamp
- go to Display Options and choose Display Widget: Min/Max UI Slider
- (optionally) configure name, prefix, suffix
- (optionally) override theme for search-api-ranges-slider.tpl.php
- enable your new Facet block

Examples of advanced ranges
---------------------------

Most simply, you can provide a manual set of ranges such as this:

0-100
100-500
500-2000

If you omit a value, it will be set to the lowest/highest in the set. For
example, if our lowest facet value was 33, and highest was 66, and you provided
the following range settings:

-50
50-

You would get the follow ranges queried for:

33-50
50-66

If instead of omitting a value you use the * symbol, your facet query will
include that, which means 'no-limit'.

Oftentimes, you might wish to provide custom display text for a given range.
This can be achieved by putting your desired text after a pipe eg:

0-8|Less than 10 days
8-14|8 to 14 days
15-*|15+ days

File

README.txt
View source 
  1. 

  2. Search API Ranges

  3. -------------

  4. 

  5. This module allows you to enable a block with custom ranges options.

  6. Requires Facet API and Search API facetapi integration.

  7. 

  8. - go to your Search API index > Facets tab

  9. - for any field of type: integer, decimal, float, Unix timestamp

  10. - go to Display Options and choose Display Widget: Min/Max UI Slider

  11. - (optionally) configure name, prefix, suffix

  12. - (optionally) override theme for search-api-ranges-slider.tpl.php

  13. - enable your new Facet block

  14. 

  15. Examples of advanced ranges

  16. ---------------------------

  17. 

  18. Most simply, you can provide a manual set of ranges such as this:

  19. 

  20. 0-100

  21. 100-500

  22. 500-2000

  23. 

  24. If you omit a value, it will be set to the lowest/highest in the set. For

  25. example, if our lowest facet value was 33, and highest was 66, and you provided

  26. the following range settings:

  27. 

  28. -50

  29. 50-

  30. 

  31. You would get the follow ranges queried for:

  32. 

  33. 33-50

  34. 50-66

  35. 

  36. If instead of omitting a value you use the * symbol, your facet query will

  37. include that, which means 'no-limit'.

  38. 

  39. Oftentimes, you might wish to provide custom display text for a given range.

  40. This can be achieved by putting your desired text after a pipe eg:

  41. 

  42. 0-8|Less than 10 days

  43. 8-14|8 to 14 days

  44. 15-*|15+ days