Default UI - Elements
In the previous section we talked about the Defaul UI as whole.
In this section we’ll break down each element of the Default UI, their names and purposes.
Distance Indicator
Purpose:
Informs the user about the distance from the device to the tire.
Possible states are "Move away" - Red, "Move closer" - Red, "Distance OK" - Green.
Class type:
DistanceIndicatorConfig
Properties:
| Name | Summary |
|---|---|
textMoveAway |
Text displayed when the user needs to move away from the tire. Default value is "Move away". |
textMoveCloser |
Text displayed when the user needs to move closer to the tire. Default value is "Move closer". |
textOk |
Text displayed when the user is correctly positioned to scan the tire. Default value is "Distance OK". |
visible |
Determines the visibility status. Default value is true. |
Focus Point Tooltip
Purpose:
Instructs the user on how to move the device in order to find a surface to scan.
Class type:
FocusPointTooltipConfig
Properties:
| Name | Summary |
|---|---|
text |
Text displayed when the focus has not yet been found. Default value is "Move your device slowly back and forth to detect the tire.". |
smallText |
Small text displayed above the bold caption, when the focus has not yet been found. Default value is "Initializing tire detection…". |
visible |
Determines the visibility status. Default value is true. |
Tap to Start Scanning Tooltip
Purpose:
Once the device is correctly positioned, informs the user that they can tap the screen to start scanning.
Class type:
TapToStartScanningTooltipConfig
Properties:
| Name | Summary |
|---|---|
textOk |
Text displayed when the user can start the scan process. Default value is "Tap to start recording". |
textNotOkMetric |
Text displayed when the user needs to move the device to the correct distance. Default value is "Hold your phone around 20cm from the tire to start.". |
textNotOkImperial |
Text displayed when the user needs to move the device to the correct distance. Default value is "Hold your phone around 8in from the tire to start.". |
visible |
Determines the visibility status. Default value is true. |
Tire Overlay
Purpose:
Helps the user correctly position their device by displaying a tire overlay which should aligned with the tire to be scanned.
Class type:
TireOverlayConfig
Properties:
| Name | Summary |
|---|---|
visible |
Determines the visibility status. Default value is true. |
Upload View
Purpose:
Informs the user that the upload process is currently in progress.
Class type:
UploadViewConfig
Properties:
| Name | Summary |
|---|---|
text |
Text displayed to inform that the upload is currently in progress. Default value is "Uploading…". |
visible |
Determines the visibility status. Default value is true. |
Abort Button
Purpose:
At any point in time, enables the user to abort the scan process.
Triggers the onScanAbort(uuid: String?) callback, which has to be handled by the integrator.
| Not customizable |
Orientation Warning
Purpose:
This UI element is shown when the user is holding the device in portrait mode. It signalises to reorient the device to landscape mode for an optimal scan experience.
Class type:
OrientationWarningConfig
Properties:
| Name | Summary |
|---|---|
text |
Text displayed to inform the user about the correct orientation of the device. Default value is "Rotate your device horizontally". |
visible |
Determines the visibility status. Default value is true. |
Countdown
Purpose:
This UI element is shown as soon as the scan starts and shows the remaining time until the process finishes.
Class type:
CountdownConfig
Properties:
| Name | Summary |
|---|---|
visible |
Determines the visibility status. Default value is true. |
Scan Direction
Purpose:
This UI element is shown as soon as the scan starts and shows the direction the user has to move the device for an optimal scan result.
Class type:
ScanDirectionConfig
Properties:
| Name | Summary |
|---|---|
visible |
Determines the visibility status. Default value is true. |
Tire Width Input
Purpose:
This UI element is shown as soon as the scan starts and enables the user to enter the width of the tire, if one hasn’t been provided yet
Class type:
TireWidthInputConfig
Properties:
| Name | Summary |
|---|---|
visible |
Determines the visibility status. Default value is true. |
skipButtonText |
Text displayed for the "Skip" button. Default value is "Skip". |
titleText |
Text displayed as the title of this screen. Default value is "Tire Width". |
explanationText |
Text displayed as a short explanation of the screen. Default value is "Choose the Tire Width from the options or enter manually.". |
continueButtonText |
Text for the "Continue" button. Default value is "Continue". |