CHART
Gère le fonctionnement d'un graphique XY dans l'IHM.
Support WebVue - Non. Renvoie un code d'erreur si exécuté dans ce contexte.
| Mode | Mnémonique | Syntaxe |
| 1 | AXE_SETRANGE | 1 |
| 2 | AXE_SETTITLE | 2 |
| 3 | LINE_CLEAR | 3 |
| 4 | LINE_START | 4 |
| 5 | LINE_END | 4 |
| 6 | 5 | |
| 7 | RANGE_ADDPOINT | 6 |
| 8 | RANGE_CLEAR | 7 |
| 9 | RANGE_REMOVEPOINT | 8 |
| 10 | REFRESH | 9 |
| 11 | SERIES_ADDPOINT | 10 |
| 12 | SERIES_CLEAR | 11 |
| 13 | SERIES_GETCOUNT | 11 |
| 14 | SERIES_GETTS | 12 |
| 15 | SERIES_GETXVALUE | 12 |
| 16 | SERIES_GETYVALUE | 12 |
| 17 | SERIES_IDXFROMX | 28 |
| 18 | SERIES_IDXFROMXY | 14 |
| 19 | SERIES_REMOVEPOINT | 27 |
| 20 | SERIES_SETVAR | 15 |
| 21 | SERIES_SHOW | 16 |
| 22 | SERIES_SORT | 11 |
| 23 | SERIES_STATS | 17 |
| 24 | SERIES_YCOUNTFROMX | 18 |
| 25 | SERIES_YVALUEFROMX | 13 |
| 26 | SETDATETIME | 19 |
| 27 | SETENDTIMEPERIOD | 20 |
| 28 | SETSTARTTIMEPERIOD | 21 |
| 29 | SETSAMPLEPERIOD | 22 |
| 30 | SETSOURCEVAR | 23 |
| 31 | SETTITLE | 24 |
| 32 | SERIES_TOFRONT | 11 |
| 33 | COPY_CLIPBOARD | 9 |
| 34 | SAVE_IMAGE | 25 |
| 35 | SHOW_LEGEND | 26 |
Arguments communs à tous les modes
|
Argument |
Définition |
| Window | Nom de la fenêtre contenant le graphique. Type STR |
| Branch | Branche de la fenêtre contenant le graphique. Type STR. |
| Identifier | Identifiant du graphique (dans la fenêtre). Type STR. |
Syntaxe 1
LongVal = CHART (Mode, Window, Branch, Identifier, Axis, Min, Max);
Type de retour : LONG.
|
Argument |
Définition |
| Axis |
Nombre représentant l'axe à modifier. Type de retour : LONG. 1 = X 2 = Y (Gauche) 3 = Y (Droit) |
| Min | Nouvelle valeur minimum pour l'axe. Type DOUBLE. |
| Max | Nouvelle valeur maximum pour l'axe. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 1 | AXE_SETRANGE |
Positionne la plage de l'axe. Si 0 est utilisé pour max et min, la plage est positionnée automatiquement. |
Syntaxe 2
LongVal = CHART (Mode, Window, Branch, Identifier, Axis, Title);
Type de retour : LONG.
|
Argument |
Définition |
| Axis |
Nombre représentant l'axe à modifier. Type de retour : LONG. 1 = X 2 = Y (à gauche) 3 = Y (à droite) |
| Title | Nouveau titre de l'axe. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 2 | AXE_SETTITLE |
Positionne le titre de l'axe. Retour : 1 si OK, 0 sinon. |
Syntaxe 3
LongVal = CHART (Mode, Window, Branch, Identifier, LineID);
Type de retour : LONG.
|
Argument |
Définition |
| LineID |
Identifiant de l'objet Ligne. Soit 1, soit 2. Type de retour : LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
| 3 | LINE_CLEAR |
Efface l'objet Ligne. Retour : 1 si OK, 0 sinon. |
Syntaxe 4
LongVal = CHART (Mode, Window, Branch, Identifier, LineID, X, Y);
Type de retour : LONG.
|
Argument |
Définition |
| LineID |
Identifiant de l'objet Ligne. Soit 1, soit 2. Type de retour : LONG. |
| X, Y |
Nouvelles coordonnées X et Y. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 4 | LINE_END |
Positionne de nouvelles coordonnées pour le point de fin de la ligne. |
| 5 | LINE_START | Positionne de nouvelles coordonnées pour le point de départ de la ligne. |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 5
LongVal = CHART (Mode, Window, Branch, Identifier [, Orientation [, Printer]]);
Type de retour : LONG.
|
Argument |
Définition |
| Orientation |
Orientation de l'impression. Optionnel. Type de retour : LONG. 1 = Paysage 2 = Portrait |
| X, Y |
Nom de l'imprimante à utiliser pour l'impression. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 6 |
Imprime le graphique sur l'imprimante sélectionnée. Retour : 1 si OK, 0 sinon. |
Syntaxe 6
LongVal = CHART (Mode, Window, Branch, Identifier, RangeID, X, YLow, YHigh);
Type de retour : LONG.
|
Argument |
Définition |
| RangeID |
Identifiant de l'objet Range. Soit 1, soit 2. Type LONG. |
| X |
Valeur X du point. Type DOUBLE. |
| YLow | La valeur Y basse du point. Type DOUBLE. |
| YHigh | La valeur Y haute du point. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 7 | RANGE_ADDPOINT |
Ajoute un point à l'objet Range. Retour : 1 si OK, 0 sinon. |
Syntaxe 7
LongVal = CHART (Mode, Window, Branch, Identifier, RangeID);
Type de retour : LONG.
|
Argument |
Définition |
| RangeID |
Identifiant de l'objet Range. Soit 1, soit 2. Type de retour : LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
| 8 | RANGE_CLEAR |
Efface l'objet Range. Retour : 1 si OK, 0 sinon. |
Syntaxe 8
LongVal = CHART (Mode, Window, Branch, Identifier, RangeID, Index);
Type de retour : LONG.
|
Argument |
Définition |
| RangeID |
Identifiant de l'objet Range. Soit 1, soit 2. Type de retour : LONG. |
| Index | Index basé sur zéro du point à supprimer. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 9 | RANGE_REMOVEPOINT |
Supprime un point de l'objet Range. Retour : 1 si OK, 0 sinon. |
Syntaxe 9
LongVal = CHART (Mode, Window, Branch, Identifier);
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 10 | REFRESH |
Rafraîchit le graphique en ré-exécutant la requête d'historique. |
| 33 | COPY_CLIPBOARD |
Copie une image représentant le graphique vers le presse-papier pour de futures utilisations (Word etc.). |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 10
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, X, Y [, TS]);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| X | Valeur X du point. Type DOUBLE. |
| Y | Valeur Y du point. Type DOUBLE. |
| TS | Horodate du point. Optionnel. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 11 | SERIES_ADDPOINT |
Ajoute un point à la série. Retour : 1 si OK, 0 sinon. |
Syntaxe 11
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
| 12 | SERIES_CLEAR |
Efface la série. Retour : 1 si OK, 0 sinon. |
| 13 | SERIES_GETCOUNT |
Retourne le nombre de points dans la série. Retour : Le nombre de points dans la série si aucune erreur, -1 sinon. Renvoie 0 si exécuté en contexte WebVue. |
| 22 | SERIES_SORT |
Trie la série selon l'axe des X. Retour : 1 si OK, 0 sinon. |
| 32 | SERIES_TOFRONT |
Positionne la série au premier plan du graphique. Retour : 1 si OK, 0 sinon. |
Syntaxe 12
DblVal = CHART (Mode, Window, Branch, Identifier, SeriesID, Index);
Type de retour : DOUBLE.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| Index | Index basé sur zéro du point. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 14 | SERIES_GETTS |
Obtient l'horodate du point. Retour : La valeur de l'horodate si OK, - 1 si l'index est hors plage, 0 pour toutes les autres erreurs. |
| 15 | SERIES_GETXVALUE |
Obtient la valeur X du point. Retour : La valeur X si OK, - 1 si l'index est hors plage, 0 pour toutes les autres erreurs. |
| 16 | SERIES_GETYVALUE |
Obtient la valeur Y du point. Retour : La valeur Y si OK, - 1 si l'index est hors plage, 0 pour toutes les autres erreurs. |
Syntaxe 13
DblVal = CHART (Mode, Window, Branch, Identifier, SeriesID, X [, Rank]);
Type de retour : DOUBLE.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| X | Valeur X donnée. Type DOUBLE. |
| Rank | Rang du point avec la valeur X. Optionnel. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 25 | SERIES_YVALUEFROMX | Retourne la valeur Y si le point existe, - 1 si le point n'existe pas, 0 pour toutes les autres erreurs. |
Syntaxe 14
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, X, Y [, IndexStart [,IndexEnd]]);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| X | Valeur X donnée. Type DOUBLE. |
| Y | Valeur Y donnée. Type DOUBLE. |
| IndexStart | Index de début de la requête. Type DOUBLE. |
| IndexEnd | Index de fin de la requête. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 18 | SERIES_IDXFROMXY |
Retourne l'index du point s'il existe, - 1 si le point n'existe pas, 0 pour toutes les autres erreurs. |
Syntaxe 15
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, VarName);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| VarName | Nom d'une variable de l'arbre des variables. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 20 | SERIES_SETVAR |
Modifie la variable utilisée comme source de la série. Retour : 1 si OK, 0 sinon. |
Syntaxe 16
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, Show);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| Show |
Flag pour montrer ou cacher. 1 = Afficher 0 = Masquer |
Exécution
|
Mode |
Mnémonique |
Action |
| 21 | SERIES_SHOW |
Montre ou cache la série. Retour : 1 si OK, 0 sinon. |
Syntaxe 17
DblVal = CHART (Mode, Window, Branch, Identifier, SeriesID, Stats);
Type de retour : DOUBLE.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| Show |
Flag pour sélectionner la statistique à retourner : 1 = X minimum 2 = X maximum 3 = Y minimum 4 = Y maximum 5 = Moyenne 6 = Médian |
Exécution
|
Mode |
Mnémonique |
Action |
| 23 | SERIES_STATS |
Calcul des données statistiques. Retour : La statistique valeur statistique demandée ou 0 en cas d'erreur. |
Syntaxe 18
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, X);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant de la série. Plage de 1 à 8. Type de retour : LONG. |
| X |
Valeur X donnée |
Exécution
|
Mode |
Mnémonique |
Action |
| 25 | SERIES_YCOUNTFROMX |
Retourne le nombre de points ayant la valeur X si aucune erreur, 0 sinon. |
Syntaxe 19
LongVal = CHART (Mode, Window, Branch, Identifier, StartTime [, EndTime]);
Type de retour : LONG.
|
Argument |
Définition |
| StartTime |
Horodate de début. Type DOUBLE. |
| EndTime |
Horodate de fin. Optionnel. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 26 | SETDATETIME |
Initie une requête aux historiques de la date de début à la date de fin. Si la date de fin est omise, la date courante sera utilisée. 1 si OK, -1 si le nombre de points résultats est plus grand que le maximum autorisé, -2 pour si l'intervalle de temps est invalide, 0 pour toutes les autres erreurs. |
Syntaxe 20
LongVal = CHART (Mode, Window, Branch, Identifier, EndTime, Period [, TimeUnit]);
Type de retour : LONG.
|
Argument |
Définition |
| EndTime |
Date de fin. Type DOUBLE. |
| Period |
Durée. Type DOUBLE. |
| TimeUnit |
Unité de temps pour la période : 0 = Millisecondes 1 = Secondes 2 = Minutes 3 = Heures 4 = Jours |
Exécution
|
Mode |
Mnémonique |
Action |
| 27 | SETENDTIMEPERIOD |
Initie une requête d'historique avec l'Heure de début positionnée à EndTime moins la période et l'Heure de fin positionnée à EndTime. 1 si OK, -1 si le nombre de points résultats est plus grand que le maximum autorisé, -2 si l'intervalle de temps est invalide, 0 pour toutes les autres erreurs. |
Syntaxe 21
LongVal = CHART (Mode, Window, Branch, Identifier, StartTime, Period [, TimeUnit]);
Type de retour : LONG.
|
Argument |
Définition |
| StartTime |
Date de début. Type DOUBLE. |
| Period |
Durée. Type DOUBLE. |
| TimeUnit |
Unité de temps pour la période : 0 = Millisecondes 1 = Secondes 2 = Minutes 3 = Heures 4 = Jours |
Exécution
|
Mode |
Mnémonique |
Action |
| 28 | SETSTARTTIMEPERIOD |
Initie une requête d'historique avec l'Heure de début positionnée à StartTime et l'Heure de fin positionnée à StartTime plus la période. 1 si OK, -1 si le nombre de points résultat est plus grand que le maximum autorisé, -2 si l'intervalle de temps invalide, 0 pour toutes les autres erreurs. |
Syntaxe 22
LongVal = CHART (Mode, Window, Branch, Identifier, SamplePeriod [, TimeUnit]);
Type de retour : LONG.
|
Argument |
Définition |
| SamplePeriod |
Période d'échantillonnage. Type DOUBLE. |
| TimeUnit |
Unité de temps pour la période : 0 = Millisecondes 1 = Secondes 2 = Minutes 3 = Heures 4 = Jours |
Exécution
|
Mode |
Mnémonique |
Action |
| 29 | SETSAMPLEPERIOD |
Définit la période d'échantillonnage à utiliser pour les requêtes aux historiques ultérieures. Retour : 1 si OK, -2 pour l'intervalle de temps est invalide, 0 pour toutes les autres erreurs. |
Syntaxe 23
LongVal = CHART (Mode, Window, Branch, Identifier, VarName);
Type de retour : LONG.
|
Argument |
Définition |
| VarName |
Nom d'une variable en tendance. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 30 | SETSOURCEVAR |
Modifie la variable utilisée pour l'axe X. Retour : 1 si OK, 0 sinon. |
Syntaxe 24
LongVal = CHART (Mode, Window, Branch, Identifier, Title);
Type de retour : LONG.
|
Argument |
Définition |
| Title |
Titre du graphique. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 31 | SETTITLE |
Modifie le titre affiché dans le graphique. Retour : 1 si OK, 0 sinon. |
Syntaxe 25
LongVal = CHART (Mode, Window, Branch, Identifier, Path, ImageFormat);
Type de retour : LONG.
|
Argument |
Définition |
| Path |
Soit le chemin absolu de l'image. Par exemple E:\\ChartImages\\hangar18.png, soit juste le nom de l'image dans quel cas l'image sera enregistrée dans le répertoire TP du projet. Type STR. |
| ImageFormat |
Format de l'image : 0 = BMP 1 = GIF 2 = PNG |
Exécution
|
Mode |
Mnémonique |
Action |
| 34 | SAVE_IMAGE |
Enregistre une image du graphique vers l'emplacement et le format spécifiés. Retour : 1 si OK, 0 sinon. |
Syntaxe 26
LongVal = Chart (Mode, Window, Branch, Identity[, Show])
Type de retour : LONG.
|
Argument |
Définition |
| Show |
Indicateur. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
| 35 | SHOW_LEGEND |
Montre ou cache la légende. Retour : 1 si OK, 0 sinon. |
Syntaxe 27
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, Index);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant des séries. Plage 1 to 8. Type de retour : LONG. |
| Index | Index basé sur zéro du point. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 19 | SERIES_REMOVEPOINT |
Supprime un point des séries. Retour : 1 si OK, - 1 si l'index est hors plage, 0 pour toutes les autres erreurs. |
Syntaxe 28
LongVal = CHART (Mode, Window, Branch, Identifier, SeriesID, X [, Rank]);
Type de retour : LONG.
|
Argument |
Définition |
| SeriesID |
Identifiant des séries. Plage de 1 à 8. Type de retour : LONG. |
| X | Valeur X donnée. Type DOUBLE. |
| Rank | Rang du point avec la valeur X. Optionnel. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 17 | SERIES_IDXFROMX |
Retourne l'index du point s'il existe, - 1 si le point n'existe pas, 0 pour toutes les autres erreurs. |
Plus d'informations
Considérons la série S0 qui se compose des points suivants : P1(10,15), P2(11,20), P3(15,20), P4(18,25), P5(18,25), P6(21,100) ,P7(21,105).
SERIES_IDXFROMXY
SERIES_IDXFROMXY retourne l'index du premier point dans les séries avec X et Y spécifiés. Donc le code :
CHART ("SERIES_IDXFROMXY", cWindow, cBranch, cIdentifier, cSeriesID, 18, 25);
retournera 4 représentant P4(18,25). Vous pouvez également spécifier un point de début et un point de fin optionnels pour la recherche.
SERIES_IDXFROMX
SERIES_IDXFROMX est similaire à SERIES_IDXFORMXY sauf que vous ne spécifiez que X. Donc pour les séries S0, si X = 15, le retour sera 3 représentant P3(15,20). Vous pouvez également spécifier un rang optionnel. Par exemple, si vous cherchiez le deuxième point avec X = 21 vous spécifierez un rang de 1 (le rang de 0 est le premier point). Le retour serait 7 représentant P7 (21,105).
SETENDTIMEPERIOD
Le fragment de code suivant génère l'équivalent de la requête d'historiques.
Voir l'image
Dim dTime As Double;
Dim lReturn As Long;
dTime = DateTimeValue("14/05/2015", "10:00:00");
lReturn = Chart("SETENDTIMEPERIOD", "MyChartMimic", "", "Chart1", dTime, 10, 2);
SETSTARTTIMEPERIOD
Le fragment de code suivant génère l'équivalent de la requête d'historiques.
Voir l'image
Dim dTime As Double;
Dim lReturn As Long;
dTime = DateTimeValue("14/05/2015", "10:00:00");
lReturn = Chart("SETSTARTTIMEPERIOD", "MyChartMimic", "", "Chart1", dTime, 10, 2);