====== Exalead / Mashup Builder ======


===== Chart =====

==== Eviter le rechargement des charts ====

Si un trigger "PLMA Asynchronous ajax loading" a été ajouté, la valeur par défaut du paramètre 'Auto refresh interval' est 30 => rechargement toutes les 30 secondes.
Pour éviter cela, il faut la mettre à 0.

==== Permettre la pagination des charts ====

Pour l'activer dans la table, dans le 'Flip container', dans la section 'Ajax', il faut :
  * Sélectionner 'Render second widget only on click'
  * Ajouter les paramètres 'maxPerLevelParamFacetName' pour chacune des composantes de la facettes dans 'Additional parameters'

Au niveau du chart, il faut :
  * Dans la section Axes, il faut :
    * Mettre 10 dans 'Max number of categories'
    * Mettre 'Paginate' dans Additional Categories
    * Mettre la valeur suivante dans 'Paginate condition' 
<code>${page.params["maxPerLevelParamFacetName"] != null && page.params["maxPerLevelParamFacetName"] != ''}</code>
{{ :mashupbuilder_axes.png?400 |}}

  * Dans la section 'Advanced', il faut :
    * Ajouter 'fonticon fonticon-dot-3' dans 'Button icon'
    * Ajouter les paramètres 'maxPerLevelParamFacetName' pour chacune des composantes de la facettes dans 'Additional parameters'
    * Mettre la valeur suivante dans 'Reload Button Condition' **(à ajuster en fonction de la facette)**
<code>${(page.params["maxPerLevelParamFacetName"] == null || page.params["maxPerLevelParamFacetName"] == '') && feed.facets['XXXX'].nbClippedCategories > 0}</code>

{{ ::mashupbuilder_advanced.png?400 |}}

==== Pie Chart - Ajout des légendes/valeurs dans le camembert ====
A modifier dans la section 'Javascript', dans la partie 'plotOptions/series' du Json

<code>
   dataLabels: {
       enabled: true
	   , format: '{point.name}<br/>{point.y}'
       , distance: -25
   },
</code>

{{:exalead:exalead_mashupbuilder_chart_pie_legend-valeur.png?400|}}

==== Rendre les colonnes visibles même avec valeur à 0 ====
{{ :exalead:exalead_mashupbuilder_column_minpointlength.png?400 |}}
<code>
plotOptions: {
    column: {
        dataLabels: {
            enabled: true,
        },
        minPointLength: 2
    },
...
</code>

==== Afficher la légende pour toutes les abscisses ====
A modifier dans la section 'Javascript', dans la partie 'xAxis' du Json

<code>
  tickInterval: 1,
</code>

==== Afficher valeur de Catagéory + valeur en haut des colonnes  ====

{{ :exalead:exalead_mashupbuilder_column_categoryandvalueontop.png?600 |}}

<code>
plotOptions: {
    column: {
        dataLabels: {
            enabled: true,
            formatter: function () {
                return this.series.name.substring(0, 3).toUpperCase() + " : " + this.y;
            }
        }
    },

</code>


==== Afficher un tooltip avec toutes les valeurs ====

=== Sur spline ===
A modifier dans la section 'Javascript', dans la partie 'tooltip'

OOTB
<code>
tooltip: {
  backgroundColor: '#222',
  borderWidth: 0,
  style: {
   color: '#fff'
  },
  useHTML: true,
  headerFormat: '<div style="display: inline-block; margin-right: 4px;margin-bottom: 2px;width:6px;height:6px;border-radius:3px;background-color:{series.color};"></div><b>{series.name}</b><br />{point.key}',
  pointFormat: ':{point.y}<br />',
  footerFormat:'',
  valueDecimals: 0
},
</code>

Configured
<code>
tooltip: {
  backgroundColor: '#222',
  borderWidth: 0,
  style: {
   color: '#fff'
  },
  useHTML: true,
  formatter: function(){
   var tooltip = '<b>#'+this.x.substring(4,6)+' '+this.x.substring(0,4)+'</b><br />';
   for(var i=0 ; i<this.points.length ; i++){
    tooltip += '<div style="display: inline-block; margin-right: 4px;margin-bottom: 2px;width:6px;height:6px;border-radius:3px;background-color:'+this.points[i].color+';"></div>'+this.points[i].series.name+': '+this.points[i].y+'<br />';
   }
   return tooltip;
  },
  valueDecimals: 0,
  shared: true
},
</code>
{{:exalead:exalead_mashupbuilder_line_legendonthesametooltpi.png?400|}}

=== Sur column ===
A modifier dans la section 'Javascript', dans la partie 'tooltip'

OOTB
<code>
tooltip: {
  backgroundColor: '#222',
  borderWidth: 0,
  style: {
   color: '#fff'
  },
  useHTML: true,
  headerFormat: '<div style="display: inline-block; margin-right: 4px;margin-bottom: 2px;width:6px;height:6px;border-radius:3px;background-color:{series.color};"></div><b>{series.name}</b><br />{point.key}',
  pointFormat: ':{point.y}<br />',
  footerFormat:'',
  valueDecimals: 0
},
</code>

Configured
<code>
tooltip: {
  backgroundColor: '#222',
  borderWidth: 0,
  style: {
   color: '#fff'
  },
  useHTML: true,
  headerFormat: '<span style="font-size:10px">{point.key}</span><table>',
  pointFormat: '<tr><td style="color:{series.color};padding:0">{series.name}: </td>' +
      '<td style="padding:0"><b>{point.y}</b></td></tr>',
  footerFormat: '</table>',
  shared: true,
  valueDecimals: 0,
  shared: true
},
</code>
{{:exalead:exalead_mashupbuilder_column_legendonthesametooltip.png?400|}}

===== Search Page =====

==== Retirer l'affichage d'un chart après multi-sélection ====
Dans le 'Flex Panel Container' qui contient la 'Result List', le 'Hit Details' et le 'Reload Container' avec le chart de multi selection :
  - Cliquer sur 'Edit Widget Layout'
  - Cliquer sur l'icône Settings du panel de droite
  - Retirer toutes les classes sauf 'hidden' dans l'onglet CSS
  - Cliquer sur 'Close Widget Layout'

Remarque, on peut faire la même chose avec le widget 'Hit Details'

Autre méthode
  * Dans le widget 'Multi-Selection', déselectionner 'Trigger Event on selection change'

===== PLMA Data Table =====

==== Enable pagination of table ====

Pour rafraichir les données dans la table en changeant la limite, il faut ajouter ‘per_page’ dans la liste des parmètres whitelisté du feed

{{ ::mashupbuilder_table_pagination.png?600 |}}

===== PLMA Simple Result List =====

==== Display multi-valued data with <br/> as separator ====

By default, for multi-valued data, the separator is ','.
In order to change the separator, it is required to change the 'Hit JSP template' parameter in 'Hit Template' section with the following parameter :
<code>
/WEB-INF/jsp/widgets_plugin_tmp/issue/pluginWidgets/edf-hpcCommonResources/hit-hpc.jsp
</code>

{{::exalead_mashupbuilder_plmasimpleresultlist_br.png?600|}}

The 'hit-hpc.jsp' page is included in the customer UI plugin.

===== Feed =====

Les paramètres des feeds sont disponibles dans la doc Exalead avec l'url suivante :
  * http://XXX:Port + 1/admin/docs/html/index.html#page/tech_ref%2Fedm-config-r-search-api-parameters_2.html
==== Ajout d'un tri de facette explicit ====

Au niveau du feed, dans la section "Facets/Add facet", il faut les infos suivantes :
  * 'nom de facet'#sort#explicit
  * 'nom de facet'#explicit_sort_order_values#'les valeurs possibles triés séparées par des virgules'

{{:exalead:exalead_mashbuilder_feed_triexplicite.png?600|}}