Composants de l’application ReactJS

Auth

class Auth(props)

This component is used to manage user authentication

Auth.disconnect()

Disconnect the current user

Auth.getUserInfo()

Get infos on current connected user

Auth.handleTimeOut(exp)

Manage connection time

Auth.refreshConnexion()

Refresh connexion

Confirm

class Confirm(props)

Popup window with one or several buttons

Arguments

  • props (Object()) –

  • props.title (str()) –

  • props.content (JSX.Element()) –

  • props.hideCancel (boolean()) –

  • props.buttons (Array.) –

DashboardEdition

class DashboardEdition(props)

Permet de générer la structure d’un tableau de bord. Pour tout renseignement sur les fonctions de this.props.parentApi.callbacks, consultez le fichier ../src/index.js

L’enregistrement des données se fait dans la variable this.props.parentApi.data.tableauBordDonnees dont la structure est la suivante : { donnees: {

thematique1{
numero_analyse {

id_analysis (identifiant de l’analyse), representation : representation sélectionnée, categories { (uniquement celles dont la case est cochée)

categorie1 {titre: titre, categorie: nom de la catégorie, visble: true si elle est active false sinon}

}

}

} thematique2: etc.

} metadonnees: {titre: titre du tableau de bord, description: description du tableau de bord} (À préciser par l’utilsiateur.trice) }

DashboardEdition.buttonAddNewIndicator(groupNumber)

Retourne une balise html destinée à ajouter une analyse au tableau de bord

Arguments

  • groupNumber (int()) – : group ID

DashboardEdition.buttonCategoriesSelection(thematique, cle_analyse, categorie)

Ajoute une case à cocher / décocher pour chaque catégorie disponible, qu’on peut choisir - ou non - d’afficher dans le tableau de bord

Arguments

  • cle_analyse (entier()) – : numéro de l’analyse (identifiant incrémental)

DashboardEdition.buttonDeleteGroup(groupNumber)

Ajoute un bouton qui permet lorsqu’on clique dessus, de supprimer une thématique.

Arguments

  • groupNumber (entier()) – : identifiant incrémental de la thématique ou de l’enjeu dans alquelle est située l’analyse

DashboardEdition.buttonNewGroup()

Ajoute un bouton qui permet d’accéder au formulaire de création d’une nouvelle thématique”

DashboardEdition.buttonPublishDashboard(typeTerritoire, codeInseeTerritoire, dashboardId)

Ajoute un bouton associé à l’événement de publication d’un tableau de bord

Arguments

  • dashboardId (entier()) – : identifiant du tableau de bord

DashboardEdition.buttonUpdateDashboard(dashboardId)

Ajoute un bouton associé à l’événement de mise à jour d’un tableau de bord

Arguments

  • dashboardId (entier()) – : identifiant du tableau de bord

DashboardEdition.componentDidUpdate(props, etatComposant)
Lorsqu’un.e utilisateur.rice déclenche un événement et que la fonction render est lancée à nouveau

on met à jour la liste des tableaux de bord qui doivent figurer dans l’onglet « tableaux de bord ». Cette opération est nécessaire notamment lors de la mise à jour ou l’enregistrement d’un nouveau tableau de bord.

DashboardEdition.deleteGroup(groupNumber)
Déclenchée sur événement

Supprimer une thématique.

Arguments

  • groupNumber (entier()) – : Identifiant incrémental de la thématique ou de l’enjeu dans alquelle est située l’analyse

DashboardEdition.editGroupTitle(event, groupNumber)
Déclenchée sur événement (changement de l’état du formulaire où on saisit le titre de la ligne)

Modifie le titre d’une ligne à chaque changement d’état du formulaire modification de la clé (this.props.parentApi.data.tableauBordDonnees.donnees[thematique])

Arguments

  • groupNumber (entier()) – : Identifiant unique de la ligne dont on souhaite modifier le nom

DashboardEdition.formMetadata()
Ajoute le formulaire qui permet de saisir les métadonnées i.e le titre et

la description du tableau de bord.

DashboardEdition.formatDataForSavingDashboard()
Cette fonction structure les données selon les exigences de l’API pour l’enregistrement des tableaux

de bord. Pour rappel, l’enregistrement des tableaux de bord est réalisé dans deux tables : l’une contient les métadonnées (titre description, identifiant unique, auteur.rice), et une autre qui contient les données relatives aux lignes (identifiant, identifiant du tableau de bord auquel elles appartiennent, liste des indicateurs et de leurs représentations)

DashboardEdition.increaseDataSizeForSVG(tailleSVG, tailleData, imageSVG, groupNumber, representation, id_analysis, a)

Cette fonction permet de augmenter la taille de la donnée - représentation SVG

DashboardEdition.increaseSVGIconSize(tailleSVG, tailleData, imageSVG, groupNumber, representation, id_analysis, a)

Cette fonction permet de augmenter la taille de l’icon SVG - représentation SVG

DashboardEdition.insertIndicatorDeleteButton(groupNumber, cle_analyse)

Ajoute un bouton qui permet de créer une thématique aux données du tableau de bord

Arguments

  • groupNumber (entier()) – : identifiant incrémental de la thématique ou de l’enjeu dans alquelle est située l’analyse

  • cle_analyse (entier()) – : numéro de lo’analyse (identifiant incrémental)

DashboardEdition.maxAnalysisNumber()
Retourne le numéro d’un indicateur dont la valeur est maximale afin d’éviter que l’ajout d’un nouvel

indicateur en écrase un qui existe déjà (il faut à tout prix que ce numéro d’indicateur soit discriminant)

DashboardEdition.moveGroup(groupNumber, mouvement)

déplace une thématique vers le haut ou vers le bas

Arguments

  • groupNumber (integer()) – le numéro de la thématique qui se déplace

  • mouvement (up|down()) – le mouvement (up|down)

DashboardEdition.publishDashboard(typeTerritoire, codeInseeTerritoire, dashboardId)

Affecte un type de territoire et / ou territoire à un tableau de bord en base de données

Arguments

  • dashboardId (entier()) – : identifiant du tableau de bord

DashboardEdition.reduceDataSizeForSVG(tailleSVG, tailleData, imageSVG, groupNumber, representation, id_analysis, a)

Cette fonction permet de reduire la taille de la donnée - représentation SVG

DashboardEdition.reduceSVGIconSize(tailleSVG, tailleData, imageSVG, groupNumber, representation, id_analysis, a)

Cette fonction permet de reduire la taille de l’icon SVG - représentation SVG

DashboardEdition.removeIndicator(groupNumber, cle_analyse)
Déclenchée sur événement

Supprime une thématique aux données du tableau de bord

Arguments

  • groupNumber (entier()) – : Identifiant incrémental de la thématique ou de l’enjeu dans alquelle est située l’analyse

  • cle_analyse (entier()) – : numéro de lo’analyse (identifiant incrémental)

DashboardEdition.saveDashboard(mise_a_jour)
Déclenchée sur événement

Ajoute les métadonnées {titre: titre du tableau de bord, description: description du tableau de bord} aux donneés du tableau de bord.

Arguments

  • mise_a_jour (booléen()) – : Vrai si cet enregistrement fait suite à une suppression (c’est donc une mise à jour)

DashboardEdition.showChart()
Si une analyse et la représentation associée ont été sélectionnées, cette méthode retourne un composant constitué par :

  • La liste des catégories accompagnées d’une case à cocher pour lesquelles on décide ou non d’afficher le graphique

  • Les graphiques instanciés en fonction de la representation par le composant FabriqueRepresentation.

Nous rappelons ici le format des données de la variable this.props.parentApi.data.tableauBordDonnees (disponible dans la documentation de ce comoposant) très souvent sollicitée {

donnees: {
thematique1{
numero_analyse {

id_analysis (identifiant de l’analyse), representation : representation sélectionnée, categories {

categorie1 {titre: titre, categorie: nom de la catégorie, visible: true si la catégorie doit s’afficher false sinon}

}

}

} thematique2: etc.

} metadonnees: {titre: titre du tableau de bord, description: description du tableau de bord} (À préciser par l’utilsiateur.trice)

}

DashboardEdition.toggleCategoriesSelectionForIndicator(groupNumber:, cle_analyse, categorie)
Déclenchée sur événement

Supprime une catégorie aux données du tableau de bord

Arguments

  • groupNumber: (entier()) – Identifiant incrémental de la thématique ou de l’enjeu dans alquelle est située l’analyse

  • cle_analyse (entier()) – : numéro de lo’analyse (identifiant incrémental)

DashboardEdition.updateDashboard(dashboardId)
Déclenchée sur événement

Met à jour un tableau de bord

Arguments

  • dashboardId (entier()) – : identifiant en base du tableau de bord que l’on veut mettre à jour

DashboardEdition.updateIndicatorsNumbersInGroups(groupNumber, newObjectType)
Déclenchée sur événement

Cette fonction sert à mettre à jour le nombre d’indicateurs que comprend une thématique du tableau de bord.

Arguments

  • groupNumber (int()) – : group ID

  • newObjectType (mixed()) – : object type (default: undefined)

DashboardEdition.updateNumbersGroups(nombreThematiques)
Déclenchée sur appel de la fonction ajouterThematique elle-même déclenchée sur événement

Ajoute une thématique aux données du tableau de bord

DashboardList

class DashboardList(props)

Ce composant permet de gérer les tableaux de bords existants

DashboardList.chargerTableauBord(id_tableau_bord:)
Déclenchée sur événement.

Réinitialise la variable this.props.parentApi.data.tableauBordDonnees selon les données du tableau de bord chargé par un.e utilisateur.rice

Arguments

  • id_tableau_bord: (entier()) – identifiant du tableau de bord sélectionné

DashboardList.componentDidUpdate(prevProps, prevState)
Lorsqu’un.e utilisateur.rice déclenche un événement et que la fonction render est lancée à nouveau

on met à jour la liste des tableaux de bord qui doivent figurer dans l’onglet « tableaux de bord ». Cette opération est nécessaire en cas de suppression d’un tableau de bord pour que cette modification soit bien prise en compte lors du rechargement de la liste des tableaux de bord.

DashboardList.duplicateDashboard(dashboard)
Déclenchée sur événement

Duplicate a dashboard

Arguments

  • dashboard (object()) –

DashboardList.formaterDonneesThematiques(donnees)
formate les données au format attendu par le composant TableauBord (nécessaire à

l’initialisation au chargement de this.props.parentApi.data.tableauBordDonnees)

DashboardList.handleShare(event, is_readonly_share)

Called from a form onSubmit event

DashboardList.openSharePopup(row, shareTitle, isReadonlyShare)

Open a popup to type the email addresses

DashboardList.supprimerTableauBord(id_tableau_bord)
Déclenchée sur événement

Supprime un tableau de bord

Arguments

  • id_tableau_bord (entier()) – : identifiant en base du tableau de bord que l’on veut supprimer

DashboardShow

class DashboardShow(props)

Ce composant permet d’afficher un tableau de bord spécifique.

DashboardShow.builtPoiOrAnalysisUrl(currentZoneType, currentZoneId, currentMaille, analysisOrPoiId, theme, isPoi)

This function returns the url to an analysis or a group of POI

DashboardShow.chargerTableauBord(id_tableau_bord:)
Déclenchée sur événement.

Réinitialise la variable this.props.parentApi.data.tableauBordDonnees selon les données du tableau de bord chargé par un.e utilisateur.rice

Arguments

  • id_tableau_bord: (number()) – identifiant du tableau de bord sélectionné

DashboardShow.componentDidUpdate(prevState:)
Cette fonction est appelé lorsque l’état du composant principal change

elle permet d’appeler la fonction saveAsPDF() et de réinitialiser displayPdfVersion

Arguments

  • prevState: – propriétés du composant principal avant le changement

DashboardShow.displayDashboard(finalGraphs, groups)

Display the full graphs dashboard by listing thematical groups first, and then, inside each group, all territorial graphs.

Arguments

  • finalGraphs (array()) – all graphs to display grouped by territory

  • groups (array()) – all groups of graphs to display

Renvoie

JSX tree

DashboardShow.displayTerritoriesNames(zoneInfos)

Display territory or territories names.

Arguments

  • zoneInfos (str()) – current zone name

Renvoie

JSX tree show territory choice

DashboardShow.displayTerritoryChoice()

Display territory or territories names.

Renvoie

JSX tree show territory choice

DashboardShow.formaterDonneesThematiques(données:)
Formate les données au format attendu par le composant TableauBord (nécessaire à

l’initialisation au chargement de this.props.parentApi.data.tableauBordDonnees)

Arguments

  • données: (object()) – données propre à une thématique enregistrée en base de données La structure de ce paramètre est : { id : identifiant titre : titre identifiant_tableau : identifiant du tableau de bord graphiques : [ { identifiant_analyse : identifiant de l’analyse representation: représentation categories { première catégorie { nom : nom de la catégorie (ex : secteurs, energies, usages, type_prod_enr etc.) titre : titre de la catégorie (ex : Par secteurs, Par filières de production etc.) visible : true si on doit l’afficher false sinon } … } }, … ] }

DashboardShow.getComparedTerritoriesFromUrl()

Filter URL to retrieve territories.

DashboardShow.getComparedTerritoriesToUrl()

Create URL sharing territories comparison.

DashboardShow.getGraphsByGroupOneTerritory(currentZoneType, currentZoneId, currentMaille)
Cette fonction retourne la liste de toutes les lignes au sein desquelles se trouvent tous les indicateurs qui

contiennent les différents graphiques (dans le cas où il y en a plusieurs). Il s’agit d’une liste d’éléments html et composants React que la méthode render restitue. Ils sont organisés de telle manière qu’on peut ensuite les mettre facilement en forme selon la structure que le ou la créateur.rice du tableau de bord a définie.

On parcourt dans cette fonction les données d’un tableau de bord organisées dans un objet de la manière suivante { id : identifiant du tableau de bord à restituer,

titre : titre du tableau de bord à restituer, description : sa description, donnée au moment de sa création, data : date de sa création ou de sa dernière mise à jour. thematiques: [

{

id : identifiant de la thématique titre : titre identifiant_tableau : identifiant du tableau de bord graphiques : [

{

identifiant_analyse : identifiant de l’analyse representation: représentation categories {

première catégories {

nom : nom de la catégorie (ex : secteurs, energies, usages, type_prod_enr etc.) titre : titre de la catégorie (ex : Par secteurs, Par filières de production etc.) visible : true si on doit l’afficher false sinon

}

]

]

}

DashboardShow.handlePdfDownload()

This function allows to change the display value when the user clicks on the « export PDF » button.

DashboardShow.removeTerritory(index)

Remove territory from territorial comparison.

Arguments

  • index (number()) – index of territory to remove

DashboardShow.saveAsPdf(callback)

Saving dashboard as PDF file.

DashboardShow.toggleTerritoryComparison(e)

Handle toggling territory comparison.

Arguments

  • e (object()) – event triggered when toggling switch

DashboardShow.trouverTableauBordARestituer()
Cette fonction retourne les données du tableau de bord sélectionné par l’utilisateur.rice

parmi ses tableaux de bord si elle est connectée et qu’elle en a créé et les tableaux de bord disponibles pour le territoire sélectionné

DashboardShow.updateAnalysisSelectedUnit(newUnit)

Check we changed unit and, if new unit is valid (inside available units) for specific graph, changes unit sent to FabriqueRepresentation.

Arguments

  • newUnit (integer()) – new value for selected unit

DetailsPopup

class DetailsPopup(props)

Display a popup on the full screen

How to use?

You can call DetailsPopup by giving it a variable and a callback. Make sure that if you use the variable to trigger showing the popup, you do not forget, in the callback, to remove the forcing. Otherwise, the popup will always be displayed as show props forces displaying the variable over any internal state.

<DetailsPopup
             title="A specific title"
             content={contentVariable}
             show={showPopup}
             emptyMsg="Nothing to show"
             callbackAfterClosing={() => toggleDetailsCell()} />

Examples

See DataHistory Component.

Arguments

  • props (ReactProps()) – Should contain the following elements: * title (string) * content (string) * emptyMsg (string) to be displayed when content is empty * callbackAfterClosing (callable) to be called after closing the window * show (boolean) forces showing the window

DidacticFile

class DidacticFile(props)

This component is used to to display the didactic file

DidacticFile.getDidacticFileData(id)

Get the data for a specific didactic file identified by its ID.

Arguments

  • id (int()) – the didactic file ID

EditeurMarkdown

class EditeurMarkdown()

this function is used to create a text editing div

ErrorPage

class ErrorPage(props)

Handle error page for front.

GenericExportButton

class GenericExportButton()

Allow to export general data using an external callback when send button is clicked.

Use ExportForm so the user can select options (include or not PDF is any PDF is linked, select format between CSV or Excel readable - ie. with right encoding).

Arguments

  • exportFunction (callable()) – The function called when pushing export button

  • methodoPdf (boolean()) – whether a PDF file is associated with current data

GenericExportButton.GenericExportButton

ExportIndicatorButton

class ExportIndicatorButton()

Allow to export an indicator data using API link.

Use ExportForm so the user can select options (include current year if provided or all years, include or not PDF is any PDF is linked, select format between CSV or Excel readable - ie. with right encoding).

Arguments

  • analysisId (number()) –

  • analysisSelectedYear (number()) – L’année actuelle séléctionnée

  • exportYears (string()) – Si spécifié choisi les années à exporter à la place de l’utilisateur

ExportIndicatorButton.ExportIndicatorButton

ExportForm

class ExportForm(props)

Show a modal so the user can select options related to an export.

Options provided go as follow:

  • include current year if provided or all years,

  • include or not PDF is any PDF is linked (thus creating a zip),

  • select format between CSV or Excel readable - ie. with right encoding.

Require a callback function that is called when button is pressed.

Arguments

  • onExport (callable()) – Called when submit button pressed

  • analysisId (number()) –

  • analysisSelectedYear (number()) – Current selected year

  • exportYears (string()) – If specified, user won’t have the choice on years

  • methodoPdf (boolean()) – whether a PDF file is associated with current data

FabriqueRepresentation

class FabriqueRepresentation(props)

This component is used to instantiate a representation component (CircularDiagram, StackedCurves etc.) according to the representation parameter to add in the properties.

FabriqueRepresentation.changeCategorySelection(category, modality)

Update the specific filters currently stored based on selection field.

FabriqueRepresentation.getSpecificCategoryFilters(key)

Get specific rules applying to current graph

Arguments

  • key (string()) – the unique key used to identify current graph in the dashboard

Renvoie

a list of filters

FabriqueRepresentation.insertSpecificCategorySelector(categoriesSettings, filtersInitiated)

Add switch or selection field for specific categories.

FabriqueRepresentation.switchButtonCategory(category, modalities_filtered)

Update the specific filters currently stored based on switch button edited.

Filters

class Filters(props)

This component is used to filter the data sources used to calculate the cartographic data. It manages the home page of the site with the display of the map, graphics, legends and any filters.

FormGenerator

class FormGenerator(props)

This component is used to generate forms for user login

GestionnaireImagesCarousel

class GestionnaireImagesCarousel()

This function collects and displays carousel images

Messages

class Messages(props)

This component is used to display an alert message at the top of the application

PlanActions

class PlanActions(props)

This component is used to manage action plans and contains all the functionalities of the territorial strategy page.

PlanActions.importFile

Data file to import

PlanActions.activatePCAETintegration()

Toggles the PCAET integration, either from ADEME or TerriSTORY. Reinitializes also target trajectories.

PlanActions.chargerParametresStrategies(tableRow)

Callback to update a table

Arguments

  • tableRow (json()) – : current line

PlanActions.exportResults(e)

Export the results inside an excel file from backend

PlanActions.getCheckedActionsCoeffs()

Get the actions coeffs from actions checked in local state element.

Renvoie

an object of checked actions

PlanActions.loadParams(actionsScenario, params, advanced, trajectoires, zone_type, zone_id, description, titre, url)

Load param when the user select a specific scenario, and change display to planActions

Arguments

  • actionsScenario (array()) – the scenario of actions

  • params (array()) – the params used

  • advanced (array()) – the advanced params used

  • trajectoires (array()) – the trajectories used

  • zone_type (string()) – the type of zone

  • zone_id (string()) – the zone ID

  • description (string()) – the description of current plan

  • titre (string()) – the title of current plan

  • url (string()) – the url to use to load data

PlanActions.loadSavedActions()

Load the saved actions

PlanActions.resetCoeffs(e)

Reset all coeffs to default values.

Arguments

  • e (event()) – the event triggered

Renvoie

if the user doesn’t confirm, exits

PlanActions.resetTargetTrajectories(e)

Reset target trajectories.

Arguments

  • e (event()) – the event triggered

Renvoie

if the user doesn’t confirm, exits

PlanActions.saveCanvasAsPng(ref)

Save as png the canvas containing the image

Arguments

  • ref (string()) – the ref to use

PlanActions.tooltipTotal(infos)

Display a customized total tooltip text.

Arguments

  • infos (array()) – the data to display

Renvoie

the string to display in the tooltip

PlanActionsScenarii

class PlanActionsScenarii(props)

Ce composant permet de gérer les scénarios des plans d’actions

PlanActionsTrajectoiresCibles

class PlanActionsTrajectoiresCibles(props)

Ce composant permet de définir et d’afficher les trajectoires cibles. Il génère les trajectoires cibles et qui est appelé dans PlanActions.

PlanActionsTrajectoiresCibles.initTrajectoire()

Get the target trajectory from props and do the linear interpolation on it

PlanActionsTrajectoiresCibles.linearInterpolation(knownX, knownY, newX)

Interpolate Y values corresponding to newX depending on known values TODO: also use this function when changing the trajectory

Arguments

  • knownX (Array()) – X coordinates of known values, sorted in ascending order

  • knownY (Array()) – Y coordinates of known values, array of same length as knownX

  • newX (Array()) – X coordinates of wanted values, sorted in ascending order

Renvoie

Array – Calculated Y values, array of same length as newX

PlanActionsTrajectoiresCibles.saveTrajectoiresCibles(reset)

Call props.saveTrajectoiresCible with the right values and parameters

Profile

class Profile(props)

This component manages the profile of the connected user

Profile.modeAjoutMiseAJourObjectifs

Updates the state of the component with a parameter that defines whether to launch the AjoutObjectif component to add an objective or to update one.

Profile.updateTabDataDidacticFile

Update of the index of the tab to open for the data didactic file (list or edition)

Profile.updateTabDataSource

Update of the index of the tab to open for the data sources logo (list or edition)

Profile.updateTabEquipements

Mise à jour de l’index de l’onglet à ouvrir pour les équipements (liste ou édition)

Profile.updateTabIndicateur

Updates index of tab to open for indicators in edition mode

RegionSelect

class RegionSelect(props)

This component is used to manage the selection page for the different regions

Sankey

class Sankey(props)

This component is used to display the energy flow according to the energy consumption and prod

ZoneSelect

class ZoneSelect(props)

Select a zone from the list given by parentApi.controllers.zonesManager, for any usage. The onSelect callback is called each time a valid zone (type+maille+id) is selected by the user.

This component uses the triplet {zoneType: str, zoneMaille: str, zoneId: str}, not the old format {zone: {zone: str, maille: str}, zoneId: str}.

Arguments

  • props (Object()) –

  • props.zoneType (string()) – Type of default selected zone

  • props.zoneMaille (string()) – Type of default selected maille

  • props.zoneId (string()) – Id of default selected zone

  • props.title (string()) – Title of the selector. Default « Territoire ». Set to «  » to disable

  • props.className (string()) – Additional classNames for styling

  • props.disableMaille (boolean()) – Disable maille selection (set to zoneType)

  • props.parentApi (Object()) –

Renvoie

JSX.Element –

MainZoneSelect

class MainZoneSelect()

Selection component for the main zone: parentApi.data.zone/parentApi.data.currentZone. Override className and containerClassName to change the style; else the main map style will be used (absolute position at top center).

VisualizationSelect

class VisualizationSelect()

This component is used to select an indicator and its display in dashboards.

VisualizationSelect.VisualizationSelect
VisualizationSelect.obtenirTypeObjetApresChangement

Met à jour l’état du composant à partir de l’objet sélectionné

VisualizationSelect.outilDeSelection(options)

Retourne un composant select qui permet de sélectionner un objet et intègre une fonctionnalité de filtre

Arguments

  • options (Liste()) – : liste des choix possibles pour le deuxième menu déroulant Exemple : { 0: Object { code: 1, nom: « Diagramme circulaire » } 1: Object { code: 2, nom: « Courbes empilées » } }

VisualizationSelect.selectionTypeObjet(listeObjetsPremiereSelection)

Cette fonction retourne la liste des balises html <option> à ajouter au premier menu déroulant de sélection d’objet

Arguments

  • listeObjetsPremiereSelection (Liste()) – : liste des objets à ajouter au menu déroulant et à intégrer dans des balises <option> exemple : { 0: Object { id: 1, nom: « Consommation d’énergie », data: « conso_energetique », … } }

MultiLevelSelect

class MultiLevelSelect(props)

This component is used to select an indicator and its display in dashboards.

SEO

class SEO()

SEO component that adds a helmet (title + meta tags) when provided data.

SplashScreen

class SplashScreen(props)

This function displays the Splash Screen

SplashScreen.changementTaillePopUpResponsive(petitEcran)

Updates the size of the divs with the classes « FloatWidget », « ScrollerPageAccueil » and the size of the component « Carousel »

Arguments

  • petitEcran (*()) – : screen size

SplashScreen.suppessionCache()

deletes the cache of the application.

Subscribe

class Subscribe(props)

This component is used to register a new user

SuiviEmissionGes

class SuiviEmissionGes(props)

This function is used to display GES emissions tracking graphs

SuiviEnergetique

class SuiviEnergetique(props)

This component is used to display energy consumption and production tracking graphs

SuiviEnergetique.getPdfSaveButtons(id_analysis, ref, nom)

factorizes the creation of the Save graphic, export and PDF methodo buttons

Arguments

  • id_analysis (*()) – : the id of the current indicator, used to find the name of PDF methodo

  • ref (*()) – : the reference of the part of the code to export

  • nom (*()) – : the name used to save the exported graph

SuiviPolluants

class SuiviPolluants(props)

This function is used to display the pollutant emissions tracking graphs

TerritorialSynthesis

class TerritorialSynthesis(props)

This component is used to manage the rendering of the territorial synthesis table

TerritorialSynthesis.exportData(format, includePDF, resolve)

This function is used to export summary table data to CSV file. The name of the CSV file will be donnees_synthese_territoriale_ZONETYPE_ZONEID.csv.

TerritorialSynthesis.exportPdf()

Export current page in PDF using different sections to divide the table in two parts.