PIE
Voir égalementGestion des Graphiques de type Secteur, Anneau et Pyramide dans l'IHM.
Support WebVue - Non. Renvoie un code d'erreur si exécuté dans ce contexte.
| Mode | Mnémonique | Syntaxe |
| 1 | ADD_DATAPOINT | 1 |
| 2 | REMOVE_POINT, REMOVE_DATAPOINT* | 2 |
| 3 | CLEAR | 3 |
| 4 | GET_COUNT | 3 |
| 5 | SET_COLOR | 4 |
| 6 | SET_VALUE | 5 |
| 7 | LOAD | 6 |
| 8 | COLLECTED_LABEL | 7 |
| 9 | COLLECTED_COLOR | 8 |
| 10 | COLLECTED_THRESH | 9 |
| 11 | RESET_COLLECTED | 3 |
| 12 | EXPLODED_SLICE | 10 |
| 13 | RESET_EXPLODED | 3 |
| 14 | 11 | |
| 15 | COPY_CLIPBOARD | 3 |
| 16 | SAVE_IMAGE | 12 |
| 17 | SET_CHARTTYPE | 13 |
| 18 | SET_3DDISPLAY | 14 |
| 19 | CUSTOM_PROPERTY | 15 |
| 20 | SET_TITLE | 16 |
| 21 | SHOW_LEGEND | 17 |
| 22 | SET_BACKIMAGE | 18 |
| 23 | ADD_VARPOINT | 19 |
| 24 | INSERT_VARPOINT | 20 |
| 25 | INSERT_DATAPOINT | 21 |
| 26 | GET_ITEMTYPE | 2 |
| 27 | SET_VARIABLE | 22 |
| 28 | SET_LEGEND | 23 |
| 29 | SET_TEXT | 24 |
| 30 | SET_TEXTSOURCE | 25 |
| 31 | SET_LEGENDSOURCE | 26 |
| 32 | SET_REFRESHMODE | 27 |
| 33 | SET_REFRESHPERIOD | 28 |
| 34 | SAVE | 6 |
* Le mode REMOVE_DATAPOINT est obsolète et a été remplacé par REMOVE_POINT. REMOVE_DATAPOINT est toujours pris en charge au moment de l'exécution pour une compatibilité descendante.
Pour un graphique en secteur ou en anneau, les modes 8 à 13 sont utilisés pour gérer le regroupement d'un ou plusieurs secteurs en un seul. Ils ne peuvent pas être utilisés avec un graphique pyramide.
Propriétés communes à plusieurs modes
|
Argument |
Définition |
| Window | Nom de la fenêtre contenant le Graphique secteur. Type STR |
| Branch | Branche de la fenêtre contenant le Graphique secteur. Type STR. |
| Identifier | Identifiant du Graphique secteur (dans la fenêtre). Type STR |
| Tooltip | Texte pour une bulle d'aide apparaissant lors du passage de la souris au-dessus de la zone. Type STR. |
| Value | Valeur associée à un segment. Type DOUBLE. |
| Label | Texte du libellé. Type STR |
| LegendText | Texte de la légende. Type STR |
| Variable | Nom d'une variable. Type STR. |
| Index | Position dans la collection des Graphiques secteurs. Type INTEGER |
Syntaxe 1
LongVal = PIE(Mode, Window, Branch, Identity, Value, Label, LegendText [, Tooltip])
Type de retour : LONG
Exécution
|
Mode |
Mnémonique |
Action |
| 1 | ADD_DATAPOINT |
Ajoute un point de données à la fin de la collection. |
Syntaxe 2
LongVal = PIE(Mode, Window, Branch, Identity, Index)
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 2 | REMOVE_DATAPOINT* |
Supprime un point de données de la collection en utilisant l'index fourni. Retour : le nombre de points de données dans la collection, ou 0 en cas d'erreur. |
| 2 | REMOVE_POINT |
Supprime un point de données de la collection en utilisant l'index fourni. Retour : le nombre de points après la suppression, ou 0 en cas d'erreur. |
| 26 | GET_ITEMTYPE | Récupère le type de l'élément à l'index spécifié. Retour : 1 si une valeur, 2 si un nom de variable. |
* Le mode REMOVE_DATAPOINT est obsolète et a été remplacé par REMOVE_POINT. REMOVE_DATAPOINT est toujours pris en charge au moment de l'exécution pour une compatibilité descendante.
Syntaxe 3
LongVal = PIE(Mode, Window, Branch, Identity)
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 3 | CLEAR |
Supprime l'ensemble des points de données de la collection. Retour : 1 si OK, 0 sinon. |
| 4 | GET_COUNT | Retour : le nombre de points de données après la suppression, ou 0 en cas d'erreur. |
| 11 | RESET_COLLECTED | Réinitialise un secteur collecté et affiche les secteurs qui le composaient. Retour : 1 si OK, 0 sinon. |
| 13 | RESET_EXPLODED | Réinitialise tous les secteurs éclatés. Retour : 1 si OK, 0 sinon. |
| 15 | COPY_CLIPBOARD | Copie une image représentant le Graphique secteurs dans le presse-papiers. Retour : 1 si OK, 0 sinon. |
Syntaxe 4
LongVal = PIE(Mode, Window, Branch, Identity, Index, Red, Green, Blue[, Opacity]);
Type de retour : LONG.
|
Argument |
Définition |
| Red,Green,Blue |
Couleur RVB avec trois entiers. Type INTEGER |
| Opacity |
Opacité utilisée pour le mélange alpha. Plage de 0 à 100 %. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
| 5 | SET_COLOR |
Définit la couleur, et optionnellement l'opacité, pour le secteur à l'index donné. Retour : 1 si OK, 0 sinon. |
Syntaxe 5
LongVal =PIE(Mode, Window, Branch, Identity, Index, Value);
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 6 | SET_VALUE |
Insère un élément de type point de donnée à l'index spécifié. Retour : 1 si OK, 0 sinon. |
Syntaxe 6
LongVal = PIE(Mode, Window, Branch, Identity, FilePath);
Type de retour : LONG.
|
Argument |
Définition |
| FilePath |
Soit le nom complet du chemin d'accès à un fichier, soit simplement le nom du fichier lui-même s'il se trouve dans le dossier TP du projet. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 7 | LOAD |
Charge le contenu du Graphique secteurs à partir d'un fichier. Retour : 1 si OK, 0 sinon. |
| 34 | SAVE |
Enregistre le contenu du Graphique secteurs dans un fichier. La source du Graphique secteurs doit être définie à Fichier ou l'instruction échouera. Retour : 1 si OK (contenus enregistrés dans un fichier), 0 sinon. |
Syntaxe 7
LongVal = PIE(Mode, Window, Branch, Identity, Label[, LegendText][, Tooltip]);
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 8 | COLLECTED_LABEL |
Spécifie les textes du libellé, de la légende et de l'info-bulle du secteur regroupé. Si l'argument ToolTip n'est pas défini, l'info-bulle sera identique au texte du libellé. Retour : 1 si OK, 0 sinon. |
Syntaxe 8
IntVal = PIE(Mode, Window, Branch, Identity, Red, Green, Blue[, Opacity]);
Type de retour : LONG.
|
Argument |
Définition |
| Red,Green,Blue |
Couleur RVB avec trois entiers. Type : INTEGER. |
| Opacity |
Opacité utilisée pour le mélange alpha. Plage de 0 à 100 %. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 9 | COLLECTED_COLOR |
Définit la couleur et l'opacité pour le secteur regroupé. Retour : 1 si OK, 0 sinon. |
Syntaxe 9
LongVal = PIE(Mode, Window, Branch, Identity, ThresholdValue[, UsePercent]);
Type de retour : LONG.
|
Argument |
Définition |
| ThresholdValue |
Valeur de seuil sous laquelle les secteurs sont regroupés. Type de retour : LONG. |
| UsePercent | Flag, soit 0 soit 1. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 10 | COLLECTED_THRESH |
Spécifie la valeur de seuil sous laquelle les secteur seront regroupés. Retour : 1 si OK, 0 sinon. |
Syntaxe 10
LongVal = PIE(Mode, Window, Branch, Identity, Index[, Exploded])
Type de retour : LONG.
|
Argument |
Définition |
| Exploded |
Sous-mode. Type INTEGER. 0 = Le segment à l'index donné ne doit plus être éclaté. -1 = Le segment regroupé est éclaté. |
Exécution
|
Mode |
Mnémonique |
Action |
| 12 | EXPLODED_SLICE |
Gère les secteurs éclatés. Retour : 1 si OK, 0 sinon. |
Syntaxe 11
LongVal = PIE(Mode, Window, Branch, Identity[, Orientation][, Printer])
Type de retour : LONG.
|
Argument |
Définition |
| Orientation |
Orientation pour l'impression. Type INTEGER 1 = Paysage. |
| Printer | Nom de l'imprimante. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 14 |
Imprime le graphique sur l'imprimante sélectionnée. Si le nom de l'imprimante est omis, l'imprimante par défaut de Windows est utilisée. Retour : 1 si OK, 0 sinon. |
Syntaxe 12
LongVal = PIE(Mode, Window, Branch, Identity, ImageFile[, ImageFormat])
Type de retour : LONG.
|
Argument |
Définition |
| ImageFile |
Soit le nom du chemin d'accès complet d'un fichier, soit simplement le nom du fichier lui-même s'il se trouve dans le dossier TP du projet. Type STR. |
| ImageFormat |
Format de l'image. Type INTEGER. 1 = Gif 2 = Png |
Exécution
|
Mode |
Mnémonique |
Action |
| 16 | SAVE_IMAGE |
Enregistre une copie du Graphique secteurs en tant qu'image dans le format spécifié. Retour : 1 si OK, 0 sinon. |
Syntaxe 13
LongVal = PIE(Mode, Window, Branch, Identity, ChartType[, Radius])
Type de retour : LONG.
|
Argument |
Définition |
| ChartType |
Type de graphique. Type INTEGER. |
| Radius |
Rayon intérieur de l'anneau. 0 par défaut. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 17 | SET_CHARTTYPE |
Définit l'apparence du graphique, secteur, anneau ou pyramide. Retour : 1 si OK, 0 sinon. |
Syntaxe 14
LongVal = PIE(Mode, Window, Branch, Identity, 3dDisplay)
Type de retour : LONG.
|
Argument |
Définition |
| 3dDisplay |
Indicateur du mode d'affichage. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
| 18 | SET_3DDISPLAY |
Définit l'apparence du graphique, 2D ou 3D. Retour : 1 si OK, 0 sinon. |
Syntaxe 15
LongVal = PIE(Mode, Window, Branch, Identity, Property, PropertyValue)
Type de retour : LONG.
|
Argument |
Définition |
| Property |
Nom de la propriété à modifier. Voir le tableau ci-dessous pour les valeurs possibles. Type STR. |
| PropertyValue | Nouvelle valeur de la propriété. Voir le tableau ci-dessous pour les valeurs possibles. Type INTEGER |
|
Name |
Valeur |
| Palette |
0 = Palette personnalisée 1 à 12 = Palette globale |
| LabelPosition |
0 = Intérieur 1 = Extérieur 2 = Aucun 3 = A l'extérieur, en colonne (Pyramide) |
| LabelFormat |
0 = Texte et valeur 1 = Texte et pourcentage de la valeur 2 = Texte 3 = Valeur 4 = Pourcentage de la valeur |
| LegendFormat |
0 = Texte et valeur 1 = Texte et pourcentage de la valeur 2 = Texte 3 = Valeur 4 = Pourcentage de la valeur |
| Pie_2dStyle |
2d seulement 0 = Par défaut 1 = Convexe 2 = Concave |
| Pie_Radius | 0 à 99 |
| Pie_Angle | 0 à 360 |
| Pyr_ValueType |
0 = Type de valeur Linéaire 1 = Type de valeur Surface |
| Pyr_3dBase |
3d seulement 0 = Base Carré 1 = Base Circulaire |
| Pyr_3dAngle |
3d seulement -10 à 10 |
| Pyr_Gap | 0 à 100 |
| Pyr_Label_InsidePos |
0 = Centre 1 = Haut 2 = Bas |
| Pyr_Label_OutsidePos |
0 – Droite 1 - Gauche |
Exécution
|
Mode |
Mnémonique |
Action |
| 19 | CUSTOM_PROPERTY |
Modifie l'apparence du Graphique secteur à l'aide d'un ensemble de propriétés et de valeurs. Les propriétés préfixées Pie sont applicables aux types de graphique secteur/anneau et celles préfixées Pyr sont applicables au type pyramide. Retour : 1 si OK, 0 sinon. |
Syntaxe 16
LongVal = PIE(Mode, Window, Branch, Identity, Title)
Type de retour : LONG.
|
Argument |
Définition |
| Title |
Titre du graphique. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 20 | SET_TITLE |
Définit le titre principal du graphique secteur. Retour : 1 si OK, 0 sinon. |
Syntaxe 17
LongVal = PIE(Mode, Window, Branch, Identity, Show)
Type de retour : LONG.
|
Argument |
Définition |
| Show |
Flag. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
| 21 | SHOW_LEGEND |
Montre ou cache la légende. Retour : 1 si OK, 0 sinon. |
Syntaxe 18
LongVal = PIE(Mode, Window, Branch, Identity, Path[, Area[, WrapMode[, Position]]])
Type de retour : LONG.
|
Argument |
Définition |
| Path |
Chemin complet du fichier image. Type STR. |
| Area |
Position de l'image. Type INTEGER 1 = Zone de légende 2 = Zone de bordure 3 = Zone de graphique entière |
| WrapMode |
Mode d'affichage de l'image. Type INTEGER 1 = Mosaïque |
| Position |
Position de l'image lors d'un affichage en taille réelle. 1 = Gauche 2 = Droite 3 = Bas 4 = Bas gauche |
Exécution
|
Mode |
Mnémonique |
Action |
| 22 | SET_BACKIMAGE |
Affiche une image en fond de plan du Graphique secteur. Retour : 1 si OK, 0 sinon. |
Syntaxe 19
LongVal = PIE(Mode, Window, Branch, Identity, Variable, Label, LegendText[, Tooltip])
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 23 | ADD_VARPOINT |
Ajoute un élément de type variable (nom de variable) à la fin de la collection. Retour : 1 si OK, 0 sinon. |
Syntaxe 20
LongVal = PIE(Mode, Window, Branch, Identity, Index, Variable, Label, LegendText[, Tooltip])
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 24 | INSERT_VARPOINT |
Insère un élément de type variable (nom de variable) à l'index spécifié. Retour : 1 si OK, 0 sinon. |
Syntaxe 21
LongVal = PIE(Mode, Window, Branch, Identity, Index, Value, Label, LegendText[, Tooltip])
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 25 | INSERT_DATAPOINT |
Insère un élément de type point de donnée à l'index spécifié. Retour : 1 si OK, 0 sinon. |
Syntaxe 22
LongVal = PIE(Mode, Window, Branch, Identity, Index, Variable)
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 27 | SET_VARIABLE |
Définit le nom de la variable pour l'index donné. Possible uniquement sur les éléments de type variable. Retour : 1 si OK, 0 sinon. |
Syntaxe 23
LongVal = PIE(Mode, Window, Branch, Identity, Index, LegendText)
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 28 | SET_LEGEND |
Définit le texte du libellé à l'index donné. Retour : 1 si OK, 0 sinon. |
Syntaxe 24
LongVal = PIE(Mode, Window, Branch, Identity, Index, Label)
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 29 | SET_TEXT |
Définit le texte de la légende à l'index donné. Retour : 1 si OK, 0 sinon. |
Syntaxe 25
LongVal = PIE(Mode, Window, Branch, Identity, Index, SourceType)
Type de retour : LONG.
|
Argument |
Définition |
| SourceType |
Source du texte. Type INTEGER 1 = Nom de variable 2 = Description de variable |
Exécution
|
Mode |
Mnémonique |
Action |
| 30 | SET_TEXTSOURCE |
Définit le type de source pour le texte de l'élément variable à l'index donné. Retour : 1 si OK, 0 sinon. |
Syntaxe 26
LongVal = PIE(Mode, Window, Branch, Identity, Index, SourceType)
Type de retour : LONG.
|
Argument |
Définition |
| SourceType |
Source de la légende. Type INTEGER 1 = Nom de variable 2 = Description de variable |
Exécution
|
Mode |
Mnémonique |
Action |
| 31 | SET_LEGENDSOURCE |
Positionne le type de source pour la légende de l'élément variable à l'index donné. Retour : 1 si OK, 0 sinon. |
Syntaxe 27
LongVal = PIE(Mode, Window, Branch, Identity, Index, RefreshMode)
Type de retour : LONG.
|
Argument |
Définition |
| RefreshMode |
Mode de rafraîchissement des éléments variables. Type INTEGER 1 = Rafraîchissement sur changement de valeur d'une variable |
Exécution
|
Mode |
Mnémonique |
Action |
| 32 | SET_REFRESHMODE |
Définit le mode de rafraîchissement des éléments de type variable. Retour : 1 si OK, 0 sinon. |
Syntaxe 28
LongVal = PIE(Mode, Window, Branch, Identity, Index, RefreshPeriod)
Type de retour : LONG.
|
Argument |
Définition |
| RefreshPeriod |
Période de rafraîchissement. Plage 2 à 3600 (en secondes). Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 33 | SET_REFRESHPERIOD |
Définit la période de rafraîchissement des éléments de type variable. Retour : 1 si OK, 0 sinon. |