PopupTemplate class
Modèle de disposition pour une fenêtre contextuelle.
Propriétés
content | Chaîne HTML pour le contenu principal de la fenêtre contextuelle qui contient des espaces réservés pour les propriétés de la fonctionnalité pour laquelle il est affiché. Les espaces réservés peuvent être au format « {propertyName} » ou « {propertyName/subPropertyName} ». |
date |
Si la propriété est un objet de date, ces options spécifient la façon dont elle doit être mise en forme lorsqu’elle est affichée. Utilise Date.toLocaleString. Si elle n’est pas spécifiée, les dates sont converties en chaînes à l’aide de Date.toISOString |
detect |
Spécifie si les liens hypertexte et les adresses e-mail doivent automatiquement être détectés et rendus en tant que liens cliquables.
Valeur par défaut : |
fill |
Couleur d’arrière-plan du modèle contextuel. |
hyperlink |
Options de format pour les chaînes de lien hypertexte. |
number |
Si la propriété est un nombre, ces options spécifient la façon dont elle doit être mise en forme lorsqu’elle est affichée. Utilise Number.toLocaleString. |
sandbox |
Spécifie si le contenu doit être encapsulé avec un iframe en bac à sable. Sauf si la valeur est définie explicitement sur false, le contenu est mis en bac à sable dans un iframe par défaut. Lorsqu’il est activé, tout le contenu est encapsulé dans un iframe en bac à sable avec des scripts, des formulaires, un verrou de pointeur et une navigation supérieure désactivées. Les fenêtres contextuelles sont autorisées afin que les liens puissent être ouverts dans une nouvelle page ou un nouvel onglet. Les navigateurs plus anciens qui ne prennent pas en charge le paramètre srcdoc sur les iframes sont limités au rendu d’une petite quantité de contenu. |
single |
Si une description est disponible, elle est écrite en tant que contenu plutôt qu’en tant que table de propriétés.
Valeur par défaut : |
text |
Couleur de texte par défaut du modèle contextuel. |
title | Chaîne HTML pour le titre de la fenêtre contextuelle qui contient des espaces réservés pour les propriétés de la fonctionnalité pour laquelle il est affiché. Les espaces réservés peuvent être au format « {propertyName} » ou « {propertyName/subPropertyName} ». |
Méthodes
apply |
Génère du contenu contextuel en appliquant un modèle à un ensemble de propriétés.
Si aucun modèle n’est spécifié, |
Détails de la propriété
content
Chaîne HTML pour le contenu principal de la fenêtre contextuelle qui contient des espaces réservés pour les propriétés de la fonctionnalité pour laquelle il est affiché. Les espaces réservés peuvent être au format « {propertyName} » ou « {propertyName/subPropertyName} ».
content?: string | PropertyInfo[] | Array<string | PropertyInfo[]>
Valeur de propriété
string | PropertyInfo[] | Array<string | PropertyInfo[]>
dateFormat
Si la propriété est un objet de date, ces options spécifient la façon dont elle doit être mise en forme lorsqu’elle est affichée. Utilise Date.toLocaleString. Si elle n’est pas spécifiée, les dates sont converties en chaînes à l’aide de Date.toISOString
dateFormat?: DateTimeFormatOptions
Valeur de propriété
DateTimeFormatOptions
detectHyperlinks
Spécifie si les liens hypertexte et les adresses e-mail doivent automatiquement être détectés et rendus en tant que liens cliquables.
Valeur par défaut : true
detectHyperlinks?: boolean
Valeur de propriété
boolean
fillColor
Couleur d’arrière-plan du modèle contextuel.
fillColor?: string
Valeur de propriété
string
hyperlinkFormat
Options de format pour les chaînes de lien hypertexte.
hyperlinkFormat?: HyperLinkFormatOptions
Valeur de propriété
numberFormat
Si la propriété est un nombre, ces options spécifient la façon dont elle doit être mise en forme lorsqu’elle est affichée. Utilise Number.toLocaleString.
numberFormat?: NumberFormatOptions
Valeur de propriété
NumberFormatOptions
sandboxContent
Spécifie si le contenu doit être encapsulé avec un iframe en bac à sable. Sauf si la valeur est définie explicitement sur false, le contenu est mis en bac à sable dans un iframe par défaut. Lorsqu’il est activé, tout le contenu est encapsulé dans un iframe en bac à sable avec des scripts, des formulaires, un verrou de pointeur et une navigation supérieure désactivées. Les fenêtres contextuelles sont autorisées afin que les liens puissent être ouverts dans une nouvelle page ou un nouvel onglet. Les navigateurs plus anciens qui ne prennent pas en charge le paramètre srcdoc sur les iframes sont limités au rendu d’une petite quantité de contenu.
sandboxContent?: boolean
Valeur de propriété
boolean
singleDescription
Si une description est disponible, elle est écrite en tant que contenu plutôt qu’en tant que table de propriétés.
Valeur par défaut : true
singleDescription?: boolean
Valeur de propriété
boolean
textColor
Couleur de texte par défaut du modèle contextuel.
textColor?: string
Valeur de propriété
string
title
Chaîne HTML pour le titre de la fenêtre contextuelle qui contient des espaces réservés pour les propriétés de la fonctionnalité pour laquelle il est affiché. Les espaces réservés peuvent être au format « {propertyName} » ou « {propertyName/subPropertyName} ».
title?: string
Valeur de propriété
string
Détails de la méthode
applyTemplate(Properties, PopupTemplate)
Génère du contenu contextuel en appliquant un modèle à un ensemble de propriétés.
Si aucun modèle n’est spécifié, title
ou name
que les propriétés sont utilisées comme secours pour le titre si disponible.
Pour le contenu, une description
propriété sera utilisée ou toutes les propriétés seront converties en table.
static function applyTemplate(prop: Properties, template?: PopupTemplate): HTMLElement
Paramètres
- prop
- Properties
L’objet propriétés génère le contenu contextuel à partir duquel il est généré.
- template
- PopupTemplate
Modèle à appliquer.
Retours
HTMLElement