Name

adams.flow.sink.BoxPlot

Synopsis

Actor for displaying box plots.

For more information, see:
http://en.wikipedia.org/wiki/Box_plot

Additional information

Flow input/output:
- input: adams.data.spreadsheet.SpreadSheet

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	BoxPlot

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• shortTitle
  

  If enabled uses just the name for the title instead of the actor's full name.

  command-line	-short-title <boolean>
  default	false

  
  
• displayType
  

  Determines how to show the display, eg as standalone frame (default) or in the Flow editor window.

  command-line	-display-type <adams.flow.core.displaytype.AbstractDisplayType>
  default	adams.flow.core.displaytype.Default
  min-user-mode	Expert

  
  
• width
  

  The width of the dialog.

  command-line	-width <int>
  default	1000
  minimum	-1

  
  
• height
  

  The height of the dialog.

  command-line	-height <int>
  default	700
  minimum	-1

  
  
• x
  

  The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right).

  command-line	-x <int>
  default	-1
  minimum	-3

  
  
• y
  

  The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom).

  command-line	-y <int>
  default	-1
  minimum	-3

  
  
• writer
  

  The writer to use for generating the graphics output.

  command-line	-writer <adams.gui.print.JComponentWriter>
  default	adams.gui.print.NullWriter

  
  
• showFlowControlSubMenu
  

  If enabled, adds a flow control sub-menu to the menubar.

  command-line	-show-flow-control-submenu <boolean>
  default	false
  min-user-mode	Expert

  
  
• widthPlot
  

  Width of each box plot

  command-line	-width-plot <int>
  default	200
  minimum	50
  maximum	500

  
  
• heightPlot
  

  Height of each box plot

  command-line	-height-plot <int>
  default	200
  minimum	50
  maximum	500

  
  
• widthAx
  

  Width of box plot y axis

  command-line	-width-ax <int>
  default	50
  minimum	20
  maximum	100

  
  
• numHorizontal
  

  Number of box plots to display on each row, -1 and 0 aredefault and will display all the box plots in one row

  command-line	-num-horizontal <int>
  default	3
  minimum	-1

  
  
• fillBox
  

  Fill the box plots with color

  command-line	-fill-box <boolean>
  default	true

  
  
• color
  

  Color to fill box plots

  command-line	-color <java.awt.Color>
  default	#ff0000

  
  
• sameAxis
  

  Box plots have same axis

  command-line	-same-axis <boolean>
  default	false

  
  
• attributes
  

  Attributes to display in box plots.

  command-line	-attributes <adams.core.Range>
  default	first-last
  example	A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last