Namespace: AverageSession

AverageSession() → {JSX.Element}

Component that displays a chart showing the average sessions.

Properties

Name Type Description

sessionData

Object

The props passed to the component.

Properties

Name	Type	Description
`isLoading`	boolean	False if all the data have been fetched
`data`	Array.<object>	An array of objects containing data for the chart. `{day: string, sessionLength: number}`
`data[].day`	string	Day of the week of the activity
`data[].sessionLength`	number	Length of the activity

Author: Pierre-Yves Léglise
Source: components/averageSession/index.jsx, line 32
See: https://recharts.org/en-US/api/LineChart for further information on `LineChart` element from recharts api

Returns:

A JSX element containing a LineChart element from the recharts library.

Type:: JSX.Element

Example

const userSessions = {isLoading: false, data[{day:1, sessionLength: 30},...]}
return (
 <AverageSession sessionData={userSessions} />
)

Methods

(inner) LegendSession() → {JSX.Element}

Displays a custom legend for a chart.

Source: components/averageSession/index.jsx, line 63

Returns:

A JSX element representing the custom legend.

Type:: JSX.Element

(inner) TooltipSession() → {null|JSX.Element}

Displays a custom tooltip for a chart.

Properties

Name	Type	Description
`active`	boolean	Whether or not the tooltip is active.
`payload`	Array	An array of objects containing data for the chart.

Author: Pierre-Yves Léglise
Source: components/averageSession/index.jsx, line 47

Returns:

A JSX element representing the custom tooltip. If the active property is true and the payload array exists and is not empty, the element is a list element containing the text returned by the TooltipText function.

Type:: null | JSX.Element

Example

return{
 <TooltipSession />
}