Changes from Version 1 of adeiService_genimage

Show
Ignore:
Author:
csa (IP: 141.52.232.84)
Timestamp:
07/18/08 16:13:25 (16 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • adeiService_genimage

    v0 v1  
     1= genimage = 
     2Generate image and return image identificator (for future use in getimage.php) along with various image properties. 
     3 
     4== Mandatory Properties == 
     5 * [wiki:adeiParam_db_server db_server ] - Data source  
     6 * [wiki:adeiParam_db_name db_name ] - Database namee) 
     7 * [wiki:adeiParam_db_group db_group ] - Log Group 
     8 * [wiki:adeiParam_frame_width frame_width ] - image width 
     9 * [wiki:adeiParam_frame_height frame_height ] - image height 
     10 
     11== Optional Properties == 
     12 * [wiki:adeiParam_db_mask db_mask] - Item mask  
     13 * [wiki:adeiParam_window window] - Data Interval (everything by default) 
     14 * [wiki:adeiParam_aggregator aggregator] - data aggregation mode 
     15 * [wiki:adeiParam_show_marks show_marks] - real-data-points reporting mode 
     16 * [wiki:adeiParam_show_gaps show_gaps] - missing-data reporting mode 
     17 * [wiki:adeiParam_interpolate_gaps interpolate_gaps] - data interpolation mode 
     18 * [wiki:adeiPram_precision precision] - specifies required chart precision 
     19 
     20== Returned Result == 
     21The request returns JSON encoded array of properties of generated image. If an error have occurred, the only returned property is ''error''. 
     22 * ''error'' - should be 0 if image generated successfully, otherwise contains the problem description 
     23 * ''image'' - it is indeficator of generated image which should be passed to the [wiki:adeiService_getimage getimage] request in order to obtain the image. 
     24 * ''margins'' - array describing graph margins [left,top, right, bottom]. It is a space  allocated for axis, etc. 
     25 * ''xmin'' - UNIX timestamp corresponding to the left corner of X-axis 
     26 * ''xmax'' - UNIX timestamp corresponding to the right corner of X-axis 
     27 * ''ymin'' - value corresponding to the bottom corner of Y-axis 
     28 * ''ymax'' - value corresponding to the upper corner of Y-axis 
     29 * ''yzoom'' - boolean flag indicating if image iz zoomed over Y-axis 
     30 * ''precision'' - approximate precision of the graph (1 is maximum) 
     31 
     32