Champs et caractères de remplacement
Un champ se compose d'une expression FPScript qui fournit une valeur ou une chaîne à afficher et d'un formateur qui détermine comment les données doivent être formatées pour le renvoi.
Vous pouvez insérer des champs dans n'importe quel texte, par exemple, dans les étiquettes d'axe, les objets texte, les étiquettes de document, etc. Les valeurs à afficher peuvent être des résultats de calcul, des informations d'en-tête telles qu'un nom d'ensemble de données et une unité physique, ou la date et l'heure actuelles.
Le champ suivant indique, par exemple, la première valeur de la composante X d'un signal à trois chiffres fractionnaires :
%.3f{Signal.x[0]}
Dans cet exemple, Signal.x[0] est l'expression FPScript qui fournit la valeur, et %.3f{...} est le formateur qui détermine que le nombre doit être formaté avec trois chiffres fractionnaires au lieu d'un exposant. Les informations de formatage sont facultatives ici ; le formateur simple %{...} produit tous les types de données dans un format standard. Les valeurs à virgule flottante sont renvoyées en utilisant un nombre de places valides qui peut être défini dans l'onglet Général de la boîte de dialogue Propriétés de la base de données projet FlexPro.
Les champs commencent toujours par le signe %. Par conséquent, si vous voulez insérer un seul signe de pourcentage dans un texte, vous devez taper le signe de pourcentage deux fois pour éviter qu'il ne soit interprété par le formateur. Par exemple :
La probabilité d'erreur est de %{Probability}%%.
Accès aux attributs d'objets dans les champs
Puisque FPScript a un accès complet au modèle d'objet Automation de FlexPro, vous pouvez afficher tous les attributs des objets, également appelés propriétés. Les champs prédéfinis pour l'étiquetage des axes dans les graphiques sont fréquemment utilisés ici, par exemple pour déterminer les noms, les commentaires et les unités des ensembles de données à tracer sur un axe. Les champs FPScript utilisés pour cela peuvent être un peu longs, c'est pourquoi FlexPro utilise des Espaces réservés. Les espaces réservés ont également un formateur, qui est suivi d'un nom au lieu d'un code FPScript. Le texte standard pour étiqueter l'axe Y d'une courbe 2D, par exemple, ressemble à ceci :
%<NameOrQuantityOrComments> %<[Unit]>
FlexPro remplace les deux espaces réservés lorsque le texte est créé à l'aide des champs FPScript suivants :
%{.Data.YValueObject(%<ListElement>).NameOrQuantityOrComments(.Data.YComponent)}
%{ThisFPObject.YAxes(.YAxis).Scaling.CurrentUnitInBrackets(%<YAxisElement>)}
FPScript définit un objet standard, qui peut être activé à l'aide du mot clé optionnel ThisObject. L'expression .Data est donc équivalente à l'expression ThisObject.Data. Lors de l'évaluation de l'étiquette d'axe d'une courbe, ThisObject est une référence à la courbe. Avec ThisFPObject, vous avez accès à l'objet FlexPro, tel que le graphique ou le tableau contenant le champ.
Si une liste contenant plusieurs ensembles de données est attribuée à la courbe, les ensembles de données sont évalués pour chaque élément de la liste. %<ListElement> est un caractère générique qui est remplacé avant l'évaluation par l'indice de l'élément de la liste.
Le tableau suivant précise les objets auxquels ThisObject et ThisFPObject font référence :
Champ contenu dans |
ThisObject pointe vers |
Cet objet de l'OFP pointe vers |
|---|---|---|
Étiquetage d'un axe |
Axe |
Graphique |
Étiquetage de l'axe, étiquetage de la courbe ou entrée de la légende d'une courbe |
Courbe |
Graphique |
Titre de la légende |
Légende |
Graphique |
Étiquette légende des couleurs |
Légende des couleurs |
Graphique 3D |
Titre du tableau colonne |
Tableau colonne |
Tableau colonne |
Titre de colonne dans un tableau colonne |
Colonne tableau |
Tableau colonne |
Titre du tableau cellule |
Tableau cellule |
Tableau cellule |
Cellule dans un tableau cellule |
Cellule |
Tableau cellule |
Objet texte |
Objet texte |
Objet texte |
Étiquette dans un document/graphique |
Étiquette |
Document/graphique |
Espaces réservés pour les champs FPScript
La liste suivante contient des espaces réservés que vous pouvez intégrer aux étiquettes à l'aide du menu déroulant.
La plupart des espaces réservés accèdent aux attributs des objets. La façon dont certains caractères de remplacement fonctionnent dépend du type d'étiquette dans laquelle le caractère de remplacement est utilisé. L'espace réservé %<Comments>, par exemple dans le titre d'une colonne de tableau, fait référence aux commentaires d'un ensemble de données affiché dans la colonne. Si par contre il est utilisé dans un titre de graphique, il fait référence aux commentaires du graphique.
Description |
Texte de substitution |
Utilité |
|---|---|---|
Expression FPScript |
%{ ... } |
Ajoute un champ dans lequel vous pouvez intégrer tout code FPScript. |
Paramètres |
%{ ... .Parameters("Name")} |
La valeur du paramètre Name de l'objet qui contient le caractère de remplacement, ou la valeur du paramètre Name de l'objet de données auquel le caractère de remplacement fait référence. |
Nom de la base de données projet |
%<DatabaseName> |
Le nom de la base de données projet. |
Chemin de la base de données projet |
%<DatabasePath> |
Le nom de la base de données projet, y compris son chemin d'accès sur le disque dur. |
Chemin |
%<Path> |
Le nom de l'objet qui contient l'espace réservé, y compris son chemin dans la base de données projet. |
Nom |
%<Name> |
Le nom de l'objet qui contient l'espace réservé, ou le nom de l'objet de données auquel l'espace réservé fait référence. |
Nom d'élément |
%<ElementName> |
Le nom de l'élément de liste ou de la composante de l'objet de données auquel l'espace réservé fait référence. |
Nom ou commentaires |
%<NameOrComments> |
Pour la composante Y, il s'agit du nom, et pour les autres composantes, il s'agit des commentaires de la composant de l'objet de données auquel l'espace réservé fait référence. |
Nom ou grandeur ou commentaires |
%<NameOrQuantityOrComments> |
Pour la composante Y, il s'agit du nom, et pour les autres composantes, si elles sont présentes, il s'agit de la grandeur physique ; sinon, il s'agit des commentaires de la composante de l'objet de données auquel l'espace réservé fait référence. |
Commentaires |
%<Comments> |
Les commentaires de l'objet qui contient le placeholder, ou les commentaires Y de l'objet de données auquel le placeholder fait référence. |
Commentaires ou nom |
%<CommentsOrName> |
Selon la disponibilité, il s'agit des commentaires ou du nom de l'objet contenant l'espace réservé, ou des commentaires ou du nom de la composante de l'objet de données auquel l'espace réservé fait référence. |
Grandeur, commentaires ou nom |
%<QuantityOrCommentsOrName> |
Selon la disponibilité, il s'agit de la grandeur physique, des commentaires ou du nom de la composante de l'objet de données auquel l'espace réservé fait référence. |
Unité |
%<Unit> |
L'unité physique de la composante de l'objet de données auquel l'espace réservé fait référence. |
[Unit] |
%<[Unit]> |
L'unité physique, entre crochets, de la composante de l'objet de données auquel l'espace réservé fait référence. Si l'unité est vide, aucune parenthèse n'est renvoyée. |
(Unité) |
%<(Unit)> |
L'unité physique, entre parenthèses, de la composante de l'objet de données auquel l'espace réservé fait référence. Si l'unité est vide, aucune parenthèse n'est renvoyée. |
Grandeur |
%<Quantity> |
La grandeur physique de la composante de l'objet de données auquel l'espace réservé fait référence. |
Auteur |
%<Author> |
L'auteur de l'objet de données auquel le placeholder fait référence. |
Date de création |
%<CreationDate> |
La date de création de l'objet qui contient l'espace réservé, ou la date de création de l'objet de données auquel l'espace réservé fait référence. |
Heure de création |
%<CreationTime> |
L'heure de création de l'objet qui contient l'espace réservé, ou l'heure de création de l'objet de données auquel l'espace réservé fait référence. |
Date de modification |
%<ModificationDate> |
La date de dernière modification de l'objet contenant l'espace réservé, ou la date de dernière modification de l'objet de données auquel l'espace réservé fait référence. |
Heure de modification |
%<ModificationTime> |
L'heure de la dernière modification de l'objet contenant le caractère de remplacement, ou l'heure de la dernière modification de l'objet de données auquel le caractère de remplacement fait référence. |
Origine |
%<Origin> |
L'origine de l'objet de données auquel le placeholder fait référence. |
Valeur Z |
%<ZValue> |
Lors de l'affichage d'une série de signaux, il s'agit de la valeur Z attribuée au signal de la série de signaux affichée sous forme de courbe. |
Commentaires Z |
%<ZComments> |
Lors de l'affichage d'une série de signaux, il s'agit des commentaires de la composante Z de l'objet de données auquel le placeholder fait référence. |
Unité Z |
%<ZUnit> |
Lors de l'affichage d'une série de signaux, il s'agit de l'unité physique de la composante Z de l'objet de données auquel l'espace réservé fait référence. |
Unité Z |
%<(ZUnit)> |
Lors de l'affichage d'une série de signaux, il s'agit de l'unité physique, entre crochets, de la composante Z de l'objet de données auquel l'espace réservé se réfère. Si l'unité est vide, aucune parenthèse n'est renvoyée. |
(Unité Z) |
%<(ZUnit)> |
Lors de l'affichage d'une série de signaux, il s'agit de l'unité physique, entre parenthèses, de la composante Z de l'objet de données auquel le placeholder fait référence. Si l'unité est vide, aucune parenthèse n'est renvoyée. |
Date |
%<Date> |
La date à laquelle l'espace réservé a été actualisé pour la dernière fois. |
Heure |
%<Time> |
L'heure à laquelle l'espace réservé a été actualisé pour la dernière fois. |
Nom du dossier |
%<FolderName> |
Le nom du dossier dans la base de données projet avec l'objet qui contient le placeholder. |
Commentaires dossiers |
%<FolderComments> |
Les commentaires du dossier dans la base de données projet avec l'objet qui contient le placeholder. |
Nom du sous-dossier actif |
%<ActiveFolderName> |
Le nom du sous-dossier actif dans le dossier de la base de données projet avec l'objet qui contient le placeholder. |
Commentaires du sous-dossier actif |
%<ActiveFolderComments> |
Les commentaires du sous-dossier actif dans le dossier de la base de données projet avec l'objet qui contient le placeholder. |
Utilisateur |
%<User> |
Le nom de l'utilisateur qui est actuellement connecté sur Windows. |
Chemin du document |
%<DocumentPath> |
Le chemin dans la base de données projet de l'objet conteneur dans lequel se trouve l'objet contenant le placeholder. Dans le cas d'un graphique intégré dans un document ou une feuille de calcul, il s'agit du chemin du document ou de la feuille de calcul ; sinon, il s'agit du chemin du dossier qui contient le graphique. |
Nom du document |
%<DocumentName> |
Le nom de l'objet conteneur dans lequel se trouve l'objet contenant le placeholder. Dans le cas d'un graphique intégré dans un document ou une feuille de calcul, il s'agit du nom du document ou de la feuille de calcul ; sinon, il s'agit du nom du dossier qui contient le graphique. |
Placeholders intégrés
FlexPro utilise également certains espaces réservés qui ne stockent pas le code FPScript :
Texte de substitution |
Description |
Utilisé dans |
Utilité |
|---|---|---|---|
%<DataSet> |
Index de l'ensemble des données |
Étiquette de l'axe, étiquette de la courbe et entrée de la légende pour la courbe 3D |
Représente le numéro de la série de données respective dans la courbe pour laquelle une étiquette d'axe, une étiquette de courbe ou une entrée de légende est créée et est utilisée dans le code FPScript comme un index pour la collection Curve3DDataSets de l'objet Curve3D. |
%<Index> |
Index des séries de données |
Étiquette d'axe, étiquette de courbe et entrée de légende pour une courbe 2D ou 3D. Marqueur sur la courbe 2D ou 3D et coordonnées au curseur. |
Représente le nombre de séries de données respectives dans un ensemble de données 3D pour lesquelles une étiquette est créée. Utilisé dans le texte pour afficher l'index de la série de données ou dans le code FPScript comme variable d'index. |
%<[Index]> |
Indice de la série de données, entre parenthèses |
" |
Comme %<Index>, mais le résultat de renvoi est entre parenthèses. Ce caractère générique ne peut pas être utilisé dans le code FPScript. |
%<ListElement> |
Index des éléments de la liste |
Étiquette d'axe, étiquette de courbe et entrée de légende pour une courbe 2D ou 3D et titre de colonne d'un tableau à colonnes. |
Représente le nombre d'éléments de liste respectifs dans la courbe pour laquelle une étiquette d'axe, une étiquette de courbe ou une entrée de légende est créée. Utilisé dans le code FPScript comme argument pour la propriété ValueObject. |
%<YAxisElement> |
%<YAxisElement> |
Étiquette de l'axe, étiquette de la courbe et entrée de la légende pour la courbe 2D |
Représente le numéro de l'échelle de l'axe Y sur lequel la courbe est affichée et pour lequel une étiquette d'axe, une étiquette de courbe ou une entrée de légende est créée. Utilisé dans le code FPScript comme argument pour la propriété CurrentUnit. |
%<XAxisElement> |
%<XAxisElement> |
" |
Représente le numéro de l'échelle de l'axe X sur lequel la courbe est affichée et pour lequel une étiquette d'axe, une étiquette de courbe ou une entrée de légende est créée. Utilisé dans le code FPScript comme argument pour la propriété CurrentUnit. |
%<YName> |
Nom Y Nom Z |
Étiquette et marqueur de données sur la courbe 2D ou 3D et coordonnées au curseur. |
Les noms des composants individuels du point de données à étiqueter. %<ZName> ne peut être utilisé que dans les courbes 3D. Les noms correspondent au nom de l'ensemble de données (Y) ou aux commentaires pertinents (Y, Z). |
%<YValue> |
Valeur Y Valeur Z |
" |
Les valeurs des composants individuels du point de données à étiqueter. %<ZValue> ne peut être utilisé que dans les courbes 3D. |
%<Y2Value> |
Valeur Y2 Valeur Z2 |
Marqueur de plage sur une courbe 2D ou 3D |
Les valeurs des composantes individuelles du deuxième point de données du marqueur de plage. %<Z2Value> ne peuvent être utilisées que dans les courbes 3D. |
%<YUnit> |
Unité Y Unité Z |
" |
Les unités physiques des composants individuels du point de données à étiqueter. %<ZUnit> ne peut être utilisé que dans les courbes 3D. |
%<DeltaY> |
Delta Y |
Marqueur de distance sur une courbe 2D ou 3D et coordonnées au curseur |
Les valeurs de la différence entre les deux curseurs ou les deux positions du marqueur de distance. %<DeltaZ> ne peut être utilisé que dans les courbes 3D. |
%<DeltaYPerc> |
Delta Y % |
Marqueur de distance sur une courbe 2D ou 3D et coordonnées au curseur |
Les valeurs de la différence entre les deux curseurs ou les deux positions du marqueur de plage en pourcentage, par rapport à la première valeur. %<DeltaZPerc> ne peut être utilisé que dans les courbes 3D. |
%<OrderTrackingName> |
Nom de l'analyse d'ordre |
Marqueur avec ligne d'ordre ou hyperbole de fréquence et coordonnées au curseur dans le spectre vitesse-fréquence ou le spectre d'ordre. |
Produit soit "l'ordre" (spectre vitesse-fréquence), soit "la fréquence" (spectre d'ordre). |
%<OrderTrackingValue> |
Valeur de l'analyse d'ordre |
" |
L'ordre est le rapport entre la vitesse et la fréquence à la position marquée. |
%<OrderTrackingUnit> |
Unité de l'analyse d'ordre |
" |
L'unité de la valeur de l'analyse d'ordre |
%<AreaName> |
Nom de la zone |
Marqueur de plage avec zone sous la courbe comme curseur de marquage |
Renvoi "zone". |
%<AreaValue> |
Valeur de la zone |
" |
Fournit le contenu de l'aire sous la plage de la courbe marquée. |
%<AreaUnit> |
Unité de surface |
" |
L'unité du contenu de la zone. |
%<SlopeName> |
Nom de la pente |
Marqueur de distance avec tangente comme curseur de marquage |
Renvoie "pente". |
%<SlopeValue> |
Valeur de la pente |
" |
Fournit la pente au point marqué de la courbe. |
%<SlopeUnit> |
Unité de pente |
" |
L'unité de la pente. |
%<Length> |
Longueur |
Marqueur de distance avec ligne de dimension |
La longueur de la ligne de cote dans l'unité de la courbe. |
%<DataSetName> |
Nom de l'ensemble de données |
Étiquette de données dans une courbe 2D ou 3D |
Le nom de l'ensemble de données supplémentaire pour l'étiquetage des données. |
%<DataSetValue> |
Valeur de données |
" |
La valeur de l'ensemble de données supplémentaires pour l'étiquetage des données. La valeur est attribuée au point de données à étiqueter. |
%<DataSetUnit> |
Unité de l'ensemble des données |
" |
L'unité de l'ensemble de données supplémentaires pour l'étiquetage des données. |
%<XIndex> |
Indice X |
Étiquette ou marqueur de données |
L'indice de ligne du point de données à étiqueter/marquer. |
%<ZIndex> |
Index Z |
Étiquette ou marqueur de données dans une courbe 3D |
L'indice de colonne du point de données à étiqueter/marquer dans un ensemble de données 3D. |
%<PlotOrder> |
Ordre traçage |
Marqueur dans un graphique |
Les marqueurs sont numérotés en ordre croissant par rapport à l'ordre de la parcelle. Les marqueurs dont l'ordre de tracé est plus important apparaissent au premier plan. Lorsque l'on lit les repères sans les trier, ils sont restitués selon l'ordre de la parcelle. |
%<PageNumber> |
Numéro de page |
Forme "Label" dans le document |
Le numéro de page dans le document où se trouve la forme de l'étiquette. |
%<NumberOfPages> |
Nombre de pages |
Forme "Label" dans le document |
Le nombre de pages du document dans lequel se trouve la forme de l'étiquette. |
%<H1> ... %<H9> |
Compteur de niveaux de contour 1 - 9 |
Forme "Label" dans le document |
La valeur actuelle du compteur pour le niveau de contour correspondant du document. |
%<N> |
Compteur d'étiquettes |
Forme "Label" dans le document |
La valeur actuelle du compteur pour le niveau de contour attribué à l'étiquette. |
Champs pour renvoyer des nombres complexes
Si le jeu de données dont vous souhaitez afficher le contenu contient des nombres complexes, vous pouvez utiliser les fonctions suivantes dans la zone :
Fonction |
Description |
|---|---|
RealPart(DataSet) |
Affiche la partie réelle du nombre complexe dans l'ensemble de données. |
Partie imaginaire(DataSet) |
Affiche la partie imaginaire du nombre complexe dans l'ensemble de données. |
Absolu(DataSet) |
Affiche la valeur absolue du nombre complexe dans l'ensemble de données. |
Phase(DataSet) |
Affiche la phase du nombre complexe dans l'ensemble de données. |
Indexation des valeurs scalaires pour l'affichage
Si l'ensemble de données contenant la valeur à afficher ne contient pas de valeur scalaire, mais plutôt une série de données ou une matrice de données, vous pouvez utiliser un index pour afficher une valeur particulière. Si vous n'utilisez pas d'index, la première valeur est prise. Si vous entrez le nombre -1 comme index, la dernière valeur est toujours prise.
Si l'ensemble de données contient un signal, une série de signaux ou une courbe d'espace, vous pouvez sélectionner le composant souhaité et ajouter .X, .Y ou .Z au nom du composantsouhaité. Si vous ne spécifiez pas de composante, la composante Y est utilisée.
Exemples
%{Signal.Y[10]} |
Affiche la valeur 11 de la composante Y du signal. |
%{Signal.X[-1]} |
Affiche la dernière valeur de la composante X du signal. |
%{DataMatrix[0][10]} |
Affiche la 11ème valeur de la première colonne de la matrice de données. |
%{SignalSeries.Z[%<Index>]} |
Affiche la valeur Z de la série d'une série de signaux affichée sous forme de courbe. |
Champs avec une invite à l'utilisateur
Vous pouvez utiliser des champs spéciaux pour intégrer les invites de l'utilisateur dans le texte. Utilisez cette option pour solliciter l'entrée de l'utilisateur, par exemple, lorsque les documents sont mis à jour pour un affichage ultérieur dans le document.
Il existe deux options pour intégrer une invite utilisateur dans un texte. Vous pouvez soit intégrer une invite utilisateur dans l'expression FPScript d'un champ, comme %{TextInput("Veuillez entrer votre nom")}, soit utiliser un formateur spécial qui demande une entrée, comme %"Enregistreur:\DM2000\MX2000". La deuxième option présente divers avantages. Tout d'abord, vous pouvez spécifier des valeurs par défaut pour les entrées, telles que "DM2000" ou "MX2000". Ceux-ci sont ensuite affichés dans une liste déroulante. Deuxièmement, FlexPro combine plusieurs invites utilisateur intégrées dans le même texte, et troisièmement, FlexPro se souvient des entrées antérieures, de sorte que vous n'avez qu'à saisir les modifications lors des révisions.