Aide

2. Aide
3. WebReport
4. Options

Options

Un WebReport peut être personnalisé à l’aides de l’objet « options ». Cet objet est utilisé pour définit l’apparence selon les besoins de l’utilisateur.
Par exemple vous pouvez afficher/Masquer les fonctionnalités tels que les filtres ou les tris, définir le format des champs date, ou activer/désactiver le drill down.
L’objet « options » est défini dans l’objet Report. Si aucune option n’est spécifiée, le WebReport utilisera les options par défaut. Nous allons voir ici toutes les options disponibles et comment les utiliser.
Toutes les options sont définies dans 3 sous-groupes :

• Grid – défini l’apparence du pivot et les fonctionnalités
• Chart– défini l’apparence du graphique pivot et les fonctionnalités
• General – défini les options applicables à tous les composants

 
Grid
Toutes les options « Grid » sont dans la section « grid » de l’objet « options ».

type	String	Type d’affichage du pivot : "compact", "classic", and "flat". Valeur par défaut : "compact".
title	String	Titre du pivot. Valeur par défaut : "".
showFilter	Boolean	Affiche les filtres des lignes/colonnes et les filtres du pivot : (true) ou (false). Valeur par défaut : true.
showHeaders	Boolean	Afficher les numéros de ligne/colonne : (true) ou (false). Valeur par défaut : true.
showTotals	String	Indique où afficher les totaux : dans les lignes ("rows"), dans les colonnes ("columns"), dans les deux ("on") ou aucun totaux ("off"). Valeur par défaut : "on".
showGrandTotals	String	Indique où afficher les totaux généraux : dans les lignes ("rows"), dans les colonnes ("columns"), dans les deux ("on") ou aucun totaux ("off"). Valeur par défaut : "on".
grandTotalsPosition	String	Indique la position des totaux généraux du pivot : en haut ("top") ou en bas ("bottom"). Disponible uniquement pour la vue « brute ». Valeur par défaut : "top".
showHierarchies	Boolean	Indique comment afficher les valeurs de champs pouvant être explorées sur le pivot : Avec un lien sur la droite (true) ou avec une icône sur la gauche (false). Valeur par défaut : true.
showHierarchyCaptions	Boolean	Afficher les légendes (true) sur le pivot ou non (false). Valeur par défaut : true.
drillthroughMaxRows	Number	Définit le nombre maximal de lignes pour la fenêtre d’exploration des valeurs. Valeur par défaut : 1000.
showReportFiltersArea	Boolean	Affiche les filtres du pivot (true) ou (false). Valeur par défaut : true.
dragging	Boolean	Autoriser le glisser-déposer des champs sur le pivot (true) ou (false). Valeur par défaut : true.
showEmptyValues	Boolean	Afficher les valeurs vides dans le pivot (true) ou non (false). Valeur par défaut : false.

 
Chart
Toutes les options « chart » sont dans la section « chart » de l’objet « options ».

type	String	Type d’affichage du graphique pivot : "column", "bar_h", "line", "scatter", "pie", "stacked_column", et "column_line". Valeur par défaut : "column".
title	String	Titre du graphique. Valeur par défaut : "".
showFilter	Boolean	Affiche les filtres des lignes/colonnes et les filtres du pivot : (true) ou (false). Valeur par défaut : true.
multipleMeasures	Boolean	Affiche plusieurs valeurs sur le graphique. Valeur par défaut : false.
oneLevel	Boolean	Dans les graphiques que l’on peut explorer, défini si le graphique affiche tous les nœuds sur l'axe des x et la légende (false) ou uniquement le nœud développé le plus bas sur l'axe des x et la légende (true). Valeur par défaut : false.
autoRange	Boolean	Indique si la plage de valeurs dans les graphiques est sélectionnée automatiquement ou non. Valeur par défaut : false.
reversedAxes	Boolean	Inverse les colonnes et les lignes. Valeur par défaut : false.
showLegend	Boolean	Afficher les légendes (true) sur le graphique ou non (false). Valeur par défaut : true.
showLegendButton	Boolean	Indique si le bouton pour afficher/masquer la légende des graphiques est visible. Lorsqu'elle est définie sur false, la légende est visible, sans bouton pour la masquer. Valeur par défaut : false.
showDataLabels	Boolean	Permet d’afficher les étiquettes. Si la valeur false, les étiquettes seront masquées. showAllLabels permet de configurer les étiquetts dans les graphiques de type Secteur. Valeur par défaut : false.
showAllLabels	Boolean	Permet d’afficher toutes les étiquettes dans les graphiques de type secteur si la valeur est à true. Si la valeur est à false alors seules les étiquettes pouvant être affichées sans se chevaucher seront affichées. Valeur par défaut : false.
showMeasures	Boolean	Permet d’afficher les listes déroulantes en haut des graphiques (false). Valeur par défaut : true.
showOneMeasureSelection	Boolean	Permet d’afficher la liste déroulante des valeurs (true) ou (false) la liste déroulante des valeurs sur les graphiques sera masquée s'il n'y a qu'une seule valeur dans la liste et visible s'il y a deux valeurs ou plus. Valeur par défaut : true.
showWarning	Boolean	Indique une alerte Indique si les données sont trop volumineuses pour les graphiques. Valeur par défaut : true.
position	String	Indique la position du graphique par rapport au pivot : "bottom", "top", "left", ou "right". Valeur par défaut : "bottom".
activeMeasure	Object	Liste des valeurs sélectionnées dans le graphique.
activeMeasure.uniqueName	String	Nom de la valeur unique.
activeMeasure.aggregation	String	Type d’agrégation pour les valeurs.
axisShortNumberFormat	Boolean	Indique si les étiquettes des axes sur les graphiques sont affichées en utilisant un format numérique court comme 10K, 10M, 10B, 10T (true) ou non (false). Valeur par défaut : undefined (affiche le format court si valeur max > 10M).

 
General
Toutes les options « general » sont dans l’objet « options ». 

viewType	String	Type de vue à afficher : "grid", "charts" ou "grid_charts" . Valeur par défaut :"grid".
filter	Object	Filtres :
filter.timezoneOffset	Number	La différence en minute entre UTC et l’heure locale de l’utilisateur, utilisé pour ajuster les dates dans le filtre. Valeur par défaut : the user’s local time.
filter.weekOffset	Number	Définit le nombre de jours à ajouter au début de la semaine (dimanche). Utilisé pour ajuster le premier jour de la semaine dans le calendrier du filtre. Valeur par défaut :1 (Lundi est le premier jour de la semaine).
filter.dateFormat	String	Modèle de date à utiliser pour formater les dates des filtres. Deux valeurs possibles : "dd/MM/yyyy" et "MM/dd/yyyy". Valeur par défaut :"dd/MM/yyyy".
filter.liveSearch	Boolean	Indique si la recherche est effectuée pendant que l'utilisateur tape (true) ou en cliquant sur le bouton Entrée (false). Valeur par défaut : true.
configuratorActive	Boolean	Indique si la liste des champs est ouverte (true) ou fermée (false). Valeur par défaut :false.
configuratorButton	Boolean	Affiche le bouton de configuration de la liste des champs. (true) ou (false). Valeur par défaut : true.
showAggregations	Boolean	Affiche la sélection d’agrégation (true) ou non (false) pour les valeurs dans la liste de champs. Valeur par défaut : true.
showCalculatedValuesButton	Boolean	Afficher le bouton « Ajouter champs calculés » (true) ou non (false). Valeur par défaut : true.
grouping	Boolean	Indique si le regroupement est activé. Cette fonctionnalité permet aux utilisateurs de regrouper les éléments choisis à l'aide d'une fenêtre de filtre. Par exemple si l’utilisateur. Par exemple, si le client a des magasins dans différentes villes et souhaite analyser les informations de vente, il serait possible de combiner plusieurs villes dans un groupe par région, par numéro de vente, etc. Valeur par défaut : false.
editing	Boolean	Indique si la fonction d'édition est activée (true) ou désactivée (false) dans la fenêtre d’exploration des données « Détail ». L'utilisateur pourra double-cliquer sur la cellule et y entrer une nouvelle valeur si la fonction d'édition est activée. Valeur par défaut : false.
drillThrough	Boolean	Indique si la fonction d'exploration des données est activée (true) ou désactivée (false). L'utilisateur peut accéder au détail en double-cliquant sur la cellule avec une valeur. Valeur par défaut : true.
showDrillThroughConfigurator	Boolean	Indique si le bouton Liste des champs est visible dans la vue « Détails ». Valeur par défaut : true.
sorting	String	Indique si les contrôles de tri sont visibles dans les lignes ("rows "), dans les colonnes ("columns "), dans les lignes et colonnes ("on" ou true), ou pas visibles du tout ("off" ou false ). Valeur par défaut :"on".
defaultDateType	String	Utilisé pour spécifier les types de données à appliquer aux champs de date par défaut. ("date", "date string", "year/month/day", "year/quarter/month/day", or "datetime"). Valeur par défaut :"date".
strictDataTypes	Boolean	Permet d'augmenter la vitesse de traitement des données. Si strictDataTypes à true, le WebReport traitera les valeurs numériques (ou toute autre marqué comme valeur) uniquement comme des valeurs et ne leur permettra pas d'être utilisées comme champ (true). Valeur par défaut :false.
datePattern	String	Format des champs de type « date string » ("type":"date string"). Format chaine par défaut : "dd/MM/yyyy".
dateTimePattern	String	Format des champs de type « datetime » ("type": "datetime"). Format de chaine par défaut : "dd/MM/yyyy HH:mm:ss".
timePattern	String	Format des champs de type « time» ("type": "time"). Format de chaine par défaut : "HH:mm:ss".
dateTimezoneOffset	Number	Permet de configurer les regroupements de date. ("date", "year/month/day", et "year/quarter/month/day").
showDefaultSlice	Boolean	Définit une configuration du Slice par défaut avec le premier champ des données en ligne et la première valeur en colonne (true) ou (false) pour n’afficher aucun champ par défaut. Valeur par défaut : true.
showEmptyData	Boolean	Il définit le comportement en cas de source de données vide de deux manières : (true), un pivot vide s’affiche et déclenche un événement dataerror. (false), un message s’affiche «La source de données est vide» et déclenche un événement dataerror pour tous les types mentionnés de la source de données vide.Valeur par défaut : true.
defaultHierarchySortName	String	Tri par défaut des valeurs des champs ("asc", "desc", ou "unsorted"). Valeur par défaut :"asc".
showAggregationLabels	Boolean	Affiche dans les titres des colonnes/lignes des agrégations "Somme des", "Somme de", etc.. Valeur par défaut :true.
showAllFieldsDrillThrough	Boolean	Affiche les colonnes pré-sélectionnées dans la vue « Détails » pour l’exploration des données (false) ou toutes les colonnes disponibles (true). Valeur par défaut :false.
liveFiltering	Boolean	Indique si le filtre dynamique pour les valeurs des champs est activé (true) ou désactivé (false). Valeur par défaut :false.
showFieldListSearch	Boolean	Indique si la barre de recherche dans la liste des champs est affichée (true) ou masquée (false). Valeur par défaut :false.
validateFormulas	Boolean	Indique si la validation est effectuée pour les champs calculées (true) ou non (false). Si la validation est activée et que le pivot contient une formule non valide, le message d'alerte «Formule incorrect» s'affiche. Pour désactiver le message d'alerte, mettre à (false). Valeur par défaut :true.
caseSensitiveMembers	Boolean	Indique si les valeurs des champs sont sensibles à la casse (true) ou non (false). Valeur par défaut :false.
validateReportFiles	Boolean	Indique si la validation des fichiers de configuration est activée (true) ou désactivée (false).. Valeur par défaut :true.
fieldListPosition	String	Afficher la liste des champs toujours à droite ("right") ou dans une fenêtre distincte ("undefined"). Valeur par défaut :undefined.
allowBrowsersCache	Boolean	Permet aux navigateurs à mettre en cache les données (true) ou non (false). Valeur par défaut :false.

 
Exemple de l'objet options défini par défaut dans un WebReport :

    "options": {
        "viewType": "grid",
        "grid": {
            "type": "compact",
            "title": "",
            "showFilter": true,
            "showHeaders": true,
            "showTotals": "on",
            "showGrandTotals": "on",
            "grandTotalsPosition": "top",
            "showExtraTotalLabels": false,
            "showHierarchies": true,
            "showHierarchyCaptions": true,
            "drillthroughMaxRows": 1000,
            "showReportFiltersArea": true,
            "dragging": true,
            "showAutoCalculationBar": true,
            "showEmptyValues": false
        },
        "chart": {
            "type": "column",
            "title": "",
            "showFilter": true,
            "labelsHierarchy": "",
            "multipleMeasures": false,
            "oneLevel": false,
            "autoRange": false,
            "reversedAxes": false,
            "showLegend": true,
            "showLegendButton": false,
            "showDataLabels": false,
            "showAllLabels": false,
            "showMeasures": true,
            "showOneMeasureSelection": true,
            "showWarning": true,
            "activeMeasure": {}
        },
        "filter": {
            "weekOffset": 1,
            "dateFormat": "dd/MM/yyyy",
            "liveSearch": true
        },
        "configuratorActive": false,
        "configuratorButton": true,
        "showAggregations": true,
        "showCalculatedValuesButton": true,
        "grouping": false,
        "editing": false,
        "drillThrough": true,
        "showDrillThroughConfigurator": true,
        "sorting": "on",
        "defaultDateType": "date",
        "strictDataTypes": false,
        "datePattern": "dd/MM/yyyy",
        "dateTimePattern": "dd/MM/yyyy HH:mm:ss",
        "showDefaultSlice": true,
        "showEmptyData": true,
        "defaultHierarchySortName": "asc",
        "showAggregationLabels": true,
        "sortAlphabetically": [],
        "showAllFieldsDrillThrough": false,
        "liveFiltering": false,
        "showFieldListSearch": false,
        "validateFormulas": true,
        "caseSensitiveMembers": false,
        "validateReportFiles": true,
        "fieldListPosition": undefined,
        "allowBrowsersCache": false
    }