Ajouter des complications à un cadran

Une complication de cadran affiche les données issues d'une source de données. Avec le format du cadran, vous pouvez choisir les sources de données pour obtenir les données sous-jacentes. Cela permet à vos cadrans d'afficher des informations au-delà de l'heure de la journée sans avoir besoin de code pour les obtenir.

Utiliser le format de cadran

L'élément Complication vous permet de définir jusqu'à huit complications dans un même cadran. Cet élément vous permet également de définir l'emplacement de chaque complication sur le cadran.

Pour en savoir plus, consultez l'exemple WatchFaceFormat sur GitHub.

Types et champs

Le tableau suivant décrit les types et les champs de l'objet ComplicationData. Si un cadran demande un champ non valide pour un type de complication, une valeur par défaut du champ est renvoyée. Par exemple, si un cadran tente d'accéder à un champ LONG_TEXT dans un type SHORT_TEXT, la valeur par défaut du champ LONG_TEXT, qui est nulle, est renvoyée. Notez que l'affichage des champs facultatifs n'est pas garanti.





Type Champs obligatoires Champs facultatifs Notes
SHORT_TEXT Texte court Icône
Icône de protection contre les brûlures d'écran
Titre court
Description du contenu

 Affiche une seule icône ou un titre court s'ils sont fournis.
MONOCHROMATIC_IMAGE Image monochrome
 Icône de protection contre les brûlures d'écran
Description du contenu

 Utilisée lorsque le texte n'est pas nécessaire. L'icône doit être de couleur unie et peut être teintée par le cadran.
RANGED_VALUE Valeur
Valeur minimale
Valeur maximale
 Image monochrome
Icône de protection contre les brûlures d'écran
Texte court
Titre court
Échelle de couleur
Valeur dynamique
Description du contenu

 Si vous souhaitez dessiner votre propre barre de progression, vous pouvez utiliser la méthode isRangedValueProgressHidden() pour masquer celle qui est fournie par la classe ComplicationDrawable.
GOAL_PROGRESS Valeur
Valeur cible
 Image monochrome
Icône de protection contre les brûlures d'écran
Texte court
Titre court
Échelle de couleur
Valeur dynamique
Description du contenu

 GOAL_PROGRESS est notamment destiné à comptabiliser les pas. Sa valeur commence à zéro et peut dépasser la valeur cible.
LONG_TEXT Texte long
 Titre long
Image monochrome
Icône de protection contre les brûlures d'écran
Petite image
Description du contenu
 Affiche le titre long s'il est fourni.
SMALL_IMAGE Petite image
 Description du contenu
 Une petite image présente l'un des deux styles suivants : style photo ou style icône. Le style de photo signifie que cette image est censée occuper tout l'espace et peut être recadrée. Le style d'icône signifie qu'elle ne peut pas être recadrée, mais qu'elle peut avoir une marge intérieure. La variabilité des images peut entraîner l'affichage d'une image inappropriée en mode Veille sur les appareils dotés d'une protection contre les brûlures ou du mode Veille à faible vitesse de transmission. Lorsque la protection contre les brûlures d'écran et le mode Veille à faible vitesse de transmission sont activés, le cadran peut utiliser la petite image de protection contre les brûlures d'écran, car elle est sans risque. Dans le cas contraire, comme un cadran peut difficilement déterminer l'adéquation d'une image, aucune image ne s'affiche.
LARGE_IMAGE Grande image
 Description du contenu
 Cette image doit être suffisamment grande pour remplir le cadran. La variabilité des images peut entraîner l'affichage d'une image inappropriée en mode Veille sur les appareils dotés d'une protection contre les brûlures ou du mode Veille à faible vitesse de transmission. Étant donné qu'un cadran peut difficilement déterminer si une image est adaptée, celui-ci n'affiche pas d'image en mode Veille si la protection contre les brûlures ou le mode Veille à faible vitesse de transmission sont activés.
WEIGHTED_ELEMENTS Liste d'éléments
 Image monochrome
Icône de protection contre les brûlures d'écran
Texte court
Titre court
Description du contenu
 Chaque élément se compose d'une couleur et d'une pondération (supérieure à zéro). La taille de l'élément au moment de son rendu doit être proportionnelle à sa pondération. Il n'est pas nécessaire que les pondérations soient égales à une valeur particulière une fois additionnées. Notez que les cadrans sont autorisés à changer de couleur les éléments WEIGHTED_ELEMENTS.

Le tableau suivant décrit les types de complications correspondant aux données vides pouvant être envoyées pour n'importe quel emplacement de complication. Ces types n'ont pas de champ et n'ont pas besoin d'être inclus dans une liste de types compatibles. Ils permettent aux cadrans de se différencier dans les trois cas suivants :

  • Aucune source n'a été choisie.
  • L'utilisateur a sélectionné "Vide" pour un emplacement.
  • Une source n'a aucune donnée à envoyer.

Les sources ne peuvent pas envoyer TYPE_EMPTY en réponse à des requêtes de mise à jour. Envoyez plutôt TYPE_NO_DATA.

Type de complication Description
TYPE_NOT_CONFIGURED Envoyé par le système lorsqu'une complication s'active, mais que l'utilisateur n'a pas sélectionné de source et qu'aucune valeur par défaut n'a été définie.

Ne peut pas être envoyé par des sources.

TYPE_EMPTY Envoyé par le système lorsqu'une complication s'active et que l'utilisateur choisit "vide" au lieu d'une source, ou lorsque le cadran ne sélectionne aucune source et ce type de complication par défaut.

Ne peut pas être envoyé par des sources.

TYPE_NO_DATA Envoyé par le système lorsqu'une complication (qui a une source) s'active pour effacer la complication avant que des données réelles ne soient reçues de la source.

Peut être envoyé par des sources si elles n'ont pas de données réelles à envoyer.

Sur certains appareils, les cadrans et les complications doivent utiliser le format de cadran.

Si votre cadran existant utilise la bibliothèque Jetpack Watch Face ou la bibliothèque Wearable Support, les utilisateurs continuent de voir les données de toutes les sources de données dans les complications du cadran sur les appareils suivants:

  • Appareils équipés de Wear OS 4 ou version antérieure
  • Appareils qui reçoivent une mise à niveau OTA vers Wear OS 5

De plus, si votre cadran existant utilise la bibliothèque de cadrans Jetpack ou la bibliothèque Wearable Support et qu'il est installé sur l'un de ces appareils, il peut continuer à recevoir des mises à jour.

Toutefois, sur les nouvelles montres lancées avec Wear OS 5, les cadrans doivent utiliser le Format de cadran. C'est pourquoi nous vous recommandons de passer au format de cadran.