Global

Members

(constant) baseUrlApi

Source:

services/userService.js, line 6

base of the url to access the user api

(constant) chartDimensions

Source:

utils/chartDimensions.js, line 6

adapts the dimensions of the graphic to those of the window

(constant) linkGenerator

Source:

components/pageMenu/linkGenerator.jsx, line 25

generate pageMenu links

(constant) userService

Source:

services/userService.js, line 86

object containing user data collection functions

Methods

addTooltip(svg) → {object}

Source:

components/chart/averageSession.js, line 13

create tooltip to display curve informations

Parameters:

Name	Type	Description
`svg`	object	svg dom object

Returns:

tooltip svg group

Type: object

averageSessions(data, height, svg, width, marginopt)

Source:

components/chart/averageSession.js, line 66

generate user's average sessions chart

Parameters:

Name	Type	Attributes	Description
`data`	array		array of objects with day and sessionLength attributes
`height`	number		chart height
`svg`	object		svg contains chart
`width`	number		chart width
`margin`	object	<optional>	contains attributes : marginTop, marginRight, marginBottom, marginLeft

Chart(data, name) → {object}

Source:

components/chart/index.jsx, line 85

display chart

Parameters:

Name	Type	Description
`data`	array	array of objects with day and sessionLength attributes
`name`	string	chart name

Returns:

GraphicContainer - styled component

Type: object

chartParamManager(chartName) → {object}

Source:

components/chart/index.jsx, line 53

provides charts parameters

Parameters:

Name	Type	Description
`chartName`	string

Returns:

constants - @see getChartConst()

Type: object

dailyActivity(data, height, svg, width, marginopt)

Source:

components/chart/dailyActivity.js, line 35

create user daily activity chart

Example

data : [ { day: <string>, kilogram : <integer>, calories : <integer>}]

Parameters:

Name	Type	Attributes	Description
`data`	array		array of objects containing the data needed for the daily activity graph
`height`	number		chart height
`svg`	object		svg contains chart
`width`	number		chart width
`margin`	object	<optional>	contains attributes : marginTop, marginRight, marginBottom, marginLeft

Error() → {object}

Source:

pages/error/index.jsx, line 54

Component for displaying error message when route does not exist

Returns:

StyledMain -

styled component

Type: object

getByIdApiRequest(userId) → {array}

Source:

services/userService.js, line 14

urls array used to retrieve user data from the API

Parameters:

Name	Type	Description
`userId`	number	identifier of the user whose data is to be recovered

Returns:

api urls array

Type: array

getByIdMocked(userId)

Source:

services/userService.js, line 30

retrieves user data mocked

Parameters:

Name	Type	Description
`userId`	number	user identifier

getChartConst(backgroundColor, chartFunction, containerWidth, height, width, marginTop, marginRight, marginBottom, marginLeft) → {object|object}

Source:

components/chart/index.jsx, line 29

provides the constants needed to create the chart

Example

{ backgroundColor, chartFunction, containerWidth, dimensions }

Parameters:

Name	Type	Description
`backgroundColor`	string	chart container background
`chartFunction`	function	function called to create chart
`containerWidth`	number
`height`	number
`width`	number
`marginTop`	number
`marginRight`	number
`marginBottom`	number
`marginLeft`	number

Returns:

constants

Type

object
constants.dimensions - contains attributes : marginTop, marginRight, marginBottom, marginLeft

Type

object

getDataObject(userInfos, userActivity, userSessions, userKeyData, userPerformance, userScore) → {object}

Source:

services/userService.js, line 50

groups the collected data into an object

Parameters:

Name	Type	Description
`userInfos`	object
`userActivity`	object
`userSessions`	pbject
`userKeyData`	object
`userPerformance`	object
`userScore`	object

Returns:

user data object = { mainData, activity, sessions, keyData, performances, score }

Type: object

getDataObjectApi(userInfos, userActivity, userSessions, userKeyData, userPerformance, userScore) → {object}

Source:

services/userService.js, line 72

retrieves user data model

Parameters:

Name	Type	Description
`userInfos`	object
`userActivity`	object
`userSessions`	pbject
`userKeyData`	object
`userPerformance`	object
`userScore`	object

Returns:

dataObject - @see getDataObject()

Type: object

Source:

components/header/index.jsx, line 36

Component for displaying header page. header containt logo and navigation

Returns:

HeaderStyled - styled component

Type: object

Home() → {object}

Source:

pages/home/index.jsx, line 11

Display home page main element

Returns:

html object

Type: object

PageMenu() → {object}

Source:

components/pageMenu/index.jsx, line 31

Component for displaying lateral page menu

Returns:

MenuSection - styled component

Type: object

performances(data, height, svg, width, marginopt)

Source:

components/chart/performances.js, line 11

generate user's performances chart

Parameters:

Name	Type	Attributes	Description
`data`	array		array of objects with day and sessionLength attributes
`height`	number		chart height
`svg`	object		svg contains chart
`width`	number		chart width
`margin`	object	<optional>	contains attributes : marginTop, marginRight, marginBottom, marginLeft

Profil(idUser, dataFrom) → {object}

Source:

pages/profil/index.jsx, line 44

Component for displaying user activity dashboard

Parameters:

Name	Type	Description
`idUser`	number	user id
`dataFrom`	string	data source : api or mock

Returns:

main dom object

Type: object

score(data, height, svg, width, backgroundColor)

Source:

components/chart/score.js, line 12

generate user score chart

Example

data : 0.17

Parameters:

Name	Type	Description
`data`	number	user score in float format
`height`	number	chart height
`svg`	object	svg contains chart
`width`	number	chart width
`backgroundColor`	string	chart background color

Summary(props) → {object}

Source:

components/summary/index.jsx, line 56

component for displaying summary of user indicators

Parameters:

Name Type Description

props

object

Properties

Name	Type	Description
`calorie`	number	user calorie count
`protein`	number	user protein count
`glucid`	number	user glucid count
`lipid`	number	user lipid count

Returns:

section contain summary

Type: object

summaryItem(name, value) → {object}

Source:

components/summary/index.jsx, line 16

display summary item

Parameters:

Name	Type	Description
`name`	string	summary item name
`value`	number	summary item value

Returns:

summary item dom element

Type: object

topRoundedColumn(x, y, height, width) → {string}

Source:

components/chart/dailyActivity.js, line 12

draw rounded top edges at the bars of the graph

Parameters:

Name	Type	Description
`x`	object	d3 object
`y`	object	d3 object
`height`	number	svg height
`width`	number	svg width

Returns:

coordinates of the drawn element

Type: string

useUserService(userId) → {object|boolean|object|boolean}

Source:

utils/useUserService.jsx, line 21

Retrieves user information

Parameters:

Name	Type	Description
`userId`	integer	user id

Returns:

{isLoading, data, error} contain data request

Type

object
objectReturn.isLoading - data is loading ?

Type

boolean
objectReturn.data = { mainData:

Members

(constant) baseUrlApi

(constant) chartDimensions

(constant) linkGenerator

(constant) userService

Methods

addTooltip(svg) → {object}

Parameters:

Returns:

averageSessions(data, height, svg, width, marginopt)

Parameters:

Chart(data, name) → {object}

Parameters:

Returns:

chartParamManager(chartName) → {object}

Parameters:

Returns:

dailyActivity(data, height, svg, width, marginopt)

Example

Parameters:

Error() → {object}

Returns:

getByIdApiRequest(userId) → {array}

Parameters:

Returns:

getByIdMocked(userId)

Parameters:

getChartConst(backgroundColor, chartFunction, containerWidth, height, width, marginTop, marginRight, marginBottom, marginLeft) → {object|object}

Example

Parameters:

Returns:

getDataObject(userInfos, userActivity, userSessions, userKeyData, userPerformance, userScore) → {object}

Parameters:

Returns:

getDataObjectApi(userInfos, userActivity, userSessions, userKeyData, userPerformance, userScore) → {object}

Parameters:

Returns:

Header() → {object}

Returns:

Home() → {object}

Returns:

PageMenu() → {object}

Returns:

performances(data, height, svg, width, marginopt)

Parameters:

Profil(idUser, dataFrom) → {object}

Parameters:

Returns:

score(data, height, svg, width, backgroundColor)

Example

Parameters:

Summary(props) → {object}

Parameters:

Properties

Returns:

summaryItem(name, value) → {object}

Parameters:

Returns:

topRoundedColumn(x, y, height, width) → {string}

Parameters:

Returns:

useUserService(userId) → {object|boolean|object|boolean}

Parameters:

Returns: