Type of document: Usebility Checklist

Transcription

1 Projet: JEGraph Type of doument: Usebility Cheklist Author: Max Bryan Version: Envidate GmbH

2 Type of Doumet Developer guidelines User guidelines Dutybook Speifiation Programming and testing Test speifiation Key Data Levell 1 Responsible domain Editor(s) Level 2 MxB Originator(s) Doument version 1.30 Date of issue (built) Brief desription Objetives Start date Finish date Priority [1..5] Doument History / Modifiations version date author desription of modifiation of the doument Max Bryan Max Bryan Max Bryan 2011 Envidate GmbH Page 2 / 10

3 Table of Contents 0 Revision JEGraph Cartesian Plugins Zooming Settings Dialogue Info Headline JEChart Additional Settings Threshold JEDigital Plugin Size and Movement Revision Tested with Operating System: Installed Java Version: Test Date 1 JEGraph The revision number, whih an be seen under Options About, is dependent on the revision number in SVN. That means, the user an always see the number of the version he is working with. The user an save analyses. This is not dependent on the version of the program as well as the version of the saved plugins. When loading a plugin, in the tree dialogue the shown nodes depend on the user role. An admin an see raw data and data points with hourly, daily, data. A non-admin user annot see this raw data, but it is possible to hange the aggregation of the data via a seletion list. The user annot load data rows with different data types, e.g. temperature and energy 2011 Envidate GmbH Page 3 / 10

4 data. When the user wants to hange the data he has loaded and liks on the tree dialogue button, the old seletion is still visible. It is now possible to unselet the selet nodes via the orresponding button. It is also possible to fold and expand all nodes with the orresponding button. 1.1 Tree Dialog When the user wants to load data rows, he/she is always onfronted with the tree dialog with saved nodes and data rows. The user an open nodes via double liking on them. The user an open and lose nodes via liking the small arrow. Every node has a small symbol Data row nodes have s selet box. When the user selets a node, in the date field are two dates set. The right date field ontains the last day on whih the data row ontains data. When the user selets a node, in the date field are two dates set. The left date field steps one month bak or, if the data row does not ontain data more in the past than one month, the date field steps to the last date with data. When the user selets more than one node, the date fields ontain the intersetion time set of the rows, starting from the latest end point of one row and going bak one month if possible. When the user selete more than one node and the nodes do not have time sets in ommon, the date fields ontain no data. It is not possible to selet nodes and set dates where any data row ontains no data. When the user selets a data row, the list with aggregates (raw data, lean data, month data, ) gets enabled. The aggregates list only ontains entries where all seleted nodes ontain data. When the user liks the ok button, the seleted data rows are loaded in the speified time set and with the speified aggregation. When the data rows have been loaded and the dialog is losed, the user an open the dialog again via liking on the tree dialog button. The dialog now looks the same as before. 1.2 Analysis It is possible to save the state of the JEGraph with all the opened plugins. When the user starts the program the next time, it is easier to get the desired state by loading the old state. The user an open the save analysis dialogue via the top menu via liking on File/Datei Save analysis/speihere Analyse, whih opens the tree. In the tree the user an navigate to the desired node and an save the analysis via liking on Ok and entering a name Envidate GmbH Page 4 / 10

5 When the user double liks on a saved analysis,it is asked if it shall be overwritten. The same happens when liking on a saved analysis and liking the Ok button. The user an open a saved analysis via the top menu via liking on File/Datei Open analysis/öffne Analyse, whih opens a list with all analysis, whih an be seen by the user. An analysis is loaded via double liking it or liking one on it and then liking ok. Then a dialog is loaded, where the names of the saved analysis are shown and the saved time periods The user an swith on a setting, with whih the time periods always stay in the same relativ state. When the user now hanges the time periods via liking on the a date field and hoosing a date, all other dates adopt this hange, so the new time periods are in the same relative position to eah other, e.g., if the user hanges one data row time period to three days before, the other date fields also hange their date to one week before. With the option swithed to off, when the user hanges a date field, the other date field to not adopt the hange. When the user liks on an one arrowed button (>, <) the dates are hanged in the seleted time format (day, week, month year). When the user liks on a two arrowed button (>>, <<), the time period is set to the biggest minimum or the smallest maximum of all data rows. It is not possible to hange the data row time periods in a way, where the relative differene hanges or that a time period is seleted, whih does not ontain data General Savings When the user saves an analysis the following aspets are saved: The ID of a plugin The order of the plugins. The position and size of the plugins. The linking state of plugins JEChart An opened analysis has the same following attributes as the saved one: Colours Fill mode ( filled / not filled) Transpareny Bars / Areas Staked / not staked 100% mode Visible minimum on y sale Visible maximum on y sale Visible minimum on x sale Visible maximum on x sale Number of deimal plaes Line thikness 2011 Envidate GmbH Page 5 / 10

6 The hosen unit 2 Cartesian Plugins Cartesian plugins are plugins whih ontain a x and y oordinate with a time line on the x axis and a value axis on the y axis. 2.1 Zooming The user an zoom into the data. He liks on the hart, moves the mouse to the left or right and releases the mouse. It is now zoomed into the seleted area unless there is no data point. When having zoomed the user an move the shown area via right liking on the hart and moving the mouse. The user an undo and redo zoom steps with the orresponding buttons. He an also undo all zoom ations at one. The user an add a loal zoom handler into the hart. This zoom handler reates a setion where the user an see detailed data. He an move the setion via right-liking on it and moving the mouse. The setion an be widened via liking on the orresponding button. The user an link Cartesian plugins when they are in no zooming state. When now zooming ations are performed, they involve all linked plugins. When the plugins are in a zoomed state and the user move the time period via rightliking and moving the mouse, all plugins move. 2.2 Settings Dialogue The settings dialogue ontains options for the user like hanging the olour or the order of data rows. It an be opened via liking on the toolbar-button. When the user performs hanges in the dialog, it is applied immediately to the plugin. When liking on ok, the dialogue loses and the user an work with the applied hanges. When liking on anel, the dialog loses and the plugin shows all hanges reverted to the state before settings dialogue was opened. When ativating the automati hekbox in the values Tab, the standard values will be wirten and the min/max fields will be gray. When unheking the hekbox the old values will be written inside the min/max fields. When liking ok, the state of the automati hekbox is saved and in the same state when opening the settings dialouge again Envidate GmbH Page 6 / 10

7 2.2.1 Colours When the users selet a data row via liking on it and then liks on the olour button, a olour hoosing menu is opened where the user an hoose a new olour for the seleted data row. When liking on ok, the hosen olour is taken and the olour is used for the data row list. The olour in the plugin is updated when the user loses the settings dialogue via liking on the ok button Data Row Order The settings dialogue ontains a list of the seleted data rows. The User an lik on a data row and then on the arrows to hange the order. The higher a data row is, the more it is in the bak. If it is at the top, it is more likely that is is overdrawn by other data rows. 2.3 Info Headline The info headline is shown above the hart. It ontains information about all shown data rows. The first olumn ontains a small symbol with the hosen olour of the data row. The third olumn ontains the name of the loaded data. If more than one data rows are hosen, it is shown in brakets where the data row is saved. E.g. if the user selets energy data in different ities, the braket ontains the name of the ity. Columns 3 to 5 ontain maximum, minimum and average value of the seleted data. Column 5 shows the value of the data point where the mouse ursor is. If the plugins are linked, the value is also updated in every linked plugin. Column 6 shows the date of the ursor data point. 2 JEChart The JEChart shows measuring data on a time line. On the y axis, the user an the values the data. 2.1 Additional Settings In the settings dialogue the user an perform more hanges to the hart than in other Cartesian plugins. The user an hange between filled and non filled graphs. Non filled graphs only show a line of the data and do not fill the are below the line. With this option, the user an see graphs, whih otherwise ould be overdrawn. When haven hosen filled graphs, the user an deide if he wants the oloured area to be transparent. With this option, the user an 2011 Envidate GmbH Page 7 / 10

8 see graphs, whih otherwise would be hidden. The user an hoose between two hart types: bar and area diagram. The user an hoose between umulative and non-umulative diagrams. When having hosen umulative diagram the y axis should be updated. Additionally, the user an hoose a 100% mode. In this mode, the hart shows the share of the share of eah data row of the umulative data. The user an speify the values he wants to see. E.g., the the values of loaded data rows lie between 90 and 100 but the range between 0 and 100 is shown, he an set the range to 90 and 100. He an also hange the number of deimal plaes and the unit the data is shown in. 2.2 Threshold The threshold an be ativated via liking on the button with the two arrows. The threshold is reated with two lines, one at the top and one at the button. Left to the hart a slider is reated. This slider ontains two buttons whih an be moved with a left mouse lik and then moving the mouse up and down. Data points below the bottom line are shown in green, data points between the two lines are yellow, the data points above the upper line are red. Next to the buttons there is a small text field whih ontains a number that shows the value of the urrent line. The upper text field has a red bakground, the bottom text field has a green bakground. When the buttons are moved, the lines on the hart and the text field also move. The olour of the data points hanges when the lines ross a data point. The Threshold works for multiple data rows. 3 JEDigital The Digital hart shows data rows whih onsist of digital value. Therefore bars are shown, when the data point ontains the value on. If more than one digital data row is loaded, more harts are reated below. If the user hanges the order of the data rows, the harts are ordered in the orresponding order. 4 JEBenh In the first step you an selet 2 or more datarows if they have the same or an equal type At the top of the window you an selet the interval or load with the default value At the bottom of the window you an searh in the tree, if hes foldet out There are 3 buttons, one for bak, one for anel, and one for going on 2011 Envidate GmbH Page 8 / 10

9 In the seond step you an hoose a datarow or datarows to ompare them with the seleted datarows in the step before 5 Plug-in Size and Movement Every plugin has on the right and bottom and a grey bar. With this bar, the plugin an be resized. Plugins annot be wider than the width of the window. That means, there is never an horizontal sroll bar shown. A vertial sroll bar is only shown when the size the plugins need is bigger than the windows the plugins are in. When a plugin is reated, it gets as muh spae as it needs. Therefore, when there is no other plugin, the plugin gets the whole spae. If a plugin has a maximum size, it does not get the whole spae. When a plugin is reated and all the spae is taken, the old plugins are resized and moved up, so the new plugin fits into the window. If there is not enough spae for every plugin, no plugin is resized. The new plugin is plaes at the bottom and the window gets a vertial sroll bar. Every plugin ontains a grey headline with its name and number. When left liking on the headline and moving the mouse, the plugin is moved. The plugin annot leave the window. When the plugin gets near the border of another plugin or near the border of the window, it is moved diretly to the border, as if it stiks to the border. The desribed stiking is ativated when the distane between the border is smaller than 30px. When two plugins overlap and the spae is more than 60% overlapped, the two plugins hange the position. This is only done, when after the position hange there is no overlapping. When a plugin is moved and the user releases the mouse, the plugin jumps bak to its original plae. The plugin jumps to another plae where it was moved before, when the plugin has a horizontal and a vertial anhor point. That means, a plugin annot be plaed e.g. in the middle of the window, when there is no other plugin next to it. Tested by: 2011 Envidate GmbH Page 9 / 10

10 Signed by: 2011 Envidate GmbH Page 10 / 10