api

From autoplot.org

Jump to: navigation, search

Contents

  1. Methods
    1. Applet
    2. WebStart
  2. Parameters
    1. Applet
    2. Servlet
    3. Common to Servlet and Applet

1 Methods

1.1 Applet

See http://autoplot.org/applet_guide#Methods

1.2 WebStart

See http://autoplot.org/webstart_guide#Methods

2 Parameters

2.1 Applet

  • splashImage is the image to use as the preview as the applet initializes.
  • clickCallback is a javascript function to call with click info. <clickCallback>( plotid, xdatum, ydatum, xcanvas, ycanvas, clickType )

2.2 Servlet

(from http://autoplot.org/servlet_guide):

  • format specifies the return format type
    • image/png
    • application/pdf
    • image/svg+xml
  • script does nothing. The idea was an arbitrary script can be run giving complete control of the application, but because the ScriptContext is static (one per java instance), it cannot be supported. This will probably be corrected at some point. Also sandbox security needs to be ensured.
  • canvas.aspect. Aspect ratio for the canvas. Aspect is width/height, and simple expressions like '10/3' are handled.
  • process specifies a process to apply to the loaded data.
    • histogram performs a 100-bin histogram on the data. The data is autoranged to establish min, max and scale type.
    • magnitude(fft) displays the frequency content of the data

2.3 Common to Servlet and Applet

  • width and height (servlet only--applets should specify width and height in <applet> tag.)
  • canvas.aspect servlet only, controls the ratio of the height to the width.
  • timeRange is the time range displayed. Using column and timeRange will allow for a stack of panels on the same time axis.
  • dataSetURL controls the initial URL displayed. Note "about:plugins" and "about:autoplot" are supported and useful for debugging.
  • column controls the horizontal layout. Syntax is L%+S,R%+S. See help#layout.
  • row controls the vertical layout. Syntax is T%+S,B%+S. See help#layout.
  • autolayout tells the applet to automatically adjust the row and column to avoid clipping labels.
  • font is the font to use on the system. This must identify a font on the client's desktop, so good choices are generic like "sans-16"
  • rendertype explicitly specifies how the data should be renderered
    • scatter draws the data as a scatter plot
    • series connects the plot symbols
    • stairstep (used to be histogram) draws a stepped line to indicate the sample interval
    • fillToZero (used to be fill_to_zero) uses a stairstep and fills to the reference line
    • spectrogram renders the data as a spectrogram. Note if the data is not suited for this, nothing will be done.
    • hugeScatter uses a faster rendering method that can handle millions of points. "series" and "scatter" start to dog at 40K points.
  • color specifies the plot symbol and symbol connector color
  • fillColor specifies the color used to fill to the reference
  • foregroundColor is the color of the axis and labels
  • backgroundColor is the color of the drawing canvas background
  • plot.title the title for the single panel plot.
  • plot.xaxis.label the label for the x axis.
  • plot.xaxis.range the range for the x axis. e.g. "2000-02-01 to 2000-02-15" or "200 to 800". With the servlet, pluses should be used in URLs instead of spaces.
  • plot.xaxis.log scale type for x axis. "true" indicates use a log axis
  • plot.xaxis.drawTickLabels "true" indicates draw labels. This is the default.
  • plot.yaxis.range, zaxis.range, etc controls for the yaxis and zaxis (colorbar). See with xaxis.*
Retrieved from "http://www.autoplot.org/api"
Personal tools