Personnaliser des filtres de date dans des tableaux de bord de KPI
Vous pouvez personnaliser le filtre de date en modifiant la structure JSON de l’objet de métadonnées du filtre de date via l’API. Vous pouvez :
- ajouter, modifier et retirer des granularités dans la période relative,
- ajouter, modifier et retirer des filtres dans des périodes prédéfinies,
- renommer des filtres,
- définir un filtre par défaut pour les nouveaux tableaux de bord de KPI.
Pour la structure JSON par défaut, consultez la section Structure JSON du filtre de date par défaut à la fin de cet article.
Toute modification du filtre de date affecte uniquement les nouveaux tableaux de bord de KPI de l’espace de travail.
Pour modifier un tableau de bord déjà créé, modifiez l’objet de MD du filtre de date de ce tableau de bord spécifique.
Objet de métadonnées du filtre de date
Vous pouvez accéder aux objets de MD de filtre de date à l’aide des liens suivants :
Pour l’intégralité de l’espace de travail
https://secure.gooddata.com/gdc/md/workspace_ID/objects/query?category=dateFilterConfig&limit=1
Pour un tableau de bord déjà créé
https://secure.gooddata.com/gdc/md/workspace_ID/obj/KPI_dashboard_ID
Pour une liste des tableaux de bord de KPI, accédez àhttps://secure.gooddata.com/gdc/md/workspace_ID/query/analyticaldashboard
Chaque filtre, ou partie d’un filtre, est identifié par :
localIdentifier
, un identifiant unique d’un filtre contenu dans la structure JSON,name
, le nom du filtre affiché sur le tableau de bord de KPI. Si vous laissez le nom vide, le tableau de bord crée le nom. Si vous ajoutez un nom personnalisé, mettez également à jour les versions localisées. Pour en savoir plus, consultez Localisation de métadonnées.
Les types de filtres correspondent aux noms JSON suivants :
Nom du tableau de bord de KPI | Nom JSON |
---|---|
Tout le temps | allTime |
Période statique | relativePresets * |
Période relative | relativeForm |
Périodes prédéfinies | relativePresets |
* La période statique que vous définissez est ajoutée à la section relativePresests de la structure JSON. |
Modifier des granularités dans la période relative
La période relative comprend des granularités qui peuvent être des jours, semaines, mois, trimestres et années au format suivant :
"GDC.time.week_us",
“GDC.time.month”, “GDC.time.year”, “GDC.time.quarter”, “GDC.time.date”
Si vous souhaitez retirer une granularité, supprimez l’élément de la section relativeForm
. Le code ci-dessous montre la période relative avec seulement les mois et années.
"relativeForm" : { "granularities" : [ "GDC.time.month", "GDC.time.year" ], "localIdentifier" : "relativeForm", "name" : "relativeForm", "visible" : true },
Le premier élément de la liste des granularités est sélectionné quand vous passez à la période relative.
Ajouter des périodes prédéfinies
Dans la section relativePresets
de la structure JSON, vous pouvez modifier les périodes prédéfinies du filtre de date.
Chaque période prédéfinie est composée des éléments présentés ci-dessous.
granularité
pouvant être des jours, semaines, mois, trimestres et années dans les formats suivants :"GDC.time.week_us", "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date"
de
età
qui spécifient la durée de la période en fonction de la granularité et par rapport à la date du jour. En fonction de la granularité, le nombre spécifie la durée par rapport à la date du jour (qui est toujours 0). Voici quelques exemples :De À Granularité Notes -2 0 GDC.time.date
Trois derniers jours 0 3 GDC.time.week_us
Dans quatre semaines -2 1 GDC.time.month
Des deux derniers mois au mois prochain -1 -1 GDC.time.quarter
Le trimestre dernier 0 0 GDC.time.year
Cette année localIdentifier
, nom unique contenu dans l’objet de MD du filtre de datename
, nom du filtre affiché sur le tableau de bord de KPISi vous laissez le nom vide, le nom par défaut est utilisé à la place. Si vous utilisez le portail GoodData dans plusieurs langues, mettez également à jour les autres langues. Pour en savoir plus, consultez Localisation de métadonnées.visible
, spécifie si le filtre est disponible sur le tableau de bord
Le code ci-dessous montre un nouveau paramètre qui filtre les 10 derniers jours et s’affiche sur le tableau de bord.
{ "from" : -9, "granularity" : "GDC.time.date", "localIdentifier" : "last_10_days", "name" : "Last 10 days", "to" : 0, "visible" : true },
renommer des filtres,
Pour renommer un filtre de date ou une partie d’un filtre de date, modifiez son paramètre name
. Si vous laissez le nom vide, il est créé automatiquement.
Le code ci-dessous montre la « Période relative » renommée « Set a relative filter » (Configurer un filtre relatif).
"relativeForm" : { "granularities" : [ "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date" ], "localIdentifier" : "relativeForm", "name" : "Set a relative filter", "visible" : true },
Si vous utilisez le portail GoodData en plusieurs langues, mettez également à jour les autres langues après avoir changé le nom. Pour plus d’informations, reportez-vous à Localisation de métadonnées.
Pour renommer un filtre sur un tableau de bord de KPI déjà créé, masquez ou supprimez le filtre et créez-en un nouveau avec le nom que vous voulez.
Changer le filtre par défaut pour les nouveaux tableaux de bord
Le paramètre selectedOption
détermine quel filtre de date est affiché par défaut pour les nouveaux tableaux de bord de KPI.
Par défaut, tous les nouveaux tableaux de bord de KPI sont filtrés sur Ce mois-ci
.
Pour changer le filtre par défaut, ajoutez son paramètre localIdentifier
au paramètre selectedOption
.
"selectedOption" : "relative_last_7_days"
Les filtres inclus dans le paramètre selectedOption
doivent être visibles. Si le filtre du paramètre selectedOption
est supprimé ou masqué, les tableaux de bord de KPI utilisent le filtre de date par défaut de l’espace de travail à la place.
Le filtre statique et la période relative ne peuvent pas être configurés en tant que selectedOption
.
Structure JSON du filtre de date par défaut
La structure JSON du filtre de date est composée de la définition des filtres individuels.
Vous pouvez utiliser la structure JSON par défaut suivante en tant que référence ou pour mettre à jour votre filtre de date.
{ "dateFilterConfig" : { "content" : { "absoluteForm" : { "localIdentifier" : "absoluteForm", "name" : "absoluteForm", "visible" : true }, "allTime" : { "localIdentifier" : "allTime", "name" : "allTime", "visible" : true }, "relativeForm" : { "granularities" : [ "GDC.time.week_us", "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date" ], "localIdentifier" : "relativeForm", "name" : "relativeForm", "visible" : true }, "relativePresets" : [ { "from" : -6, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_7_days", "name" : "Last 7 days", "to" : 0, "visible" : true }, { "from" : -29, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_30_days", "name" : "Last 30 days", "to" : 0, "visible" : true }, { "from" : -89, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_90_days", "name" : "Last 90 days", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_this_week", "name" : "This week", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_last_week", "name" : "Last week", "to" : -1, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_last_two_weeks", "name" : "Last two weeks", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.month", "localIdentifier" : "relative_this_month", "name" : "This month", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.month", "localIdentifier" : "relative_last_month", "name" : "Last month", "to" : -1, "visible" : true }, { "from" : -11, "granularity" : "GDC.time.month", "localIdentifier" : "relative_last_12_months", "name" : "Last 12 months", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_this_quarter", "name" : "This quarter", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_last_quarter", "name" : "Last quarter", "to" : -1, "visible" : true }, { "from" : -3, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_last_4_quarters", "name" : "Last 4 quarters", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.year", "localIdentifier" : "relative_this_year", "name" : "This year", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.year", "localIdentifier" : "relative_last_year", "name" : "Last year", "to" : -1, "visible" : true } ], "selectedOption" : "relative_this_month" } } }