Settings Page Reference

Related documents

• Page Reference
• Card Component Reference

Table of Contents

• Introduction
  • Standard cards
  • Standard settings page
  • Aeronautical cards
  • Standard settings page
• Exported identifiers
  • stdSettingsCards
  • aeroSettingsCards
  • Custom settings cards

Introduction

There Settings page can be composed of customizable cards of content. There are two categories of cards supplied by the system: standard and aeronautical. The application is free to compose a settings page with other cards or to replace standard cards as required.

Cards are identified by an ID string. Each card is represented by an object that contains the following properties:

• computeInfo
• init
• render
• renderHelp
• stateVarInfo
• tipInfo

The values are set the same way as the equivalent properties in a Page. A settings page info object is composed by concatenating the equivalent properties in a list of card IDs plus any custom content. The card objects are provided in one of two objects that contain properties whose key is the card ID: stdSettingsCards and aeroSettingsCards.

There are two default Settings pages provided: a standard page that just contains the standard cards and an aeronautical page that contains both the standard and aeronautical cards.

Standard cards

The standard cards are suitable for inclusion in most apps. They are available in the stdSettingsCards object. The provided card IDs are:

• ui
  A card that allows the user to customize the user interface. The card can enable or disable dark mode, and set whether the tabbed user interface has the menu bar on the top or bottom of the viewport. See the Navigation System Reference
• email
  A card that allows the user to set an email address and cloud sync security word. It also maintains the device GUID. See the Controller Overview.
• developer
  A card that allows a developer to run a self-test, disable saving, and load, unload, or archive trouble reports.
• numericInput
  A card that allows the user to set up the default numeric input type on desktops, phones and tablet device types. The numeric input can be a standard device virtual or physical keyboard, a popup keypad, or a popup thumbwheel.
• trouble
  A card that allows a developer to email feedback, send a trouble report, delete saved input on the device and server, and reset the app input.

Standard settings page

A Settings page that contains only the standard cards is available by importing common/page/stdSettings.js. This is usually done in app.js.

Aeronautical cards

The aeronautical cards are suitable for inclusion in aeronautical apps. They are available in the aeroSettingsCards object. The provided card IDs are:

• units
  A card that allows the user to set the desired units for runway length, altimeter settings, fuel, and weight.
• safety
  A card that allows the user to set desired safety factors.
• unpaved
  A card that allows the user to set default adjustments for runway conditions outside the POH.

Standard settings page

A Settings page that contains both the standard cards and aeronautical cards is available by importing common/page/aeroSettings.js. This is usually done in app.js.

Exported identifiers

stdSettingsCards

Syntax

import {stdSettingsCards} from 'common/page/stdSettingsCards.js';

An object with properties for the standard cards.

aeroSettingsCards

Syntax

import {aeroSettingsCards} from 'common/page/aeroSettingsCards.js';

An object with properties for the aeronautical cards.

Custom settings cards

See common/page/aeroSettingsCards.js for how to combine different cards.