Canvas - home

Description

Serves as a landing screen for users where summary profile information and links to the key sections of the application are provided.

Example

Figure 1: the home canvas

Default Navigation Section

Home

Requires Authentication

Yes

Sections

Name Description
currentweight Display the user's current weight (shows "-" if not authenticated or if there is no current weight set)
goalweight Display the user's goal weight (shows "-" if not authenticated or if there is no goal weight set)
search A search input text box for performing food searches
startweight Display the user's start weight (shows "-" if not authenticated or if there is no start weight set)
todayskcalburned A link to today's Exercise Diary with the text as the number of calories burned today (shows "add entry" if not authenticated or if there are no entries today)
todayskcaleaten A link to today's Food Diary with the text as the number of calories consumed today (shows "add entry" if not authenticated or if there are no entries today)
yesturdayskcalburned A link to yesturdays's Exercise Diary with the text as the number of calories burned yesturday (shows "add entry" if not authenticated or if there are no entries yesturday)
yesturdaykcaleaten A link to yesturdays's Food Diary with the text as the number of calories consumed yesturday (shows "add entry" if not authenticated or if there are no entries yesturday)

Optional setCanvas Parameters

None

Related REST API Calls

Related Canvases

Diagram

Figure 2: the home canvas dissected
FatSecret Sites
For Developers

For Professionals

For Everyone

FatSecret Platform API

Support
API

About FatSecret

© 2021 FatSecret. All rights reserved.