NETVIBES Exalead CloudView - Mashup Builder Widget Reference

Tab

Description: For tabbed navigation. Drop 'Tab' widgets within a 'Tab Container' widget to create tabs.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO_OR_MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Title Specifies the tab title to display.  ONE  

Tabs Container

Description: For tabbed navigation. Drop 'Tab' widgets within this widget to create tabs. Note: All tabs are preloaded on page load.
Supports sub widgets: MANY
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss
/resources/javascript/exa/string/util.jsjs
/resources/javascript/exa/widget/widget.jsjs
/resources/javascript/jquery.cookie.jsjs
js/tabWrapper.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Title Specifies the widget title, that is to say, the header that will be displayed above the tabs.  ONE  
Display style Specifies how to display the tabs.  ONE tabs
buttons
dropdowns 
Vertical align Specifies the vertical alignement of the tabs.  ONE top
bottom 
Default opened tab Specifies the index (0-based) of the tab that should be opened by default. Defaults to '0'.  ONE  
NameDescriptionArityValue(s)
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  

Trusted Queries Premium

Description: Trusted Queries is an advanced search form which guides the user through the content. Your data must be indexed using structured indexing. Based on the data structure, the user is guided to access data efficiently.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
/resources/javascript/jquery.cookie.jsjs
/resources/javascript/jquery.json-2.2.jsjs
/resources/javascript/exa/io/io.jsjs
/resources/javascript/exa/geo/geo.jsjs
css/trustedQuery.lesscss
css/trustedQuery.theme.lesscss
js/trustedQuery.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Query parameter Specifies the parameter name associated with the submitted user query.  ONE  
Feeds to refine Specifies the feeds that should be refined when the user query is submitted.  MANY  
Input size Specifies the width of the query input field.  ONE  
Action Specifies the page on which the query results are displayed. If empty, query results are displayed on the current page.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Search command Specifies the search API command name that will be appended to the 'Search API URL'.  ONE  
Config Indicates the name of the default Search API (example: sapi0) as defined in the 'Applications' menu.  ZERO_OR_ONE  
Search API URL Defines the URL that will be used by the Search API.  ZERO_OR_MANY  
Search Logic Specifies the search logic (example: "sl0"). Search logics are defined in the Administration Console.  ZERO_OR_ONE  
Extra parameters Specifies extra key/value parameters for the search logic.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
  ONE  
  ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregation that will be used by the trusted queries.  ONE  
Suggestions for one group Specifies the maximum number of suggestions when displaying a single group.  ONE  
Suggestions for many groups Specifies the maximum number of suggestions when displaying several groups.  ONE  
NameDescriptionArityValue(s)
Data Model Class Specifies the data model class that will be used. Data models are specified in the Administration Console. By default they all will be used.  ZERO_OR_MANY  
Exclude facets Specifies the facets you do not want to display.  ZERO_OR_MANY  
Exclusion patterns Specifies exclusion patterns to filter some results.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Enable Search API cache Specifies if cache should be activated. We strongly recommend to enable it.  ONE false
true 
Engine Specifies the trusted queries engine to use.  ONE  
Prefix handler Specifies the prefix handler to use for the search.  ONE  
Cookie name Specifies a cookie name to store the widget state. Defaults to 'trustedqueries'.  ZERO_OR_ONE  

Simple Search Form

Description: Very basic Search Form with no particular style, just an search box and a submit button.
Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Input parameter Defines the parameter name associated with the input submitted in the search box.  ONE  
Button label Defines the label displayed in the form's submit button. For example, 'Search'.  ONE  
Action Specifies the page on which the query results are displayed. If empty, query results are displayed on the current page.  ZERO_OR_ONE  
Autofocus Places the keyboard focus on the query input when the page is loaded.  ONE false
true 

Header Search Form Premium

Description: A search form with a header-style display.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Input parameter Specifies the Parameter Name associated with the input submitted for the entry box.  ONE  
Search label Label of the form's submit button.  ONE  
Action Specifies the page on which query results are displayed. If empty, query results are displayed on the current page.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Enable icon Adds an icon on the top-left corner of the widget.  ONE false
true 
Icon URL Specifies the URL of the logo to display.
The URL can be:
  • relative (Example: /resources/logo/images/cvlogo_medium.png is rewritten to /mashup-ui/resources/logo/images/cvlogo_big.png)
  • or absolute (http://...).
 		 ZERO_OR_ONE  
Icon link Specifies the page to access when you click on the image. If blank, no link is displayed.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Enable geolocation Injects the position of the user in the search form  ONE false
true 
Latitude parameter Parameter name associated with the user latitude.  ONE  
Longitude parameter Parameter name associated with the user longitude.  ONE  
Maximum age Accepts a cached position whose age is no greater than the specified time in milliseconds. If 0 then the answer is not cached.  ONE  

Multi Input Search Form

Description: Configurable Search Form that can display more than a single input field.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Default values separator Specifies the separator to use between values.  ONE  
Inputs by row Specifies the number of inputs to display by row.  ONE  
Auto focus Places the text input caret on search field upon document load.  ONE false
true 
Input size Specifies the width of the input fields. You must enter an integer.  ONE  
Button label Specifies the label of the form submit button.  ONE  
Enable search with refines Allows you to keep your refinements while searching.  ONE false
true 
Search with refines by default Specifies whether the 'search with refines' option should be enabled by default or not.  ZERO_OR_ONE false
true 
Input parameters Parameter Name associated with the input submitted for the entry box. Each input parameter can have a Display name and a Suggest service URL associated.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Name   ONE  
Display name   ONE  
Suggest Service URL Example: http://host:10010/search-api/suggest  ONE  
Default values Specifies the name of the input parameter and a default value or a list of default values to create a SELECT.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
  ONE  
  ONE  
Search actions   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Action's label Specifies the label that will be displayed above your search form for this action.  ONE  
Action's name Specifies the name of a page or an absolute URL, corresponding to the form action. If empty, the form will be submitted to the current page.  ONE  
NameDescriptionArityValue(s)
Enable geolocation Injects the position of the user in the search form.
Warning: This option requires a browser that supports HTML5 Geolocation specification.
It will not work for older browsers and for Internet Explorer.  		 ONE false
true 
Latitude parameter Parameter name associated with the user latitude.  ONE  
Longitude parameter Parameter name associated with the user longitude.  ONE  
Maximum age Accepts a cached position whose age is no greater than the specified time in milliseconds. If 0 then the answer is not cached.  ONE  

Standard Search Form

Description: The CloudView standard search form with support for suggest.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
css/searchForm.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Input parameter Specifies the Parameter Name associated with the input submitted for the entry box.  ONE  
Input size Specifies the width of the query input field.  ONE  
Button label Specifies the label of the form submit button.  ONE  
Auto focus Places the keyboard focus on the query input when the page is loaded.  ONE false
true 
Enable advanced search Shows an 'advanced search' link next to the search form. Clicking brings down the advanced search options  ONE false
true 
Enable search with refines Allows you to keep your refinements while searching.  ONE false
true 
Search with refines by default Specifies whether the 'search with refines' option should be enabled by default or not.  ZERO_OR_ONE false
true 
Search actions   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Action's label Specifies the label that will be displayed above your search form for this action.  ONE  
Action's name Specifies the name of a page or an absolute URL, corresponding to the form action. If empty, the form will be submitted to the current page.  ONE  
NameDescriptionArityValue(s)
Enable suggest Enables the suggest service on the search field. You must then select a suggest service - previously defined in the Administration Console - from 'Suggest Name'.  ONE false
true 
Suggest Name Suggest service name.  MANY  
Action Specifies whether the suggest should use a simple service or a suggest dispatcher which varies depending on the query input.   ONE dispatcher
service 
Config Indicates the name of the default Search API (example: sapi0) as defined in the 'Applications' menu.  ZERO_OR_ONE  
Search API URL Defines the URL that will be used by the Search API.  ZERO_OR_MANY  
API command Specifies the suggest API command name that will be appended to the 'Search API URL'.  ONE  
NameDescriptionArityValue(s)
Expand query after n characters Expands the last searched term of the query after n characters with "*{w/=10}"  ZERO_OR_ONE  
Update Widgets Refreshes the list of given widgets identified by a unique ID called WUID.  ZERO_OR_MANY  
onLoad event Specifies the JavaScript code to be executed once the content is loaded.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Enable geolocation Injects the position of the user in the search form.
Warning: This option requires a browser that supports HTML5 Geolocation specification.
It will not work for older browsers and for Internet Explorer.  		 ONE false
true 
Latitude parameter Parameter name associated with the user latitude.  ONE  
Longitude parameter Parameter name associated with the user longitude.  ONE  
Maximum age Accepts a cached position whose age is no greater than the specified time in milliseconds. If 0 then the answer is not cached.  ONE  

Within Search Form BP2S

Description: Search within results form with support for suggest.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/searchForm.lesscss
/resources/searchForm/javascript/searchActions.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Input parameter Name of the page parameter associated with the input submitted for the entry box.

This parameter will be send to the target page.
You must use it to modify the q parameter of your feed like this:
Example for parameter named "sq" and for page "search":
?{${search.sq}?${search.q} ${search.sq}: ${search.q}}  		 ONE sq 
Global Search parameter Parameter Name associated with the input submitted for the main search entry box.  ONE q 
Input size Width of the query input field.  ONE 150 
Css Class for Reset Button Label for the search box  ONE  
Button label Label of the form submit button.  ONE + 
Action A page, corresponding to an action to which the query will be submitted with the previous context.   ONE  
NameDescriptionArityValue(s)
Enable suggest   ONE false
true 
Suggest Name Suggest service name.  ZERO_OR_MANY  
Action   ZERO_OR_ONE dispatcher
service 
Config Indicates the name of the default Search API (example: sapi0) as defined in the 'Applications' menu.  ZERO_OR_ONE  
Search API URL Defines the URL that will be used by the Search API.  ZERO_OR_MANY  
API command Specifies the suggest API command name that will be appended to the 'Search API URL'.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Widget CSS 'id='   ONE  
Widget CSS 'class='   ONE  
CSS rules CSS rules to append to the HTML.  ONE  

Mappy Premium

Description: Shows your results as pins on a Mappy Map, with automatic centering and zoom levels for your result set.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/javascript/jquery.spinner.jsjs
js/mappy.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Mappy API login Mappy API Login.  ONE  
Mappy API password Mappy API Password  ONE  
Location Meta Meta name(s) to use for the hit position with expected format :
  • Location : "meta_of_type_point"
  • Latitude + Longitude : "meta_latitude,meta_longitude"
 		 ONE  
Message popup Defines the message that will be displayed in the bubble of the pin selection.
This message can contain HTML code.
If you need some logic, try the 'popup template path' option below this option.  		 ONE  
Popup template path JSP template shown in the popup.
You can use JSTL functions to add logics in it.
An example can be found at:
/WEB-INF/jsp/widgets/gmapV3/messagePopup/example_entries.jsp  		 ONE  
Popup default style Uses Mappy default style for the popup.  ONE false
true 
NameDescriptionArityValue(s)
Proxy host HTTP Proxy to use for fetching the Mappy credentials.  ONE  
Proxy port HTTP Proxy port to use for fetching the Mappy credentials.  ONE  
Proxy user HTTP Proxy user to use for fetching the Mappy credentials.(optional)  ONE  
Proxy password HTTP Proxy password to use for fetching the Mappy credentials.(optional)  ONE  
NameDescriptionArityValue(s)
Show mini map If false, the mini map will not be displayed. Otherwise the mini map will be displayed based on the value:
  • lt: Left Top
  • rt: Right Top
  • lb: Left Bottom
  • rb: Right Bottom
 		 ONE false
lt
rt
lb
rb 
Show toolbar If false, the toolbar will not be displayed. Otherwise the toolbar will be displayed based on the value:
  • lt: Left Top
  • rt: Right Top
  • lb: Left Bottom
  • rb: Right Bottom
 		 ONE false
lt
rt
lb
rb 
Display Mini map icon Adds an icon in the toolbar which opens the mini map. It will be opened at the desired position based on the value:
  • lt: Left Top
  • rt: Right Top
  • lb: Left Bottom
  • rb: Right Bottom
 		 ONE false
lt
rt
lb
rb 
Display Move icon Adds an icon in the toolbar which allows you to move the mini map.  ONE false
true 
Display Disable Mouse Zoom icon Adds an icon in the toolbar which allows you to zoom by scrolling with the mouse.  ONE true
false 
Display Rectangle Selection icon Adds an icon in the toolbar which allows you to zoom on a rectangle selection.  ONE false
true 
Display Zoom icons Add zoom icons (+/-) near the slider in the toolbar.  ONE false
true 
Display Slider icon Adds a slider to zoom in the map.  ONE false
true 
Disable mouse zoom Disables the use of the mouse wheel to zoom.  ONE false
true 
Disable drag navigation Disables the possibility to move on the map by mouse dragging.  ONE true
false 
NameDescriptionArityValue(s)
Hit URL Specifies the link to create for each icon.   ONE  
Marker label Specifies the tooltip text of the marker (pinpoint).   ONE  
Marker image URL If blank, the icon URL will be http://chart.apis.google.com/chart?chst=d_map_pin_letter&chld=%{indexMarker}|#3279BE|#FFF
%{indexMarker} is a magic variable which will be replaced by an incremental number.  		 ONE  
Integrate in "Display Hits" Appends markers to hits.  ONE false
true 
Pin background color Defines the default Mappy pin background color. If blank, the Mappy default is used.  ONE  
Pin foreground color Defines the default Mappy pin foreground color. If blank, the Mappy default is used.  ONE  
AnchorX icon Specifies the pixel relative to the top left corner of the icon image to which this icon is anchored in the map.  ONE  
AnchorY icon Specifies the pixel relative to the top left corner of the icon image to which this icon is anchored in the map.  ONE  
popUpAnchorX Specifies the pixel relative to the top left corner of the icon image to which the info window is anchored in this icon.  ONE  
popUpAnchorY Specifies the pixel relative to the top left corner of the icon image to which the info window is anchored in this icon.  ONE  
Height Specifies the height of the foreground image of the icon (pixel).  ONE  
Width Specifies the width of the foreground image of the icon (pixel).  ONE  
Append marker location (advanced) Specifies the CSS path where the marker will be appended in the hit display.
Generally, the default value does not need to be changed for the standard hit display widget.  		 ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the map. You must enter an integer.  ONE  
Height Specifies the height of the map. You must enter an integer.  ONE  

Google Maps

Description: Shows your results as pins on a Google Map, with automatic centering and zoom levels for your result set.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
/resources/javascript/exa/geo/geo.jsjs
/resources/javascript/exa/io/io.jsjs
/resources/javascript/exa/io/GeoInterface.jsjs
/resources/javascript/exa/io/HitSelectionInterface.jsjs
/resources/javascript/exa/io/HitDecorationInterface.jsjs
/resources/javascript/exa/util/Context.jsjs
/resources/javascript/exa/util/Queue.jsjs
/resources/javascript/exa/util/KVOObject.jsjs
js/GeoInterfaceImpl.jsjs
js/GoogleMarker.jsjs
js/GoogleMarkerManager.jsjs
js/GoogleFormManager.jsjs
js/GoogleMapWidget.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Default zoom level Default zoom level used if there is only one pin in the map, min:0 (distant) max:22 (near)  ZERO_OR_ONE  
Map Type Specifies the map type that must be displayed by the widget.   ONE ROADMAP
SATELLITE
HYBRID
TERRAIN 
Enable map type control The initial enabled/disabled state of the Map type control.  ONE false
true 
Enable street view control The initial enabled/disabled state of the Street View Pegman control.  ONE false
true 
Enable geo form edition If enabled, you will be able to draw polygons or circles on the map.  ONE false
true 
Google maps clientId If empty, it will use the non premium API (restriction applies).  ONE  
NameDescriptionArityValue(s)
Address (1) MEL expression used for the hit address.
If coordinates are also provided with the Location option, they will have a higher priority than the address.
Note: This functionality is slow because we have to get the coordinates of each addresses.  		 ONE  
Location (2) MEL expression used for the hit position with expected format : latitude,longitude
  • Location : ${entry.metas["meta_of_type_gps_point"]}
  • Latitude + Longitude : ${entry.metas["meta_latitude"]},${entry.metas["meta_longitude"]}
 		 ONE  
Hit URL Specifies the link to create for each icon. An invalid page name will not create a link.  ONE  
Image URL Marker If blank, icon url will be:
http://chart.apis.google.com/chart?chst=d_map_pin_letter&chld=%{indexMarker}|3279BE|FFF
%{indexMarker} is a magic variable which will be replaced by an incremental number  		 ONE  
Message popup Defines the message that will be displayed in the bubble of the pin selection.
This message can contain HTML code.
If you need some logic, try the 'popup template path' option below this option.  		 ONE  
Popup template path

JSP template shown in the popup.
You can use JSTL functions to add logics in it.
An example can be found at:
/WEB-INF/jsp/widgets/gmapV3/messagePopup/example_entries.jsp

 		 ONE  
NameDescriptionArityValue(s)
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facets list (1) The specified facets, separated by commas.  ONE  
Address (2) MEL expression used for the category address.
If coordinates are also provided with the Location option, they will have a higher priority than the address.
Note: This functionality is slow because we have to get the coordinates of each addresses.  		 ONE  
Location(3) MEL expression used for the category position with expected format : latitude,longitude
  • Location : ${category.description}
 		 ONE  
Number of categories displayed Specifies the maximum number of categories to display. You must enter an integer.  ONE  
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE flat
leaves
all 
Image URL Marker If blank, icon url will be:
http://chart.apis.google.com/chart?chst=d_map_pin_letter&chld=%{indexMarker}|3279BE|FFF
%{indexMarker} is a magic variable which will be replaced by an incremental number.  		 ONE  
Message popup Defines the message that will be displayed in the bubble of the pin selection.
This message can contain HTML code.
If you need some logic, try the 'popup template path' option below this option.
Aggregation: This field is evaluated so you can use MEL ( ${category.aggrs["your_aggregation"]} ) to get aggregation value in your popup  		 ONE  
Popup template path JSP template shown in the popup. You can use JSTL functions to add logics in it. An example can be found at:
/WEB-INF/jsp/widgets/gmapV3/messagePopup/example_facets.jsp  		 ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Geo facets list The specified geo facets, separated by commas.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
Aggregation Aggregation used to colorize shape  ZERO_OR_ONE  
Tooltip MEL expression used for tooltip.  ZERO_OR_ONE  
HeatMap Displays a heatMap instead shapes. (Only used for autotiles geo facets)  ONE false
true 
NameDescriptionArityValue(s)
Update Widgets On map move, refresh the list of given widgets identified by a unique ID called WUID.  ZERO_OR_MANY  
Latitude parameter's name Specifies the parameter name that will be used for latitude in queries. For example 'lat'.  ONE  
Longitude parameter's name Specifies the parameter name that will be used for longitude in queries. For example 'lng'.  ONE  
Zoom level parameter's name Specifies the parameter name that will be used for zoom level in queries. For example 'zoomlevel'.  ONE  
NameDescriptionArityValue(s)
Google pin background color Defines the default Google pin background color. If blank, the Google default is used.  ONE  
Google pin foreground color Defines the default Google pin foreground color. If blank, the Google default is used.  ONE  
Icon AnchorX Specifies the pixel relative to the top left corner of the icon image to which this icon is anchored in the map.  ONE  
Icon AnchorY Specifies the pixel relative to the top left corner of the icon image to which this icon is anchored in the map.  ONE  
Popup AnchorX Specifies the pixel relative to the top left corner of the popup to which this icon is anchored in the map.  ONE  
Popup AnchorY Specifies the pixel relative to the top left corner of the popup to which this icon is anchored in the map.  ONE  
Height Specifies the height of the foreground image of the icon (pixels).  ONE  
Width Specifies the width of the foreground image of the icon (pixels).  ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the Google Map widget (pixels).  ONE  
Height Specifies the height of the Google Map widget (pixels).  ONE  

Maps

Description: Shows your results as pins on a Map, with automatic centering and zoom levels for your result set.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
leaflet/leaflet.jsjs
leaflet/leaflet.csscss
leaflet.draw/leaflet.draw.jsjs
leaflet.draw/leaflet.draw.csscss
/resources/javascript/exa/geo/geo.jsjs
/resources/javascript/exa/io/io.jsjs
/resources/javascript/exa/io/GeoInterface.jsjs
/resources/javascript/exa/io/HitSelectionInterface.jsjs
/resources/javascript/exa/io/HitDecorationInterface.jsjs
/resources/javascript/exa/util/Context.jsjs
js/Bing.jsjs
js/MapQuest.jsjs
js/LeafletMarkerManager.jsjs
js/LeafletFormManager.jsjs
js/LeafletMap.jsjs
js/GeoInterfaceImpl.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Default zoom level Default zoom level used if there is only one pin in the map, min:0 (distant) max:22 (near)  ZERO_OR_ONE  
Enable geo form edition If enabled, you will be able to draw polygons or circles on the map.  ONE false
true 
Geo provider Choose your geo data provider.  ONE Bing
MapQuest 
Api key Api key.  ONE  
NameDescriptionArityValue(s)
Address (1) MEL expression used for the hit address.
If coordinates are also provided with the Location option, they will have a higher priority than the address.
Note: This functionality is slow because we have to get the coordinates of each addresses.  		 ONE  
Location (2) MEL expression used for the hit position with expected format : latitude,longitude
  • Location : ${entry.metas["meta_of_type_gps_point"]}
  • Latitude + Longitude : ${entry.metas["meta_latitude"]},${entry.metas["meta_longitude"]}
 		 ONE  
Hit URL Specifies the link to create for each icon. An invalid page name will not create a link.  ONE  
Image URL Marker If blank, icon url will be:
http://chart.apis.google.com/chart?chst=d_map_pin_letter&chld=%{indexMarker}|3279BE|FFF
%{indexMarker} is a magic variable which will be replaced by an incremental number  		 ONE  
Message popup Defines the message that will be displayed in the bubble of the pin selection.
This message can contain HTML code.
If you need some logic, try the 'popup template path' option below this option.  		 ONE  
Popup template path

JSP template shown in the popup.
You can use JSTL functions to add logics in it.
An example can be found at:
/WEB-INF/jsp/widgets/gmapV3/messagePopup/example_entries.jsp

 		 ONE  
NameDescriptionArityValue(s)
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facets list (1) The specified facets, separated by commas.  ONE  
Address (2) MEL expression used for the category address.
If coordinates are also provided with the Location option, they will have a higher priority than the address.
Note: This functionality is slow because we have to get the coordinates of each addresses.  		 ONE  
Location(3) MEL expression used for the category position with expected format : latitude,longitude
  • Location : ${category.description}
 		 ONE  
Number of categories displayed Specifies the maximum number of categories to display. You must enter an integer.  ONE  
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE flat
leaves
all 
Image URL Marker If blank, icon url will be:
http://chart.apis.google.com/chart?chst=d_map_pin_letter&chld=%{indexMarker}|3279BE|FFF
%{indexMarker} is a magic variable which will be replaced by an incremental number.  		 ONE  
Message popup Defines the message that will be displayed in the bubble of the pin selection.
This message can contain HTML code.
If you need some logic, try the 'popup template path' option below this option.
Aggregation: This field is evaluated so you can use MEL ( ${category.aggrs["your_aggregation"]} ) to get aggregation value in your popup  		 ONE  
Popup template path JSP template shown in the popup. You can use JSTL functions to add logics in it. An example can be found at:
/WEB-INF/jsp/widgets/gmapV3/messagePopup/example_facets.jsp  		 ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Geo facets list The specified geo facets, separated by commas.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
Aggregation Aggregation used to colorize shape  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Update Widgets On map move, refresh the list of given widgets identified by a unique ID called WUID.  ZERO_OR_MANY  
Latitude parameter's name Specifies the parameter name that will be used for latitude in queries. For example 'lat'.  ONE  
Longitude parameter's name Specifies the parameter name that will be used for longitude in queries. For example 'lng'.  ONE  
Zoom level parameter's name Specifies the parameter name that will be used for zoom level in queries. For example 'zoomlevel'.  ONE  
NameDescriptionArityValue(s)
CSS class name CSS class name for icons.  ONE  
Icon AnchorX Specifies the pixel relative to the top left corner of the icon image to which this icon is anchored in the map.  ONE  
Icon AnchorY Specifies the pixel relative to the top left corner of the icon image to which this icon is anchored in the map.  ONE  
Popup AnchorX Specifies the pixel relative to the top left corner of the popup to which this icon is anchored in the map.  ONE  
Popup AnchorY Specifies the pixel relative to the top left corner of the popup to which this icon is anchored in the map.  ONE  
Height Specifies the height of the foreground image of the icon (pixels).  ONE  
Width Specifies the width of the foreground image of the icon (pixels).  ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the Google Map widget (pixels).  ONE  
Height Specifies the height of the Google Map widget (pixels).  ONE  

Static Google Map Premium

Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title, if blank no name is displayed.  ONE  
Sensor Specifies whether the application requesting the static map is using a sensor to determine the user's location.  ONE  
Center(required if no marker) Defines the center of the map. This parameter takes a location as either a comma-separated {latitude,longitude} pair (e.g. "40.714728,-73.998672") or a string address (e.g. "city hall, new york, ny")   ONE  
Zoom(required if no marker) Defines the zoom level of the map, which determines the magnification level of the map. This parameter takes a numerical value corresponding to the zoom level of the region desired.  ONE  
NameDescriptionArityValue(s)
Displayed markers color:blue|label:S|40.702147,-74.015794   MANY  
NameDescriptionArityValue(s)
Width   ONE  
Height   ONE  

Google Street View Premium

Description: Allows you to add a Google Street View widget on your page.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
css/style.lesscss
/resources/javascript/jquery.spinner.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Address (1) Meta to use for the hit address (text).
If coordinates are also provided with the Latitude Meta and Longitude Meta, they will have a higher priority than the address.
Note: This functionality is slow because we have to get the coordinates of each addresses.  		 ONE  
Location Meta(2) Meta name(s) to use for the hit position with expected format :
  • Location : "meta_of_type_gps_point"
  • Latitude + Longitude : "meta_latitude,meta_longitude"
 		 ONE  
Google maps clientId If empty, it will use the non premium API (restriction applies).  ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the Google Map widget. You must enter an integer.  ONE  
Height Specifies the height of the Google Map widget. You must enter an integer.  ONE  

Gauge

Description: A gauge.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts-more.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Gauge value Value.  ONE  
Min value Min value.  ONE  
Max value Max value.  ONE  
Unit Unit.  ONE  
Ranges   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Range min Min range.  ONE  
Range max Max range.  ONE  
Range Color Color of the range.  ONE  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Pie Chart Premium

Description: A pie chart is a circular chart divided into sectors, illustrating proportions.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/pieChart.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet Specifies the facet that will be used by the chart on the X axis.  ONE  
Legend Specifies the chart legend.  ONE  
Angle   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
NameDescriptionArityValue(s)
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'desc*', 'score*', 'count*', 'value*' and 'range*' impact performance on the server side.
 		 ONE default
description-asc
description-desc
description-num-asc
description-num-desc
description-range-asc
description-range-desc
value-asc
value-desc 
Max number of categories Specifies the maximum number of categories to display. You must enter an integer.  ONE  
Show 'Others' group Display or not the 'Others' category group.  ONE false
true 
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to customize the colors of your pie chart slices or to redirect clicks on pages.   ONE '+ this.point.name +'
' + this.y + percentage; } }, plotOptions: { series: { stickyTracking: false, shadow: false, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } } }, pie: { cursor: 'pointer', showInLegend: true, dataLabels: { enabled: false /* enabled: true, formatter: function() { if (this.percentage > 8) { return this.point.name; } else { return '' }; }, color: 'white' */ }, point: { events: { legendItemClick: function(e) { /* if (e.target.url != null) { exa.redirect(e.target.url); return false; } */ if (this.visible) { this['y_old'] = this.y; this.update(0); } else { this.update( this.y_old ); } } } } } } }]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Chart Switcher Premium

Description: This widget can contain many Chart widgets configured for different categories, and the user can select which one to display. (Only supports 360 official charting widgets).
Supports sub widgets: MANY
Supports feeds: ZERO

External files included:

FilenameType
/resources/css/jquery.dd.csscss
/resources/javascript/jquery.dd.jsjs
css/style.lesscss
js/multipleCharts.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE /WEB-INF/jsp/commons/noFacets.jsp 

Line Chart Premium

Description: A line chart is a type of graph, which displays information as a series of data points connected by straight line segments.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/lineChart.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
multi_dimension
hierarchical_2d
legacy_2d 
X Specifies the facet(s) that will be used by the chart on the X axis.  ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Y   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart on the Y axis.  ONE  
Series type The default series type for the chart.  ONE
area
areaspline
bar
column
line
spline 
Axis Choose the Y axis. The Y axis can be configured in the javascript tab  ONE
0
1
2
3 
Legend Legend for the series  ONE  
NameDescriptionArityValue(s)
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
description-num-asc
description-num-desc
description-range-asc
description-range-desc
value-asc
value-desc 
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Show 'Others' group Display or not the 'Others' category group.  ONE false
true 
Default Y value Specifies the default Y value. You must enter an integer or leave it empty.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE {series.name}
{point.key}', pointFormat: ':{point.y}
', footerFormat:'', valueDecimals: 2 }, legend: { margin: 20, borderWidth: 0, layout: 'horizontal', itemWidth: 150 }, xAxis: { title: { text: null }, labels: { rotation: -45, align: 'right' }, categories: [], tickInterval: ((data != null && data.xAxis != null && data.xAxis.categories != null) ? Math.floor(data.xAxis.categories.length / 15, 0) + 1 : null), min:0 }, yAxis: [{ title: { text: null }, min:0 }, { title: { text: null }, min:0 }, { title: { text: null }, min:0 }, { title: { text: null }, min:0 }], plotOptions: { series: { // Configure color threshold //threshold:0, //negativeColor:"#FF0000", cursor: 'pointer', stickyTracking: false, shadow: false, marker: { enabled: false }, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } } } } } ]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Stacked Column Chart Premium

Description: A stacked column chart is a diagram used to compare parts to the whole. Each bar on the X axis represents the total value of a given category, and displays the distribution for each part of this category.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/stackedColumnChart.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
multi_dimension
hierarchical_2d
legacy_2d 
X   ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Y   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Series type The default series type for the chart.  ONE
area
areaspline
bar
column
line
spline 
Axis Choose the Y axis. The Y axis can be configured in the javascript tab  ONE
0
1
2
3 
Legend Legend for the series  ONE  
NameDescriptionArityValue(s)
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
description-num-asc
description-num-desc
description-range-asc
description-range-desc
value-asc
value-desc 
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Show 'Others' group Display or not the 'Others' category group.  ONE false
true 
Default Y value Specifies the default Y value. You must enter an integer or leave it empty.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE {series.name}
{point.key}', pointFormat: ':{point.y}
', footerFormat:'', valueDecimals: 2 }, xAxis: { title: { text: null }, labels: { rotation: -45, align: 'right' }, categories: [], tickInterval: ((data != null && data.xAxis != null && data.xAxis.categories != null) ? Math.floor(data.xAxis.categories.length / 15, 0) + 1 : null), min:0 }, yAxis: [{ title: { text: null }, min:0 }, { title: { text: null }, min:0 }, { title: { text: null }, min:0 }, { title: { text: null }, min:0 }], plotOptions: { series: { // Configure color threshold //threshold:0, //negativeColor:"#FF0000", cursor: 'pointer', stickyTracking: false, shadow: false, marker: { enabled: false }, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } } }, column: { /*stacking: 'normal'*/ } } } ]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Spider Chart Premium

Description: A spider chart (also known as radar chart) displays data on several axes starting from the same point. Spider charts are useful when you want to look at different factors all related to one item.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/highcharts-more.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
multi_dimension
hierarchical_2d
legacy_2d 
X Specifies the facet(s) that will be used by the chart on the X axis.  ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Y   MANY  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart on the Y axis.  ONE  
Legend Specifies the chart legend.  ONE  
NameDescriptionArityValue(s)
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
description-num-asc
description-num-desc
description-range-asc
description-range-desc
value-asc
value-desc 
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Show 'Others' group Display or not the 'Others' category group.  ONE false
true 
Default Y value Specifies the default Y value. You must enter an integer or leave it empty.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to customize the colors of your pie chart slices or to redirect clicks on pages.   ONE '+ this.series.name +'
'+ this.x +': '+ this.y; } }, plotOptions: { series: { stickyTracking: false, shadow: false, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } } } }, xAxis: { tickmarkPlacement:'on', lineWidth:0 }, yAxis: { gridLineInterpolation: 'polygon', lineWidth: 0, min: 0 }, }]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Table Chart Premium

Description: A table that behaves like a chart.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/excanvas.compiled.jsjs
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/tableChart.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
multi_dimension
hierarchical_2d
legacy_2d 
Facet name Specifies the facet to display in the column headers.  ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values.  ONE compare
merge 
Y   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart on the Y axis.  ONE  
Legend Specifies the chart legend.  ONE  
NameDescriptionArityValue(s)
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
description-num-asc
description-num-desc
description-range-asc
description-range-desc
value-asc
value-desc 
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Show 'Others' group Display or not the 'Others' category group.  ONE false
true 
Default Y value Specifies the default Y value. You must enter an integer or leave it empty.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Timeline Premium

Description: A timeline chart is a diagram used to show the evolution of a given category over time. Time is displayed on the X axis and values are displayed on the Y axis.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/timeChart.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE normal
multi_dimension
hierarchical_2d
legacy_2d 
X Specifies the category or date facet that will be used by the chart on the X axis. If a date facet is used, it must use the following hierarchy: year/month/day(/hour/min/sec).  ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Y   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart on the Y axis.  ONE  
Series type The default series type for the chart.  ONE
area
areaspline
bar
column
line
spline 
Axis Choose the Y axis. The Y axis can be configured in the javascript tab.  ONE
0
1
2
3 
Legend Legend for the series  ONE  
NameDescriptionArityValue(s)
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE {series.name}: {point.y}
', //footerFormat:'', valueDecimals: 2 }, legend: { borderWidth: 0, layout: 'horizontal', enabled: true }, xAxis: { type: 'datetime', title: { text: null }, labels: { rotation: -20, align: 'right' } }, yAxis: [{ title: { text: null }, min:0 }, { title: { text: null }, min:0 }, { title: { text: null }, min:0 }, { title: { text: null }, min:0 }], plotOptions: { series: { // Configure color threshold //threshold:0, //negativeColor:"#FF0000", cursor: 'pointer', stickyTracking: false, shadow: false, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } }, marker: { enabled: false } } } } ]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE 270 

Scatter Plot Chart Premium

Description: A scatter plot displays data as a collection of points. They use horizontal and vertical axes to plot data points (like line graphs) and are used to show how much one variable is affected by another.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts.jsjs
/resources/highcharts/js/stackedColumnChart.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
multi_dimension
hierarchical_2d
legacy_2d 
Facet list   ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Series legend Legend for the series  ONE  
X   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Legend Legend for the X axis  ONE  
Y   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Legend Legend for the Y axis  ONE  
NameDescriptionArityValue(s)
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE '+ this.point.name +'
'+ this.x +'/'+ this.y; }, valueDecimals: 2 }, plotOptions: { series: { cursor: 'pointer', stickyTracking: false, shadow: false, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } } }, scatter: { marker: { radius: 5, states: { hover: { enabled: true, lineColor: 'rgb(100,100,100)' } } }, states: { hover: { marker: { enabled: false } } } } } } ]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

User Configurable Dashboard Premium

Description: An end-user configurable dashboard that lets people create and organize their own charts and reports.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
/resources/javascript/storage/storage-client-0.2.jsjs
/resources/javascript/jquery-ui/jquery-ui-1.8.7.custom.min.jsjs
/resources/javascript/jquery.cookie.jsjs
/resources/javascript/jquery.json-2.2.jsjs
js/dashboard.jsjs
/resources/javascript/jquery.spinner.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title (required) Specifies the widget title.  ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values.  ONE compare
merge 
Facets   MANY  
NameDescriptionArityValue(s)
Name   ONE  
Type Specifies the facet type.  ONE normal
multi_dimension
hierarchical_2d
legacy_2d 
Y   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Series type The default series type for the chart.  ONE
area
areaspline
bar
column
line
spline 
Axis Choose the Y axis. The Y axis can be configured in the javascript tab  ONE
0
1
2
3 
Legend Legend for the series  ONE  
NameDescriptionArityValue(s)
unique dashboard ID Specifies the unique dashboard ID to identify the dashboard on the page. By default the WUID is used.  ZERO_OR_ONE  
Storage Specifies the type of storage. Only connected users can use the dashboard widget in 'storage' mode.  ONE cookie
storage 
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
description-num-asc
description-num-desc
description-range-asc
description-range-desc
value-asc
value-desc 
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Show 'Others' group Display or not the 'Others' category group.  ONE false
true 
Default Y value Specifies the default Y value. You must enter an integer or leave it empty.  ONE  
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE /WEB-INF/jsp/commons/noFacets.jsp 
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options   ONE '+ name +'
' + x + this.y + percentage; }, style: { fontSize: '10px' } }, plotOptions: { series: { stickyTracking: false }, spline: { marker: { enabled: false }, events: { click: function(e) { if (e.point.url) { exa.redirect(buildUrl(e.target.chart.options.facetPageName, e.target.chart.options.facetPageNameQueryString, e.point.url)); } } } }, column: { /*stacking: 'normal',*/ events: { click: function(e) { if (e.point.url) { exa.redirect(buildUrl(e.target.chart.options.facetPageName, e.target.chart.options.facetPageNameQueryString, e.point.url)); } } } }, pie: { dataLabels: { enabled: false /* enabled: true, formatter: function() { if (this.percentage > 8) { return this.point.name; } else { return '' }; }, color: 'white' */ }, showInLegend: true, point: { events: { legendItemClick: function(e) { /* if (e.target.url != null) { var chart = e.target.series.chart; exa.redirect(buildUrl(chart.options.facetPageName, chart.options.facetPageNameQueryString, e.target.url)); return false; } */ if (this.visible) { this['y_old'] = this.y; this.update(0); } else { this.update( this.y_old ); } } } }, events: { click: function(e) { if (e.point.url) { exa.redirect(buildUrl(e.target.chart.options.facetPageName, e.target.chart.options.facetPageNameQueryString, e.point.url)); } } } } } } ]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Chart width Specifies the width of the charts contained in the dashboard. If your dashboard is in a tab, you can set the width of the chart (in pixels), otherwise let it be empty. Charts will optimize the size to fill the column.  ONE  
Chart height Specifies the height of the charts contained in the dashboard.  ONE  
Number of columns Specifies the number of columns to display in the dashboard.  ONE  

Bubble Chart Premium

Description: Bubble.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts-more.jsjs
/resources/highcharts/js/highcharts.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
multi_dimension
hierarchical_2d
legacy_2d 
Facet list   ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Series legend Legend for the series  ONE  
X   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Legend Legend for the X axis  ONE  
Y   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Legend Legend for the Y axis  ONE  
Size   ONE  
NameDescriptionArityValue(s)
Aggregation Specifies the type of aggregations that will be used by the chart.  ONE  
Legend Legend for the bublle size  ONE  
NameDescriptionArityValue(s)
Max number of categories Specifies the maximum number of facet categories to display. You must enter an integer.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE '+ this.point.name +'
'; tooltip += this.point.xLegend + ": "+this.point.x+'
'; tooltip += this.point.yLegend + ": "+this.point.y+'
'; tooltip += this.point.sizeLegend + ": "+this.point.z+'
'; return tooltip; }, valueDecimals: 2 }, plotOptions: { series: { cursor: 'pointer', stickyTracking: false, shadow: false, events: { click: function(e) { if (e.point.url) { exa.redirect(e.point.url); } } } }, scatter: { marker: { radius: 5, states: { hover: { enabled: true, lineColor: 'rgb(100,100,100)' } } }, states: { hover: { marker: { enabled: false } } } } } } ]]> 
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Timeline Area Range Premium

Description: Timeline Area Range.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/highcharts/css/style.csscss
/resources/highcharts/js/highcharts.src.jsjs
/resources/highcharts/js/highcharts-more.jsjs
/resources/highcharts/js/highcharts.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Facet type Specifies the facet type.  ONE auto
normal
hierarchical_2d
legacy_2d 
Facet list   ONE  
Aggregation min Specifies an aggregation for the low range  ONE  
Aggregation max Specifies an aggregation for the high range.  ONE  
Merge or compare feeds The chart can gather several feeds using the same facets. You can either choose to 'merge' or 'compare' feed values. Note that you can only merge count aggregation.  ONE compare
merge 
Series legend Legend for the series  ONE  
NameDescriptionArityValue(s)
JavaScript options Lets you customize some javascript options used by the Highcharts library. Your javascript options will overwrite the default ones. For example, it can be useful to redirect clicks on pages.   ONE  
NameDescriptionArityValue(s)
Javascript function Lets you define the Javascript function that will be executed on data before the Highcharts processing.   ONE  
NameDescriptionArityValue(s)
Width Specifies the width of the widget (pixels). You must enter an integer.  ONE  
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  

Login Premium

Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
The title  ONE_OR_MANY  
The logo displayed on the login form's top.  ONE_OR_MANY  
Template path Template to use for the login form.  ONE  

Logout Premium

Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Action Specifies the page to which the user will be redirected.  ONE  
Button label Specifies the text to display on the button.  ONE  
Button icon Specifies the icon that must be used for this button.  ONE  
Icon position Specifies the position of the icon compared to the button's label. If "notext" is selected, then only the icon will be displayed.  ONE left
right
top
bottom
notext 
NameDescriptionArityValue(s)
Button theme Specifies the theme to use for this button.  ONE
a
b
c
d
e 
Button inlined Creates a more compact button that is as wide as the text and icon inside.  ONE false
true 

Metrics Premium

Description: Displays metrics based on a MEL expression.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
css/style.lesscss
js/metrics.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Title Widget Title. It can be used to describe the metric, for example, 'Most Popular Camera'.  ZERO_OR_ONE  
Metric   MANY  
NameDescriptionArityValue(s)
Value The metric value must be defined as a MEL expression. See the contextual menu for MEL samples.  ONE  
Description Specifies the description displayed below the metric value. It can either be free text or a MEL expression. If blank, no description is displayed.  ZERO_OR_ONE  
Trend expression

Specifies a MEL expression that must return a number (n). The following rules are applied:

  • if n > 0, displays â–²
  • if n 0, displays â–¼
  • if n = 0, displays =

This default behavior can be inverted by selecting the Invert trend colors option. Not used if left empty.

 		 ZERO_OR_ONE  
Invert trend colors Inverts trend colors. Values above 0 will be displayed in red. For example, a rise in fuel prices can be considered as a negative event.  ZERO_OR_ONE false
true 

Display sub widgets Premium

Description:
Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

Page parameter selector Premium

Description: Set a page parameter from a select input.
Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget title (required) Specifies the widget title.  ZERO_OR_ONE  
Page parameter Name of the page parameter.  ONE  
Submit label   ZERO_OR_ONE  
Items Specifies the items displayed in the control.  MANY  
NameDescriptionArityValue(s)
Label   ONE  
Value   ONE  

Display First Widget Premium

Description: A widget wrapper that will only display the first widget that renders something. Do not forget to add the appropriate triggers on your sub-widgets to cancel their rendering.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO
External files included: None.

Widget option groups:

Sub-feed Access Premium

Description: A wrapper that consumes a feed. Consequently, in hit widgets you can access sub-feeds which are not available at the top-level.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ONE
External files included: None.

Widget option groups:

Multi Dimension Facet Builder Premium

Description: This widget allows you to display MultiDimension facets, which use the categories generated by two or more other facets (any type, virtual or not, but one-dimensional only) to create its own categories.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
js/mdfb.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Facet ID The ID of the matrix facet to create  ONE  
Facet type The type of the matrix facet to create  ONE multidimension
hierarchical2d 
Facet root list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.
Leaving facet root list empty forces iteration over all the facets independent of what mode is chosen.  		 ONE No filtering
Include
Exclude 
Facets list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Facets are different on X and Y   ZERO_OR_ONE false
true 
Facet root list mode (y) Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.
Leaving facet root list empty forces iteration over all the facets independent of what mode is chosen.  		 ZERO_OR_ONE No filtering
Include
Exclude 
Facets list (y) The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ZERO_OR_ONE  
MultiDimension options
  • option:'range'     value:'2000,4000,Too expensive for you'
  • option:'expr'     value:'#int(10*#random())'
 		 ZERO_OR_MANY  
NameDescriptionArityValue(s)
  ONE  
  ONE  
Facet axis options
  • option:'aggr.avgCustomersTime'     value:'AVG(customers*time_per_customer)'
  • option:'range'     value:'2000,4000,Too expensive for you'
  • option:'expr'     value:'#int(10*#random())'
 		 ZERO_OR_MANY  
NameDescriptionArityValue(s)
  ONE x
y
x/y 
  ONE  
  ONE  
  ONE  
NameDescriptionArityValue(s)
Create aggregation   ONE false
true 
Aggregation ID The ID of the aggregation to create  ONE  
Aggregations
  • display name:'Average Customer time'     expression:'AVG(customers*time_per_customer)'
  • display name:'Range'     expression:'2000,4000,Too expensive for you'
  • display name:'Random'     expression:'#int(10*#random())'
 		 MANY  
NameDescriptionArityValue(s)
  ONE  
  ONE  

Serialize Feed

Description: Serializes a ResultFeed in your page.
Supports sub widgets: ZERO
Supports feeds: MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Variable name Specifies the JavaScript variable name that will be used to store the serialized feeds.  ONE  
Serialize facets   ZERO_OR_ONE false
true 
Serialize hits   ZERO_OR_ONE false
true 
NameDescriptionArityValue(s)
JavaScript   ZERO_OR_ONE  
NameDescriptionArityValue(s)

For Each Hit Premium

Description: Loops over a result list.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ONE
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Maximum iteration Max number of iterations   ZERO_OR_ONE  
HTML tag

The HTML tag used to render this widget default is div, could be table, ul, ol, etc.

It could be usefull to render custom html.

 		 ZERO_OR_ONE  

Language Selector

Description: Provides the user with the possibility of switching the application language.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
/resources/css/jquery.dd.csscss
/resources/javascript/jquery.dd.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Languages List of available languages for the Mashup UI.  MANY  
Visible options count Specifies the number of options visible at a time when the select field is opened.  ONE  
Select size Specifies the width of the select field. You must enter an integer.  ONE  

Export to CSV/Atom/PDF Premium

Description: Provides links to download the current results into different formats (Excel CSV, Atom, PDF).
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
Enable ATOM export Adds an RSS button on the page to download the current search results into Atom format.  ONE false
true 
NameDescriptionArityValue(s)
Enable CSV export Adds an MS Excel button on the page to download the current search results into CSV format.  ONE false
true 
Export all metas Specifies whether to export all the metas displayed in the search results into the CSV output. If 'false', you can select the metas to display using the 'Meta list' property.  ONE false
true 
Meta list The specified metas, separated by commas, will be the only ones displayed.  ONE  
File name Specifies the CSV file name.  ONE  
Encoding Specifies the encoding format to use in the CSV output.  ONE UTF-8
ISO-8859-15 
Byte Order Mark Specifies, for UTF-8 encoding, whether to appends or not a Byte Order Mark at the beginning of the file.  ZERO_OR_ONE false
true 
Separator Specifies the separator to use in the CSV output. By default, the CSV file is saved with semicolon separators.  ONE  
Multi-valued separator Specifies the separator to use in the CSV output for multi-valued metas. By default ','.  ZERO_OR_ONE  
Export all results Specifies how to export the results displayed in the search results into the CSV output. If 'false', only the first page is exported. If 'true', everything is exported within a certain limit (you must define the number of pages to export).  ONE false
true 
Maximum number of pages Specifies the maximum number of pages that will be exported.  ONE  
NameDescriptionArityValue(s)
Enable PDF export Adds an Adobe PDF button on the page to download the current search results into PDF format.  ONE false
true 
URL to export By default (if it's empty), the current page will be exported. Otherwise you can specify another page with an optional query string.  ONE  
File name Specifies the PDF file name.  ONE  
NameDescriptionArityValue(s)
Enable PNG export Adds a PNG button on the page to download the current search results into PNG format.  ONE false
true 
URL to export By default (if it's empty), the current page will be exported. Otherwise you can specify another page with an optional query string.  ONE  
File name Specifies the PNG file name.  ONE  
Width Specifies the PNG width in px. Defaults to 800  ZERO_OR_ONE  
Height Specifies the PNG height in px. Defaults to 600.  ZERO_OR_ONE  

Collapsible content Premium

Description: Creates a collapsible block of content.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget title Specifies the content header that will be used as a link.  ONE  
Collapsed by default Collapses the content by default when the page loads.  ONE false
true 

Explain Query

Description: Display a graphical representation of Index6 queries. 'debug' must contain 'ast' (or 'all') in feed advanced parameters.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
css/style.csscss
javascript/explainquery.jsjs
javascript/jit-yc.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
Expanded by default Defines whether the query is to be explained by default.  ONE true
false 
Display node arguments Defines whether to display arguments for each node (arguments correspond to node-specific information, e.g. 'word' for #alphanum).  ONE true
false 
Display node options Defines whether to display options for each node.  ONE true
false 
Display node contributed counts Defines whether to display the number of query-matching dids that match each node.  ONE true
false 
Display node estimated counts Defines whether to display the estimated counts for each node.  ONE false
true 
Show match flow If activated, the edge width will reflect the number of results matched by the node.  ONE true
false 

Explain Match

Description: Display Index6 match explanation. The explanation shows a graphical representation on the query that highlights the matching parts of the query and gives more information as to why each part has matched. This includes positions, ranking keys, transformed query operators and their arguments and options. 'hit_info' must contain 'ast' in feed advanced parameters.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
css/style.csscss
javascript/explainmatch.jsjs
javascript/jit-yc.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
Expanded by default Defines whether matches are to be explained by default.  ONE true
false 
Display node arguments Defines whether to display arguments for each node (arguments correspond to node-specific information, e.g. 'word' for #alphanum).  ONE true
false 
Display node positions Defines whether to display word positions for each node.  ONE true
false 
Display node options Defines whether to display options for each node.  ONE true
false 
Display node ranking keys Defines whether to display the value of each ranking key for each node.  ONE true
false 

Advanced 2D Facet Table Premium

Description: Displays the categories of a given facet in a table that provides conditional formatting options to the end user.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Facet Facet used to populate the table.  ONE  
Aggregation Specifies the type of aggregation that will be displayed in the table cells.  ONE  
Display the row number Displays the row number in the first column.  ONE false
true 
Moveable columns Sets the table columns as moveable so that they can be reordered by the user on the Mashup UI.  ONE false
true 
Enable pagination Enables pagination on the table. This is useful for long tables displaying many rows.  ONE false
true 
Pagination size Number of visible rows per page.  ONE  
Enable show/hide columns   ONE false
true 
Enable conditional formatting   ONE false
true 
Enable save feature If the user is logged, conditional formatting and/or column order will be saved in the mashup builder storage otherwise in a browser cookie.  ONE false
true 
Enable permalink generation Permalink can be used to share customized table. (conditionnal formatting rules, column order...)  ONE false
true 
Permalink storage key Specifies the permalink storage key which identifies the default configuration. If blank, the end-user will not see the default configuration values in the table cells.  ONE  
NameDescriptionArityValue(s)
Storage key Specifies the key name for the local storage. It is used when the user is logged in to store his formatting preferences.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Results Rendering If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  

Result List Premium

Description: This widget displays the search results in a list view. Each result (or hit) is displayed in a pane displaying a title and N given metas depending on your data model configuration.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Hit title Specifies the title displayed for each hit. Leave blank to use the Title defined in the source feed.  ONE  
Hit URL Specifies the link to create for each hit title.  ONE  
Display hit icon Displays the icons of documents (reflects the document MIME type).  ONE false
true 
Display hit ID Displays the Hit ID.  ONE false
true 
Display hit content Displays the Hit content.  ONE false
true 
Truncate hit content Truncates the hit content if the number of characters exceeds the given value (default is 500).  ONE  
Display hit preview Enables the link to CloudView's document preview feature.  ONE false
true 
Display hit dowload Enables the link to CloudView's document download feature.  ONE false
true 
Similar hits URL Specifies an URL that will display similar hits.  ZERO_OR_ONE  
Buttons alignment Specifies how to align the buttons.  ONE left
center
right 
NameDescriptionArityValue(s)
Display metas Displays metas in the hit content.  ONE false
true 
Custom meta display Customizes the meta display with your specifications.  ONE false
true 
Custom HTML Specifies the HTML to use to display the hit metas.  ONE  
Meta URL Target Specifies where to open metas with URLs.  ONE Current Page
New Page 
Meta filtering method Specifies the filtering method to apply to the metas. For the 'Exclude'and 'Include' methods, the 'Meta list' field allows to specify the metas to include or exclude.  ONE No filtering
Exclude
Include 
Meta list The specified metas, separated by commas, will be either the only ones displayed ('Include' method) or the only ones hidden ('Exclude' method).  ONE  
Meta sort method Specifies how metas will be sorted.  ONE default
description-asc
description-desc
shuffle 
NameDescriptionArityValue(s)
Display facets Displays facets in the hit content.  ONE false
true 
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.  		 ONE No filtering
Include
Exclude 
Facet list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Changes the order in which hit categories are returned. Selecting anything but 'default' impacts performance.  ONE default
description-asc
description-desc
range-asc
range-desc
shuffle 
NameDescriptionArityValue(s)
Display thumbnails If set to true, a thumbnail will be displayed next to the hit.  ONE false
true 
Use CloudView thumbnails If set to true, use the fetcher to retrieve CloudView's computed thumbnails.  ONE false
true 
Default URL thumbnail Specifies the URL of the default thumbnail that will be displayed if there are no thumbnails available in the feed's hit. Leave this field blank to have default, mime-type dependent thumbnails.  ONE  
NameDescriptionArityValue(s)
Hit JSP template Specifies the JSP template to use.
Using variables for finding a valid template is useful if you want to customize hit display based for example, on the TYPE.
Hit templates are in /WEB-INF/jsp/widgets/mobileDisplayHits/templates/.  		 ZERO_OR_ONE  
Default template (mandatory) Defines the default template to use when the Hit JSP template does not exist or is not defined.
For example, when no custom template for the current TYPE has been found.
The hit templates are in the 'templates' base path.  		 ONE  
NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Base path of the JSP templates You can replace the relative path by an absolute path like /WEB-INF/jsp/mydirectory/.  ONE  

Result List

Description: This widget displays the search results in a list view. Each result (or hit) is displayed in a pane displaying a title and N given metas depending on your data model configuration.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
/resources/javascript/exa/io/io.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Hit title Specifies the title displayed for each hit. Leave blank to use the Title defined in the source feed.   ONE  
Hit URL Specifies the link to create for each hit title.  ONE  
Hit URL Target Specifies where to open the action for each Hit URL.  ONE Current Page
New Page 
Display hit icon Displays the icons of documents (reflects the document MIME type).  ONE false
true 
Display hit ID Displays the hit ID.  ONE false
true 
Display hit content Displays the hit content.  ONE false
true 
Truncate hit content Truncates the hit content if the number of characters exceeds the given value (default is 500).  ONE  
Display hit preview Displays the link to CloudView's document preview feature.  ONE false
true 
Display hit download Displays the link to CloudView's document download feature.  ONE false
true 
Inlined download Sets to "true" if it is intended to be displayed automatically by the browser.  ONE false
true 
Similar hits URL Specifies an URL that will display similar hits.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Display metas Displays metas in the hit content.  ONE false
true 
Custom meta display Customizes the meta display with your specifications.  ONE false
true 
Custom HTML Specifies the HTML to use to display the hit metas.  ONE  
Meta URL Target Specifies where to open metas with URLs.  ONE Current Page
New Page 
Meta filtering method Specifies the filtering method to apply to the metas. For the 'Exclude'and 'Include' methods, the 'Meta list' field allows to specify the metas to include or exclude.  ONE No filtering
Exclude
Include 
Meta list The specified metas, separated by commas, will be either the only ones displayed ('Include' method) or the only ones hidden ('Exclude' method).  ONE  
Meta sort method Specifies how metas will be sorted.  ONE default
description-asc
description-desc
shuffle 
NameDescriptionArityValue(s)
Display facets Displays facets in the hit content.  ONE false
true 
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.  		 ONE No filtering
Include
Exclude 
Facet list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.  ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*' impact performance on the server side.
 		 ONE default
description-asc
description-desc
range-asc
range-desc
shuffle 
NameDescriptionArityValue(s)
Display thumbnails Defines where hit thumbnails are displayed.  ONE on the left
on the right
none 
Use CloudView thumbnails If set to true, use the fetcher to retrieve CloudView's computed thumbnails.  ONE false
true 
Default URL thumbnail This thumbnail is displayed if there are no thumbnails available in the feed's hit. Leave this field blank to have default, MIME type dependent thumbnails.  ONE  
Thumbnail Height Specifies the height of the thumbnails (pixels). You must enter an integer.  ZERO_OR_ONE  
Thumbnail Width Specifies the width of the thumbnails (pixels). You must enter an integer.  ZERO_OR_ONE  
On-scroll loading container id if set, on scroll-loading will be applied to the specific container instead of the entire window. You must set the css id of a scrollable element.  ONE  
NameDescriptionArityValue(s)
Hit JSP template Specifies the JSP template to use.
Using variables for finding a valid template is useful if you want to customize hit display based for example, on the TYPE.
Hit templates are in /WEB-INF/jsp/widgets/displayHits/templates/.  		 ZERO_OR_ONE  
Default template (mandatory) Defines the default template to use when the Hit JSP template does not exist or is not defined.
For example, when no custom template for the current TYPE has been found.
The hit templates are in the 'templates' base path.  		 ONE  
NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Base path of the JSP templates You can replace the relative path by an absolute path like /WEB-INF/jsp/mydirectory/.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Thumbnail

Description: Gets thumbnails from the given feed.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
/resources/javascript/jquery.scrollTo.jsjs
js/jquery.preview.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
On-scroll loading container id if set, on scroll-loading will be applied to the specific container instead of the entire window. You must set the css id of a scrollable element.  ONE  
NameDescriptionArityValue(s)
Default URL thumbnail Specifies the thumbnail that will be displayed if there are no thumbnails available in the feed's hit.
Leave this field blank to have default, MIME type dependent thumbnails.  		 ONE  
Use CloudView thumbnails Uses the fetcher to retrieve CloudView's computed thumbnails.  ONE false
true 
Thumbnail Height Specifies the height of the thumbnails (pixels). You must enter an integer.  ZERO_OR_ONE  
Thumbnail Width Specifies the width of the thumbnails (pixels). You must enter an integer.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Title Specifies the title displayed for each hit.
Leave blank to use the Title defined in the source feed.  		 ONE  
Hit URL Specifies the link to create for each hit title.  ONE  
Hit URL Target Specifies where to open the action for each Hit URL.  ONE Current Page
New Page 

Document Download

Description: Displays a download link for the first entry of the given Feed.
Supports sub widgets: ZERO
Supports feeds: ONE
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Inlined download Sets to "true" if it is intended to be displayed automatically by the browser.  ONE false
true 
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, this widget is hidden using a Trigger or a message is displayed.  ONE  

Advanced Facet Table Premium

Description: Displays the categories of a given facet in a table that provides conditional formatting options to the end user.
Supports sub widgets: ZERO
Supports feeds: MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Facet Facet used to populate the table.  ONE  
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*', 'count*' and 'range*' impact performance on the client side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE all
flat
leaves 
Display the row number Displays the row number in the first column.  ONE false
true 
Moveable columns Sets the table columns as moveable so that they can be reordered by the user on the Mashup UI.  ONE false
true 
Enable pagination Enables pagination on the table. This is useful for long tables displaying many rows.  ONE false
true 
Pagination size Number of visible rows per page.  ONE  
Enable show/hide columns   ONE false
true 
Enable conditional formatting   ONE false
true 
Enable save feature If the user is logged, conditional formatting and/or column order will be saved in the mashup builder storage otherwise in a browser cookie.  ONE false
true 
Enable permalink generation Permalink can be used to share customized table. (conditionnal formatting rules, column order...)  ONE false
true 
Permalink storage key Specifies the permalink storage key which identifies the default configuration. If blank, the end-user will not see the default configuration values in the table cells.  ONE  
NameDescriptionArityValue(s)
Column description   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Column identifier Unique column identifier (required for formatting).  ONE  
Column title Specifies the column title.  ONE  
Data type Specifies the data type displayed in the column.  ONE
number
string
boolean
date
url 
Column value

The column value can be defined using a MEL expression. Note that the value must correspond to the specified Data type:

  • Number: The value can be an integer or a double. For example, ${category.aggrs["avg_price"]}
  • String: Any string value including HTML. For example, ${category.description} - Note that you can also display entries' categories ${entry.facets["author"].description}
  • Boolean: A boolean value (true or false) For example, ${category.count>100}
  • Date: A date value matching the Date input format below. Note that the displayed date can be formatted using Date output format.
  • URl: The value should be the URL (link).
 		 ONE  
Date input format

Pattern format:

CodePurpose Sample

G

The era designator

AD

y

The year

2002

M

The month

April & 04

d

The day of the month

20

h

The hour(12-hour time)

12

H

The hour(24-hour time)

0

m

The minute

45

s

The second

52

S

The millisecond

970

E

The day of the week

Tuesday

D

The day of the year

180

F

The day of the week in the month

2 (2nd Wed in month)

w

The week in the year

27

W

The week in the month

2

a

The a.m./p.m. indicator

PM

k

The hour(12-hour time)

24

K

The hour(24-hour time)

0

z

The time zone

Central Standard Time

'

 

The escape for text

''

 

The single quote
 		 ONE  
Date output format

Pattern format:

CodePurpose Sample

G

The era designator

AD

y

The year

2002

M

The month

April & 04

d

The day of the month

20

h

The hour(12-hour time)

12

H

The hour(24-hour time)

0

m

The minute

45

s

The second

52

S

The millisecond

970

E

The day of the week

Tuesday

D

The day of the year

180

F

The day of the week in the month

2 (2nd Wed in month)

w

The week in the year

27

W

The week in the month

2

a

The a.m./p.m. indicator

PM

k

The hour(12-hour time)

24

K

The hour(24-hour time)

0

z

The time zone

Central Standard Time

'

 

The escape for text

''

 

The single quote
 		 ONE  
Url label   ONE  
Displayed value MEL expression representing the value. If empty, the value will be dislayed.  ONE  
NameDescriptionArityValue(s)
Storage key Specifies the key name for the local storage. It is used when the user is logged in to store his formatting preferences.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Results Rendering If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  

Document Preview

Description: Shows the CloudView Preview of the first entry in the given Feed. This preview is the HTML-based preview from CloudView.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
css/style.lesscss
/resources/javascript/jquery.cookie.jsjs
/resources/javascript/jquery.scrollTo.jsjs
js/jquery.preview.jsjs
js/highlight.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Show preview in lightbox Displays the preview over the search page in a lightbox window.  ONE false
true 
NameDescriptionArityValue(s)
Height Specifies the height of the widget (pixels). You must enter an integer.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  

Result Table

Description: Displays your results in a table with a column for each meta / facet, to allow for quick overviews.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
/resources/javascript/exa/io/io.jsjs
javascript/displayHitAsTable.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Hit title Specifies the title displayed for each hit. Leave blank to use the Title defined in the source feed.  ONE  
Hit URL Specifies the link to create for each hit title.  ONE  
Hit URL Target Specifies where to open the action for each Hit URL  ONE Current Page
New Page 
Display Title column Adds a Title column at the beginning of the table containing hit titles.  ONE false
true 
Display Content column Adds a Content column that displays the hit Text. This is usually Summary.  ONE false
true 
Display Score column Adds a Score column that displays the hit score.  ONE false
true 
Display hit preview Enables the link to CloudView's document preview feature.  ONE false
true 
Display hit download Enables the link to CloudView's document download feature.  ONE false
true 
Similar hits URL Specifies an URL that will display similar hits.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Display metas Displays metas in the hit content.  ONE false
true 
Meta filtering method Specifies the filtering method to apply to the metas. For the 'Exclude'and 'Include' methods, the 'Meta list' field allows to specify the metas to include or exclude.  ONE No filtering
Exclude
Include 
Meta list The specified metas, separated by commas, will be either the only ones displayed ('Include' method) or the only ones hidden ('Exclude' method).  ONE  
Meta sort method Specifies how metas will be sorted.  ONE default
description-asc
description-desc
shuffle 
Meta URL Target Specifies where to open the action for meta with URL  ONE Current Page
New Page 
NameDescriptionArityValue(s)
Display facets Displays facets in the hit content.  ONE false
true 
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.  		 ONE No filtering
Include
Exclude 
Facet list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Facet JSP directory Facet templates are stored in /templates/{Facet JSP directory}.
You can add sub-directories that match the facet path such as: top/language/facet.jsp  		 ONE  
NameDescriptionArityValue(s)
Display thumbnails Displays a thumbnail in the first column of the table.  ONE false
true 
Use CloudView thumbnails If set to true, use the fetcher to retrieve CloudView's computed thumbnails.  ONE false
true 
Default URL thumbnail Specifies the URL of the default thumbnail that will be displayed if there are no thumbnails available in the feed's hit. Leave this field blank to have default, MIME type dependent thumbnails.  ONE  
Thumbnail Height Specifies the height of the thumbnails (pixels). You must enter an integer.  ZERO_OR_ONE  
Thumbnail Width Specifies the width of the thumbnails (pixels). You must enter an integer.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Table Summary This table summary will not be displayed in the user interface but it might be useful for accessibility.  ONE  
Wrap long strings Defines the word wrap limit, that is to say the maximum number of characters before a line is broken and wrapped onto the next line. You must enter an integer.  ONE  
Column title You can force a column title using this option.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
  ONE  
  ONE  
Sort list NOTE: Only metas that are of the cloudview type (int, date) can used as sort parameters.   ZERO_OR_MANY  
NameDescriptionArityValue(s)
  ONE  
  ONE  
NameDescriptionArityValue(s)
Results Rendering If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Base path of the JSP templates You can replace the relative path by an absolute path like /WEB-INF/jsp/mydirectory/.  ONE  

Advanced Result Table Premium

Description: Displays a table that provides conditional formatting options based on hit results. Hit results can be formatted by the end user.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/javascript/jquery.cookie.jsjs
/resources/javascript/exa/data/DataTable.jsjs
/resources/javascript/exa/ui/AdvancedTable.jsjs
/resources/css/exa/common.lesscss
/resources/css/exa/menu.lesscss
/resources/css/exa/table.lesscss
/resources/css/exa/pagination.lesscss
/resources/css/exa/colorpicker.lesscss
css/style.lesscss
/resources/css/jquery-ui/jquery-ui-1.8.15.custom.csscss
/resources/javascript/jquery-ui/jquery-ui-1.8.7.custom.min.jsjs
/resources/javascript/jquery.json-2.2.jsjs
/resources/javascript/buildUrl.jsjs
/resources/javascript/storage/storage-client-0.2.jsjs
js/widget.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Display hit preview Enables the link to CloudView's document preview feature.  ONE false
true 
Display hit download Enables the link to CloudView's document download feature.  ONE false
true 
Display the row number Displays the row number in the first column.  ONE false
true 
Moveable columns Sets the table columns as moveable so that they can be reordered by the user on the Mashup UI.  ONE false
true 
Enable pagination Enables pagination on the table. This is useful for long tables displaying many rows.  ONE false
true 
Pagination size Number of visible rows per page.  ONE  
Display thumbnails Displays a thumbnail in the first column of the table.  ONE false
true 
Use CloudView thumbnails If set to true, use the fetcher to retrieve CloudView's computed thumbnails.  ONE false
true 
Default URL thumbnail Specifies the URL of the default thumbnail that will be displayed if there are no thumbnails available in the feed's hit. Leave this field blank to have default, MIME type dependent thumbnails.  ONE  
Enable show/hide columns   ONE false
true 
Enable conditional formatting   ONE false
true 
Enable save feature If the user is logged, conditional formatting and/or column order will be saved in the mashup builder storage otherwise in a browser cookie.  ONE false
true 
Enable permalink generation Permalink can be used to share customized table. (conditionnal formatting rules, column order...)  ONE false
true 
Permalink storage key Specifies the permalink storage key which identifies the default configuration. If blank, the end-user will not see the default configuration values in the table cells.  ONE  
NameDescriptionArityValue(s)
Column description   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Column identifier Unique column identifier (required for formatting).  ONE  
Column title Specifies the column title.  ONE  
Data type Specifies the data type displayed in the column.  ONE
number
string
boolean
date
url 
Column value

The column value can be defined using a MEL expression. Note that the value must correspond to the specified Data type:

  • Number: The value can be an integer or a double. For example, ${category.aggrs["avg_price"]}
  • String: Any string value including HTML. For example, ${category.description} - Note that you can also display entries' categories ${entry.facets["author"].description}
  • Boolean: A boolean value (true or false) For example, ${category.count>100}
  • Date: A date value matching the Date input format below. Note that the displayed date can be formatted using Date output format.
  • URl: The value should be the URL (link).
 		 ONE  
Date input format

Pattern format:

CodePurpose Sample

G

The era designator

AD

y

The year

2002

M

The month

April & 04

d

The day of the month

20

h

The hour(12-hour time)

12

H

The hour(24-hour time)

0

m

The minute

45

s

The second

52

S

The millisecond

970

E

The day of the week

Tuesday

D

The day of the year

180

F

The day of the week in the month

2 (2nd Wed in month)

w

The week in the year

27

W

The week in the month

2

a

The a.m./p.m. indicator

PM

k

The hour(12-hour time)

24

K

The hour(24-hour time)

0

z

The time zone

Central Standard Time

'

 

The escape for text

''

 

The single quote
 		 ONE  
Date output format

Pattern format:

CodePurpose Sample

G

The era designator

AD

y

The year

2002

M

The month

April & 04

d

The day of the month

20

h

The hour(12-hour time)

12

H

The hour(24-hour time)

0

m

The minute

45

s

The second

52

S

The millisecond

970

E

The day of the week

Tuesday

D

The day of the year

180

F

The day of the week in the month

2 (2nd Wed in month)

w

The week in the year

27

W

The week in the month

2

a

The a.m./p.m. indicator

PM

k

The hour(12-hour time)

24

K

The hour(24-hour time)

0

z

The time zone

Central Standard Time

'

 

The escape for text

''

 

The single quote
 		 ONE  
Url label Should be used to display the link label. Note that you can use HTML.  ONE  
Displayed value MEL expression representing the value. If empty, the value will be dislayed.  ONE  
NameDescriptionArityValue(s)
Storage key Specifies the key name for the local storage. It is used when the user is logged in to store his formatting preferences.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Results Rendering If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  

SpellCheck List

Description: A simple list that displays the suggestions of the Spell Checker.
Supports sub widgets: ZERO
Supports feeds: MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Query parameter Specifies the name of the query parameter for the suggested searches.  ONE  
Max number of suggestion Specifies the maximum number of suggestion to display.  ONE  

List view Premium

Description: For creating a list that can be used for data display, navigation, result list, data entry, etc.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
List type Specifies the type of list to create. An ordered list will use the tag (ol) instead of (ul).  ONE unordered
ordered 

Item Premium

Description: Drop this widget in a 'List view' widget to add a new element to the list.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Type Specifies the type of the item.  ONE text
divider
link 
Action Specifies the page to which the user will be redirected. If empty, no link will be created. For a nested list view you can use '#'.  ZERO_OR_ONE  
Text Specifies the label of the list item.  ONE  
Icon Specifies the icon to use on the list item.  ONE  
NameDescriptionArityValue(s)
Item description Adds a description to the list item.  ONE  
Item count indicator Adds a count indicator to the right of the list item. Can be used with a "divider" item.  ONE  
Item thumbnail Adds a thumbnail to the left of a the item.
Simply add the path to an image and it will scale the image to a 80 pixels square.
You can use a relative path such as: /resources/logo/images/cvlogo_small.png  		 ONE  
Item aside content Adds a small content on the top right of the list item.  ONE  

Slider Premium

Description: This widget displays a slider based on a CloudView virtual expression.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/javascript/jquery-ui/jquery-ui-1.8.7.custom.min.jsjs
/resources/javascript/buildUrl.jsjs
/resources/css/jquery-ui/jquery-ui-1.8.15.custom.csscss
/resources/css/exa/common.lesscss
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Expression Specifies the CloudView virtual expression used to create the slider. For example, document_file_size/1000  ONE  
Display pattern Use %{MIN} and %{MAX} to display the min and max values of the slider scale.  ONE  
Interval Sets the interval between values.  ONE  
NameDescriptionArityValue(s)
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Facet Dropdown Premium

Description: Displays a drop-down list of categories for a given facet.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/javascript/exa/ui/MenuItem.jsjs
/resources/javascript/exa/ui/CheckBoxMenuItem.jsjs
/resources/javascript/exa/ui/SelectMenu.jsjs
/resources/css/exa/common.lesscss
/resources/css/exa/menu.lesscss
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Facet Specifies the facet that will be used to populate the drop-down list.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE /WEB-INF/jsp/commons/noFacets.jsp 
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Facet List Premium

Description: Displays a list of categories for a given facet.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/css/exa/common.lesscss
/resources/css/exa/pagination.lesscss
css/style.lesscss
/resources/javascript/exa/ui/Input.jsjs
/resources/javascript/exa/ui/Pagination.jsjs
js/list.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Facet Specifies the facet that will be used to populate the list.  ONE  
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*', 'count*' and 'range*' impact performance on the client side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Aggregation Specifies the type of aggregation that will be displayed next to the facet name.  ZERO_OR_ONE  
Enable pagination   ONE false
true 
Pagination size Specifies the number of categories displayed per page.  ONE  
Enable filtering Displays an input field to filter categories.  ONE false
true 
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE /WEB-INF/jsp/commons/noFacets.jsp 
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Login

Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Template path Template to use for the login form.  ONE  

Logout

Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Template path Template to use for the logout link.  ONE  

Query History Premium

Description: Provides a breadcrumb trail for navigation with the most recent queries.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_ONE

External files included:

FilenameType
css/style.lesscss
js/history.jsjs
/resources/javascript/storage/storage-client-0.2.jsjs
/resources/javascript/jquery.cookie.jsjs
/resources/javascript/jquery.json-2.2.jsjs

Widget option groups:

Standard Facets

Description: This widget allows you to add a 'Refinements' panel displaying a selection of facets for faceted navigation.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
js/refines.jsjs
/resources/javascript/jquery.cookie.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet root list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.
Leaving facet root list empty forces iteration over all the facets independent of what mode is chosen.  		 ONE No filtering
Include
Exclude 
Facets list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Aggregation Specifies the type of aggregation that will be displayed next to the facet name.  ZERO_OR_ONE  
Disjunctive facets Displays check-boxes next to each category.  ONE false
true 
Display exclude Displays an exclude link next to the facet name.  ONE false
true 
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*', 'count*' and 'range*' impact performance on the client side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE all
flat
leaves 
Max number of categories Specifies the maximum number of categories to display, no value means "no limit". Defaults to "1000".  ONE  
Drill down The drill-down option only works if the iteration mode is set to 'flat'. Otherwise, it has no sense.  ONE false
true 
Facet JSP directory Templates are located in /templates/{Facet JSP directory}. You can add sub-directories that match the facet path such as: top/language/facet.jsp AND top/language/category.jsp.  ONE  
NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Base path of the JSP templates You can replace the relative path by an absolute path like /WEB-INF/jsp/mydirectory/.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Back To Top Premium

Description: This widget displays a back to top button when the body is scrolled.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss

Widget option groups:

Standard Facets

Description: This widget allows you to add a 'Refinements' panel displaying a selection of facets for faceted navigation.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
css/theme_enterprise.lesscss
js/refines.jsjs
/resources/javascript/jquery.cookie.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet root list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.
Leaving facet root list empty forces iteration over all the facets independent of what mode is chosen.  		 ONE No filtering
Include
Exclude 
Facets list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Aggregation Specifies the type of aggregation that will be displayed next to the facet name.  ZERO_OR_ONE  
Disjunctive facets Displays check-boxes next to each category.  ONE false
true 
Display exclude Displays an exclude link next to the facet name.  ONE false
true 
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*', 'count*' and 'range*' impact performance on the client side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE all
flat
leaves 
Max number of categories Specifies the maximum number of categories to display, no value means "no limit". Defaults to "1000".  ONE  
Drill down The drill-down option only works if the iteration mode is set to 'flat'. Otherwise, it has no sense.  ONE false
true 
Facet JSP directory Templates are located in /templates/{Facet JSP directory}. You can add sub-directories that match the facet path such as: top/language/facet.jsp AND top/language/category.jsp.  ONE  
NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Base path of the JSP templates You can replace the relative path by an absolute path like /WEB-INF/jsp/mydirectory/.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

menu Premium

Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO

External files included:

FilenameType
css/style.lesscss
js/menu.jsjs

Widget option groups:

Horizontal Facets Premium

Description: An horizontal Facet list, more adapted to large panels than the standard vertical Facets.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet root list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.
Leaving facet root list empty forces iteration over all the facets independent of what mode is chosen.  		 ONE No filtering
Include
Exclude 
Facet list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Max number of categories Specifies the maximum number of categories to display. You must enter an integer.  ONE  
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts facet categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Value to display Specifies the value to display next to the facet name. It must exist for all the displayed facets.  ZERO_OR_MANY  
Display exclude Displays an exclude link next to the facet name.  ONE false
true 
NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
NameDescriptionArityValue(s)
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  

Navigation Header

Description: A simple, informational, header that displays the number of results, the current page, etc.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

Drop-down Lists Premium

Description: This widget allows you to add a drop-down list on a form.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
/resources/javascript/buildUrl.jsjs
js/refinesAsSelect.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Destination page on click Indicates the URL that should be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet root list mode Specifies the facet list filtering mode.
For the 'Exclude' and 'Include' modes, the 'Facet list' field allows to specify the metas to include or exclude.
Leaving facet root list empty forces iteration over all the facets independent of what mode is chosen.  		 ONE No filtering
Include
Exclude 
Facets list The specified facets, separated by commas, will be either the only ones displayed ('Include' mode) or the only ones hidden ('Exclude' mode). Leaving the facet list empty iterates over all facets.  ONE  
Max number of categories Specifies the maximum number of categories to display. You must enter an integer.  ONE  
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*', 'count*' and 'range*' impact performance on the server side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Aggregation Specifies the type of aggregation that will be displayed next to the facet name.  ZERO_OR_ONE  
NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no name is displayed.  ONE  
Display feed row Enables the "feed" row display.  ONE false
true 
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Navigation Menu Premium

Description: A navigation menu for the header or the footer of the Mashup Mobile.
Supports sub widgets: MANY
Supports feeds: ZERO
External files included: None.

Widget option groups:

Breadcrumbs Premium

Description: This widget displays breadcrumb links allowing you to navigate through the structured hierarchy of a facet. Typical breadcrumbs look like this: Parent node > Child node > Grandchild node.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
css/style.lesscss

Widget option groups:

Pagination

Description: The pagination widget allows you to scroll into your result set.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Pagination JSP template Specifies the Navigation header JSP template.
Change this if you do not want to use the original template.
Templates are located in /templates/.  		 ONE  
Number of pagination pages Sets the number of pages to display in the pagination.   ONE  
More results link target Specifies a link that will be displayed at the bottom of the result list to access more results.  ONE  
More results link label Specifies the label of the More results link.  ONE  
NameDescriptionArityValue(s)
Base path of the JSP templates You can replace the relative path (default: templates/) by an absolute path like /WEB-INF/jsp/mydirectory/.  ONE  

Saved Queries Premium

Description: This widget allows users to save their queries for a quick access.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
/resources/javascript/storage/storage-client-0.2.jsjs
/resources/javascript/jquery.json-2.2.jsjs
js/savedQueries.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Database Key Name Specifies the database key name.  ONE  
Type Specifies the access type. 'Private' requires the user to be logged in (and security enabled).   ONE Shared
Private 
Display 'Save this page' Creates a 'Save this page' link on the widget header. This link opens a dialog box prompting you to enter a name for the query to save.   ONE false
true 
Display 'delete' Creates a delete icon (small red cross) on the right of each saved query entry. You can then delete obsolete query entries.   ONE false
true 
Expanded view by default Expands the widget view to display all saved query entries.   ONE false
true 

Star Rating Premium

Description: Star-rate indexed documents
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
/resources/javascript/storage/storage-client-0.2.jsjs
/resources/javascript/jquery.json-2.2.jsjs
js/starRating.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Number of stars Specifies the number of stars to display in the widget (max 10).  ONE 1
2
3
4
5
6
7
8
9
10 
Star granularity Controls the granularity of the votes for each star. It slices stars into x pieces.  ONE 1
0.5
0.25 
Rating hover texts Specifies the texts that will be displayed when hovering over stars.
These texts must be ordered from low to high rating, and must be separated by semicolons ';'.
If blank, the feature is disabled as well as the AJAX loading spinner + "Submitted!" text.  		 ZERO_OR_ONE  
Show number of votes Shows the total number of votes next to the stars. It uses the format defined below.  ZERO_OR_ONE false
true 
Number of votes format Specifies the format of the message displaying the number of votes.  ZERO_OR_ONE  
Show 'unrated' text Shows 'unrated' layer on stars if no vote has been cast.   ONE false
true 
After successful vote, show Specifies the type of message that is displayed when the vote has been cast.  ONE Submitted rating
Average rating 
Star width in px Specifies the width of the star(s) (pixels). Should not be modified unless the sprite and/or CSS have been altered.  ONE  
Read Only Displays the stars but the user can't vote.  ONE  
NameDescriptionArityValue(s)
Identifying meta name Specifies a uniquely identifiable meta that will be used as storage key for the document (Good candidates: url, id).
if no meta name is set, the default value is 'url' from Hit Info.  		 ZERO_OR_ONE  
Storage key Specifies the database key that stores the JSON-rating. Change it only if you want to have more than one rating possible per document.   ONE  
Exported meta Rating (Float E [0, MAX_STARS]) is exported under this meta name (RepushDocuments must be enabled in storage). If blank, the feature is disabled.   ZERO_OR_ONE  

Tags Premium

Description: This widget allows users to tag documents with meta-data.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
/resources/javascript/storage/storage-client-0.2.jsjs
javascript/tagging.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Link Specifies an OnClick Link for tags. Example: "search?q=%{tag}". Leave blank to disable.   ZERO_OR_ONE  
Allow add/edit Allows to add/edit tags. If false, the 'Add new tags' link is not shown.   ONE false
true 
NameDescriptionArityValue(s)
Identifying meta name Specifies a uniquely identifiable meta that will be used as storage key for the document (Good candidates: url, id).
if no meta name is set, the default value is 'url' from Hit Info.  		 ZERO_OR_ONE  
Tags meta name Specifies the meta name under which tags are stored (Storage key).   ONE  

Comments Premium

Description: This widget allows users (anonymous or logged in) to see and contribute to comments about a given result in the page.
Supports sub widgets: ZERO
Supports feeds: ONE

External files included:

FilenameType
/resources/javascript/storage/storage-client-0.2.jsjs
/resources/javascript/jquery.json-2.2.jsjs
js/comments.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  
Who can comment? Specifies who can make comments.  ONE Anonymous
Logged-in
None 
Display Photo Specifies if the a photo is displayed   ONE false
true 
Photo url The url of the user's photo   ZERO_OR_ONE  
Display option Display template   ONE basic
multiline 
Display # comments Specifies the number of comments to display before showing "Show more comments"?   ONE  
Store # comments Specifies the maximum number of comments to store. Old comments are purged.   ONE  
NameDescriptionArityValue(s)
Storage key Specifies the storageKey used to save the comments into the storage.  ONE  
Identifying meta name Specifies a uniquely identifiable meta that will be used as storage key for the document (Good candidates: url, id).
If no meta name is set, the default value is 'url' from Hit Info.  		 ZERO_OR_ONE  
Comments meta name Specifies the name of the meta under which comments are exported for indexing. This storage key must end by [], ex: "comments[]". Leave blank to disable.   ZERO_OR_ONE  
Comments count meta name Meta name under which comments count are exported for indexing (Storage key). ex: "num_comments". Leave blank to disable.   ZERO_OR_ONE  

Bookmarks Premium

Description: This widget allows users to bookmark documents.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
/resources/javascript/exa/io/io.jsjs
/resources/javascript/exa/io/HitDecorationInterface.jsjs
/resources/javascript/storage/storage-client-0.2.jsjs
/resources/javascript/jquery.json-2.2.jsjs
js/bookmarks.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Title Widget title. If blank, no name is displayed.  ONE  
Data to display Specifies the meta that will be displayed in the bookmark list.   ZERO_OR_ONE  
Action Specifies the URL of the bookmark page  ZERO_OR_ONE  
Count selector Specifies the jquery selector of the element where you want to attach the number of bookmarks.   ONE  
Data to bookmark Specifies the data that will be stored in the bookmark list and that will be present in the url   ZERO_OR_MANY  
NameDescriptionArityValue(s)
Name   ONE  
Value   ONE  
NameDescriptionArityValue(s)
Storage Key Name Specifies the storage key name.  ONE  
Type Specifies the access type. 'user' requires the user to be logged in (and security enabled).   ONE user
shared 

Save as alert

Description:
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
/resources/javascript/exa/ui/forms.jsjs
/resources/javascript/exa/util/Context.jsjs
/resources/javascript/exa/util/KVOObject.jsjs
js/AlertingForm.jsjs
js/AlertingModel.jsjs
css/alerting.lesscss
css/alerting-form.lesscss

Widget option groups:

Alert Manager

Description:
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
/resources/javascript/exa/util/util.jsjs
/resources/javascript/exa/util/Context.jsjs
js/alerting.jsjs
css/alerting.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no title is displayed.  ONE  

Tag Cloud Premium

Description: This widget displays a tag cloud (or weighted list) to represent key tags. Tags are usually single words, and the importance of each tag is shown with font size or color.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no name is displayed.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facets list Specifies the facets to display in the cloud. They must be separated by commas.  ONE  
Number of tags displayed Specifies the maximum number of tags to display. You must enter an integer.  ONE  
Sort facets by Sorts the facets using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
shuffle 
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.   ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Aggregation Specifies the type of aggregation that will be used by the chart.  ONE  
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE flat
leaves
all 
NameDescriptionArityValue(s)
Max font size Specifies the maximum font size. You must enter an integer.  ONE  
Min font size Specifies the minimum font size. You must enter an integer.  ONE  
Clamp to min font threshold When the score is below this threshold, the size of the tag is clamped to 'Min font size'. (x E [0.0, 1.0], where 1.0 includes all tags, 0.0 includes none)   ONE 0.0
0.1
0.2
0.3
0.4
0.5
0.6
0.7
0.8
0.9
1.0 
Enable opacity tweak Tweaks the opacity of the tags whose score falls below 'minFontThreshold'  ONE false
true 
Organic look Moves tags randomly to give the cloud a more organic look.  ONE false
true 
Facet distinction Allows to apply common styles for tags from different facets.  ONE false
true 
NameDescriptionArityValue(s)
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Button

Description: Provides an HTML button to submit form information.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
/resources/javascript/jquery.validate.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Button label Defines the button label.  ONE  
Type This attribute specifies the type of control to create.  ONE submit
button
reset 
Width Specifies the width of the button.  ONE  
width format Specifies the width format of the button (pixels or page percentage).  ONE px
% 
onClick Specifies the client onclick event.  ZERO_OR_ONE  

Radio Buttons

Description: This widget allows you to add a control with radio buttons on a form.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
/resources/javascript/jquery.validate.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Name Defines the name of this control.  ONE  
Value Defines the type of value used by this control.  ZERO_OR_ONE  
Items Specifies the items displayed in the control.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Label   ONE  
Value   ONE  
NameDescriptionArityValue(s)
Enable Validation Specifies whether to enable validation for this control.  ONE false
true 
Validation message Specifies the message that will be displayed when validation fails for this field.  ZERO_OR_ONE  

CheckBox

Description: This widget allows you to add a checkbox on a form.
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
/resources/javascript/jquery.validate.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Name Defines the name of this checkbox.  ONE  
Value Defines the value of this checkbox.  ONE  
Label Defines the label of this checkbox.  ONE  
NameDescriptionArityValue(s)
Enable Validation Specifies whether to enable validation for this control.  ONE false
true 
Validation message Specifies the message that will be displayed when validation fails for this field.  ZERO_OR_ONE  

Form

Description: Provides an HTML form where you can add controls to submit information.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO

External files included:

FilenameType
/resources/javascript/jquery.validate.jsjs
/resources/javascript/exa/io/io.jsjs
/resources/javascript/exa/io/FormInterface.jsjs
/resources/javascript/exa/geo/geo.jsjs
javascript/searchActions.jsjs
/resources/javascript/jquery.cookie.jsjs
/resources/javascript/jquery.json-2.2.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Action Specifies the URL to use when form is submitted  ZERO_OR_ONE  
Method Specifies the HTTP method used to submit the form. Note that the Mashup pages does not handle 'POST' request.  ONE GET
POST 
Auto focus Places the text input caret on search field upon document load.  ZERO_OR_ONE false
true 
NameDescriptionArityValue(s)
Enable geolocation Injects the position of the user in the search form.
Warning: This option requires a browser that supports HTML5 Geolocation specification.
It will not work for older browsers and for Internet Explorer.  		 ONE false
true 
Latitude parameter Parameter name associated with the user latitude.  ONE  
Longitude parameter Parameter name associated with the user longitude.  ONE  
Maximum age Accepts a cached position whose age is no greater than the specified time in milliseconds. If 0 then the answer is not cached.  ONE  

Label

Description: This widget allows you to add a label on a form.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Text The label text  ONE  

Select

Description: This widget allows you to add a combo box on a form.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
/resources/javascript/jquery.validate.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Name Defines the name of this control.  ONE  
Value Defines the type of value used by this control.  ZERO_OR_ONE  
Multiple select This attribute allows multiple selections.  ONE false
true 
Multiple values separator Sets the string separator for multiple values.  ONE  
Width Specifies the width of this control.  ONE  
width format Specifies the width format of the control (pixels or page percentage).  ONE px
% 
Items Specifies the items displayed in the control.  ZERO_OR_MANY  
NameDescriptionArityValue(s)
Label   ONE  
Value   ONE  
NameDescriptionArityValue(s)
Enable Validation Specifies whether to enable validation for this control.  ONE false
true 
Validation message Specifies the message that will be displayed when validation fails for this control.  ZERO_OR_ONE  

Input

Description: This widget allows you to add an input field on a form.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY

External files included:

FilenameType
css/style.lesscss
js/jquery.suggest.jsjs
js/jquery.placeholder.jsjs
/resources/css/jquery-ui/jquery-ui-1.8.15.custom.csscss
/resources/javascript/jquery-ui/jquery-ui-1.8.7.custom.min.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Name Defines the name of this control.  ONE  
Value Defines the input value that will be displayed in the field.  ZERO_OR_ONE  
Type This attribute specifies the type of control to create.  ONE_OR_MANY text
password
datepicker
hidden 
Placeholder Displays a hint when input is empty to describe the expected value.  ZERO_OR_ONE  
Width Specifies the width of this control.  ONE  
width format Specifies the width format of the control (pixels or page percentage).  ONE px
% 
NameDescriptionArityValue(s)
Enable suggest Enables the suggest service on the search field. You must then select a suggest service - previously defined in the Administration Console - from 'Suggest Name'.  ONE false
true 
Suggest Name Suggest service name.  MANY  
Action Specifies whether the suggest should use a simple service or a suggest dispatcher which varies depending on the query input.   ONE dispatcher
service 
Config Indicates the name of the default Search API (example: sapi0) as defined in the 'Applications' menu.  ZERO_OR_ONE  
Search API URL Defines the URL that will be used by the Search API.  ZERO_OR_MANY  
API command Specifies the suggest API command name that will be appended to the 'Search API URL'.  ONE  
NameDescriptionArityValue(s)
Enable Validation Specifies whether to enable validation for this control.  ONE false
true 
Validation rules The validation rules for this input  ZERO_OR_MANY required
number
date
email
url
digits 
Validation message Specifies the message that will be displayed when validation fails for this field.  ZERO_OR_ONE  

2D Data Table Premium

Description: A 2D data table chart shows facet values using an horizontal header row and a vertical column row.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no title is displayed.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet ID Specifies the facet to display in the table.  ONE  
Facet type Specifies the facet type.  ONE auto
multi_dimension
hierarchical_2d
legacy_2d 
Show summaries Displays a 'Total' column and a 'Total' row in the table.  ONE false
true 
Aggregations   MANY  
NameDescriptionArityValue(s)
Aggregation Defines on which type of aggregation the table will be based on.  ONE  
Label The column label  ONE  
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE /WEB-INF/jsp/commons/noFacets.jsp 
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Inverted Data Table Premium

Description: In this type of table, each column represents a facet value and each row displays an associated aggregation value.
Supports sub widgets: ZERO
Supports feeds: MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no title is displayed.  ONE  
Destination page on click Indicates the URL that should be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet name Specifies the facet to display in the column headers.  ONE  
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*' and 'count*' impact performance on the server side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE flat
leaves
all 
NameDescriptionArityValue(s)
Display title column Enables the display of the "title" column.  ONE false
true 
Display total column Enables the display of the "total" column.  ONE false
true 
NameDescriptionArityValue(s)
Facet row title Name of the column containing facet titles.  ONE  
Total row title Name of the column containing facet totals.  ONE  
Rows   MANY  
NameDescriptionArityValue(s)
Value   ONE  
Title   ONE  
Display percentage Displays the value as a percentage.  ONE false
true 
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Data Table Premium

Description: This type of table displays N columns showing facet aggregation functions (these are defined in the Search Logic).
Supports sub widgets: ZERO
Supports feeds: MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no title is displayed.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet name Specifies the facet to display in the row headers.  ONE  
Sort categories by Sorts the categories using the selected method. Selecting anything but 'default' impacts performance.
  • 'default' requires no processing.
  • 'shuffle', 'desc*', 'score*', 'count*' and 'range*' impact performance on the server side.
 		 ONE default
description-asc
description-desc
score-asc
score-desc
count-asc
count-desc
range-asc
range-desc
shuffle 
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE flat
leaves
all 
NameDescriptionArityValue(s)
Facet column title Name of the column containing facet titles.  ONE  
Total column title Name of the column containing facet totals.  ONE  
Columns   MANY  
NameDescriptionArityValue(s)
Value   ONE  
Title   ONE  
Display percentage Displays the value as a percentage.  ONE false
true 
NameDescriptionArityValue(s)
Display title row Enables the display of the "title" row.  ONE false
true 
Display total row Enables the display of the "total" row.  ONE false
true 
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Data Table (Huge Datasets) Premium

Description: This type of table displays N columns showing facet aggregation functions (these are defined in the Search Logic) and pagination possibilities to define the number of items displayed per page.
Supports sub widgets: ZERO
Supports feeds: MANY

External files included:

FilenameType
css/style.lesscss
js/jquery.dataTables.jsjs
js/jquery.dataTables.init.jsjs

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If blank, no title is displayed.  ONE  
Destination page on click Indicates the URL that must be accessed for a refinement option. If blank, you stay on the same page.  ONE  
Facet name Specifies the facet to display in the row headers.  ONE  
Iteration mode Determines what data is displayed:
  • 'all' visits the first child of each node before processing its siblings,
  • 'leaves' iterates recursively, returning the end nodes,
  • 'flat' returns only the first level.
 		 ONE flat
leaves
all 
Number of items per page Specifies the number of items to be displayed per page.   ONE  
User filter Allows the user to filter the content of the table dynamically.   ONE false
true 
Sort categories by Sorts the categories using the selected method.  ONE  
NameDescriptionArityValue(s)
Mode   ONE  
Order   ONE asc
desc 
NameDescriptionArityValue(s)
Facet column title Name of the column containing facet titles.  ONE  
Total column title Name of the column containing facet totals.  ONE  
Columns   MANY  
NameDescriptionArityValue(s)
Value   ONE  
Title   ONE  
Display percentage Displays the value as a percentage.  ONE false
true 
NameDescriptionArityValue(s)
Display title row Enables the display of the "title" row.  ONE false
true 
Display total row Enables the display of the "total" row.  ONE false
true 
NameDescriptionArityValue(s)
JSP path to use if no results If there are no results, the widget is either hidden using a trigger, or a message is displayed using the content of a JSP file.  ONE  
Force refinement for feeds Forces refinements on the specified feeds.  ZERO_OR_MANY  

Rounded Box

Description: Draws a nice rounded box around the embedded widgets.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget title Widget title. If blank, no title is displayed.  ZERO_OR_ONE  

HTML

Description: Link to a JSP file or just enter HTML code to include in your page.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
HTML code HTML code to append to the document.  ONE  
NameDescriptionArityValue(s)
JSP file path You can either include HTML directly in the HTML Code text area, or include a JSP file that must be in the /WEB-INF/jsp directory of your web application. The path is defined including the root of the web application, for example, /WEB-INF/jsp/custom.jsp  ONE  
Disable Widget Tag Disabling the WidgetTag can be useful if you have some inconsistent HTML code which does not close all its tags  ONE false
true 

Page in Lightbox Premium

Description: Open the url in a Lightbox
Supports sub widgets: ZERO
Supports feeds: ZERO

External files included:

FilenameType
js/lighBoxPage.jsjs
css/style.lesscss

Widget option groups:

NameDescriptionArityValue(s)
CSS Selectors Specifies href CSS selectors that must be caught in order to be opened in the LightBox.
Examples:
  • "a" (all links in the page)
  • ".displayHits .contentWrapper a" (links from Result List widget)
  • ".refines table.facet a" (links from the Standard Facets widget)
 		 MANY  
Width Specifies the width of the Lightbox (pixels). You must enter an integer.  ONE  
Height Specifies the height of the Lightbox (pixels). You must enter an integer.  ONE  

Responsive Wrapper Premium

Description: This widget can be used to make a simple responsive design. Use two widgets one to left, the other to right.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Minimum width Specifies the minimum width(px) before the responsive rule applies.  ONE  
Percentage Width The width(%) used when your page is greater than the minimum width.  ONE  
Position Specifies the position of the wrapper.  ONE left
right 

Table

Description: For table layout.
Supports sub widgets: ZERO_OR_MANY
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Width Specifies the width of the table. Defaults to '100'.  ZERO_OR_ONE  
Width format Specifies the width format of the table. Defaults to '%'.  ZERO_OR_ONE
%
px 

Text

Description: This widget allows you to type and format text as you would in a rich text editor. It is useful for users who are not familiar with HTML code.
Supports sub widgets: ZERO
Supports feeds: ZERO_OR_MANY
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Widget Title Widget title. If, blank no name is displayed.  ONE  
Content Rich text to append to the document.  ONE  

Spacer

Description: A simple spacer to add blank spaces between widgets.
Supports sub widgets: ZERO
Supports feeds: ZERO
External files included: None.

Widget option groups:

NameDescriptionArityValue(s)
Height Specifies the height of the empty block (in pixels).  ONE  
NETVIBES Exalead CloudView - Mashup Builder Widget Reference - Copyright © 2021 Dassault Systemes