Name

adams.flow.sink.ScatterDisplay

Synopsis

Actor for displaying a scatter plot of one attribute vs another.

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	ScatterDisplay

  
  
• 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	800
  minimum	-1

  
  
• height
  

  The height of the dialog.

  command-line	-height <int>
  default	600
  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

  
  
• xAttributeName
  

  Attribute for x axis using regular expression used if set, otherwise the index is used

  command-line	-x-attribute-name <adams.core.base.BaseRegExp>
  default
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• yAttributeName
  

  Attribute for y axis using regular expression used if set,otherwise the index is used

  command-line	-y-attribute-name <adams.core.base.BaseRegExp>
  default
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• colorAttributeName
  

  Attribute for the colors using regular expression used if set,otherwise the index is used

  command-line	-color-attribute-name <adams.core.base.BaseRegExp>
  default
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• xAttribute
  

  Index of attribute to display on x axis, used onlyif regular expression not set

  command-line	-x-attribute <java.lang.String>
  default	1

  
  
• yAttribute
  

  index of attribute to display on y axis, used only ifregular expression not set

  command-line	-y-attribute <java.lang.String>
  default	1

  
  
• colorAttribute
  

  index of optional attribute to use for coloring, used only ifregular expression not set, ignored if empty

  command-line	-color-attribute <java.lang.String>
  default

  
  
• overlays
  

  add overlays to the scatterplot

  command-line	-overlay <adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay> [-overlay ...]
  default

  
  
• paintlet
  

  Paintlet for plotting data

  command-line	-paintlet <adams.gui.visualization.stats.paintlet.AbstractScatterPlotPaintlet>
  default	adams.gui.visualization.stats.paintlet.ScatterPaintletCircle -color-provider adams.gui.visualization.core.DefaultColorProvider

  
  
• mouseClickAction
  

  How to process mouse clicks in the plot.

  command-line	-mouse-click-action <adams.gui.visualization.stats.scatterplot.action.MouseClickAction>
  default	adams.gui.visualization.stats.scatterplot.action.NullClickAction