ScatterPlotModel (SAS AppDevStudio API Developer Documentation for Java)

All Libraries

This Library

Package

Class

Use

Tree

Deprecated

Index

Grand Index

Help

Components

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sas.graphics.components.scatterplot
Class ScatterPlotModel

com.sas.graphics.components.scatterplot.ScatterPlotModel

public class ScatterPlotModel

A ScatterPlotModel encapsulates most of a ScatterPlot's visual display properties. This contrasts with the ScatterPlot's data model, which determines the number and organization of data elements (markers and lines) and the use of axes and a legend.

A ScatterPlotModel contains ScatterPlot-specific properties, common graph properties, and a collection of models that control the appearance of the graph's peripheral elements, such as its axes and legends.

A ScatterPlotModel does not allow null values for properties in its contained models. Passing a null parameter to the set method for a contained model property results in an IllegalArgumentException. Guaranteeing non-null properties for a contained model simplifies access to the display properties and ensures that the ScatterPlot's display state is unambiguous.

Topics:: Plot Markers
Display Properties
Interpolation Lines
Line Styles
Filled Areas
Behavior
Samples:: Swing-based Samples
Servlet-based Samples

Since:: SAS 9.1
See Also:: Graph, GraphStyle, ScatterPlot

Constructor Summary

ScatterPlotModel()


Method Summary

void apply(ScatterPlotModel theOtherModel)
          Utility method to convey properties contained in "theOtherModel" to this object.

boolean equals(java.lang.Object obj)
          Determines whether another object is equal to this ScatterPlotModel.

AxisWallModel getAxisWallModel()
          Return the ScatterPlot's axis walls and floor appearance properties.

int getBottomMarkerLabelContent()
          Returns the type of content in label displayed below the markers.

AdvancedTextStyle getBottomMarkerLabelTextStyle()
          Returns the text appearance model (font, color, justification and base angle) that is applied to the value below the markers.

LegendModel getColorLegendModel()
          Return the color legend's display attributes.

GraphMatrixAxisModel getColumnAxisModel()
          Returns the Graph's column axis model, which contains axis' appearance preferences.

com.sas.measures.BaseLength getMaximumMarkerSize()
          Returns the maximum size of the marker.

com.sas.measures.BaseLength getMinimumMarkerSize()
          Returns the minimum size of the marker.

int getMissingPolicy()
          Returns the graph behavior for displaying missing values.

LineStyle getNeedleLineStyle()
          Return the line appearance properties (color and thickness) that is applied to the needles attached to the markers.

GraphMatrixAxisModel getRowAxisModel()
          Returns the Graph's row axis model, which contains axis' appearance preferences.

LegendModel getShapeLegendModel()
          Return the shape (marker's symbol) legend's attributes.

int getSkin()
          Get the style used to modify the displayed markers.

int getTopMarkerLabelContent()
          Returns the type of content in label displayed at the top of the marker.

AdvancedTextStyle getTopMarkerLabelTextStyle()
          Returns the text appearance model (font, color, justification and base angle) that is applied to the display labels above the markers.

double getXAxisBaseline()
          Returns the base line anchor for x axis.

AxisModel getXAxisModel()
          Returns a model which encapsulates all display properties of X axis.

double getY2AxisBaseline()
          Returns the base line anchor for Y2 axis.

AxisModel getY2AxisModel()
          Returns a model which encapsulates all display properties of Y2 axis.

double getYAxisBaseline()
          Returns the base line anchor for Y axis.

AxisModel getYAxisModel()
          Returns a model which encapsulates all display properties of Y axis.

int hashCode()
          Returns the hash code for this instance.

boolean isFillAreaEnabled()
          Returns if the area fill under the plot is enabled.

boolean isInterpolationEnabled()
          Returns true if the interpolations between the markers are visible.

boolean isMarkerEnabled()
          Returns if the markers are enabled.

boolean isMatchErrorColor()
          Returns true if the error-markers and error-lines use color from the markers to which they are attached.

boolean isMatchMarkerLabelColor()
          Returns true if marker labels use color from the markers to which they are labeling.

boolean isMatchNeedleColor()
          Returns false if needles use color from the property needleLineStyle.

boolean isSkipMissing()
          Returns true if the missing values are skipped keeping the plot as single joined line.

boolean isUniformEnabled()
          Returns whether or not the category axis values are identical between all cells.

void setAxisWallModel(AxisWallModel newAxisWallModel)
          Set the axis's walls and floor display properties.

void setBottomMarkerLabelContent(int newContent)
          Sets the type of content displayed below the markers.

void setBottomMarkerLabelTextStyle(AdvancedTextStyle textStyle)
          Sets the text appearance model (font, color, justification and base angle) that is applied to the display labels below the markers.

void setColorLegendModel(LegendModel newColorLegendModel)
          Set the color legend display attributes.

void setColumnAxisModel(GraphMatrixAxisModel newAxisModel)
          Set the Graph's column axis model, which contains axis's appearance preferences.

void setFillAreaEnabled(boolean enabledFlag)
          Sets the area under the plot to be filled or not.

void setInterpolationEnabled(boolean enabledFlag)
          Sets the interpolation among the markers visible.

void setMarkerEnabled(boolean enabledFlag)
          Sets the markers for the data points enabled.

void setMatchErrorColor(boolean newMatchErrorColor)
          Sets the error-markers and error-lines to use color from the markers to which they are attached.

void setMatchMarkerLabelColor(boolean newMatchMarkerLabelColor)
          Sets the color used by the marker labels attached to data points.

void setMatchNeedleColor(boolean newMatchNeedleColor)
          Sets whether or not to match color of attached markers for needles.

void setMaximumMarkerSize(com.sas.measures.BaseLength newMaxSize)
          Sets the maximum size of the markers.

void setMinimumMarkerSize(com.sas.measures.BaseLength newMinSize)
          Sets the minimum size of the markers.

void setMissingPolicy(int newMissingPolicy)
          Sets the graph behavior for displaying missing values.

void setNeedleLineStyle(LineStyle newNeedleLineStyle)
          Set the needle appearance properties (color, thickness) that is applied to the needles on the marker elements.

void setRowAxisModel(GraphMatrixAxisModel newAxisModel)
          Set the Graph's row axis model, which contains axis's appearance preferences.

void setShapeLegendModel(LegendModel newShapeLegendModel)
          Sets the shape(marker's symbol) legend attributes.

void setSkin(int newSkin)
          Set the style of skin to modify the marker appearance.

void setSkipMissing(boolean skipMissingFlag)
          Sets if the missing values are skipped keeping the plot as single joined line or break the plot at the missing values.

void setTopMarkerLabelContent(int newContent)
          Sets the type of content displayed at the top of the markers.

void setTopMarkerLabelTextStyle(AdvancedTextStyle textStyle)
          Sets the text appearance model (font, color, justification and base angle) that is applied to the display labels above the markers.

void setUniformEnabled(boolean newUniformEnabled)
          Sets whether or not the axis values are identical between all cells.

void setXAxisBaseline(double location)
          Sets the base line anchor position for the x axis.

void setXAxisModel(AxisModel newAxisModel)
          Set the display properties of the X axis.

void setY2AxisBaseline(double location)
          Sets the base line anchor position for the secondary Y axis.

void setY2AxisModel(AxisModel newAxisModel)
          Set the display properties for the Y2 axis.

void setYAxisBaseline(double location)
          Sets the base line anchor position for the Y axis.

void setYAxisModel(AxisModel newAxisModel)
          Sets a model which encapsulates all display properties of Y axis.

Methods inherited from class com.sas.graphics.components.GraphModel

apply, getBackgroundFillStyle, getBrushModel, getDataElementStyles, getDataTipModel, getFrameLineStyle, getLogo, getLogoJustification, isAntialiasedGraphics, isAntialiasedText, setAntialiasedGraphics, setAntialiasedText, setBackgroundFillStyle, setBrushModel, setDataElementStyles, setDataTipModel, setFrameLineStyle, setLogo, setLogoJustification

Methods inherited from class com.sas.graphics.components.ModelBase

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, setContainedModel

Constructor Summary
`ScatterPlotModel()`

Method Summary
`void`	`apply(ScatterPlotModel theOtherModel)` Utility method to convey properties contained in "theOtherModel" to this object.
`boolean`	`equals(java.lang.Object obj)` Determines whether another object is equal to this `ScatterPlotModel`.
`AxisWallModel`	`getAxisWallModel()` Return the ScatterPlot's axis walls and floor appearance properties.
`int`	`getBottomMarkerLabelContent()` Returns the type of content in label displayed below the markers.
`AdvancedTextStyle`	`getBottomMarkerLabelTextStyle()` Returns the text appearance model (font, color, justification and base angle) that is applied to the value below the markers.
`LegendModel`	`getColorLegendModel()` Return the color legend's display attributes.
`GraphMatrixAxisModel`	`getColumnAxisModel()` Returns the Graph's column axis model, which contains axis' appearance preferences.
`com.sas.measures.BaseLength`	`getMaximumMarkerSize()` Returns the maximum size of the marker.
`com.sas.measures.BaseLength`	`getMinimumMarkerSize()` Returns the minimum size of the marker.
`int`	`getMissingPolicy()` Returns the graph behavior for displaying missing values.
`LineStyle`	`getNeedleLineStyle()` Return the line appearance properties (color and thickness) that is applied to the needles attached to the markers.
`GraphMatrixAxisModel`	`getRowAxisModel()` Returns the Graph's row axis model, which contains axis' appearance preferences.
`LegendModel`	`getShapeLegendModel()` Return the shape (marker's symbol) legend's attributes.
`int`	`getSkin()` Get the style used to modify the displayed markers.
`int`	`getTopMarkerLabelContent()` Returns the type of content in label displayed at the top of the marker.
`AdvancedTextStyle`	`getTopMarkerLabelTextStyle()` Returns the text appearance model (font, color, justification and base angle) that is applied to the display labels above the markers.
`double`	`getXAxisBaseline()` Returns the base line anchor for x axis.
`AxisModel`	`getXAxisModel()` Returns a model which encapsulates all display properties of X axis.
`double`	`getY2AxisBaseline()` Returns the base line anchor for Y2 axis.
`AxisModel`	`getY2AxisModel()` Returns a model which encapsulates all display properties of Y2 axis.
`double`	`getYAxisBaseline()` Returns the base line anchor for Y axis.
`AxisModel`	`getYAxisModel()` Returns a model which encapsulates all display properties of Y axis.
`int`	`hashCode()` Returns the hash code for this instance.
`boolean`	`isFillAreaEnabled()` Returns if the area fill under the plot is enabled.
`boolean`	`isInterpolationEnabled()` Returns true if the interpolations between the markers are visible.
`boolean`	`isMarkerEnabled()` Returns if the markers are enabled.
`boolean`	`isMatchErrorColor()` Returns true if the error-markers and error-lines use color from the markers to which they are attached.
`boolean`	`isMatchMarkerLabelColor()` Returns true if marker labels use color from the markers to which they are labeling.
`boolean`	`isMatchNeedleColor()` Returns false if needles use color from the property `needleLineStyle`.
`boolean`	`isSkipMissing()` Returns true if the missing values are skipped keeping the plot as single joined line.
`boolean`	`isUniformEnabled()` Returns whether or not the category axis values are identical between all cells.
`void`	`setAxisWallModel(AxisWallModel newAxisWallModel)` Set the axis's walls and floor display properties.
`void`	`setBottomMarkerLabelContent(int newContent)` Sets the type of content displayed below the markers.
`void`	`setBottomMarkerLabelTextStyle(AdvancedTextStyle textStyle)` Sets the text appearance model (font, color, justification and base angle) that is applied to the display labels below the markers.
`void`	`setColorLegendModel(LegendModel newColorLegendModel)` Set the color legend display attributes.
`void`	`setColumnAxisModel(GraphMatrixAxisModel newAxisModel)` Set the Graph's column axis model, which contains axis's appearance preferences.
`void`	`setFillAreaEnabled(boolean enabledFlag)` Sets the area under the plot to be filled or not.
`void`	`setInterpolationEnabled(boolean enabledFlag)` Sets the interpolation among the markers visible.
`void`	`setMarkerEnabled(boolean enabledFlag)` Sets the markers for the data points enabled.
`void`	`setMatchErrorColor(boolean newMatchErrorColor)` Sets the error-markers and error-lines to use color from the markers to which they are attached.
`void`	`setMatchMarkerLabelColor(boolean newMatchMarkerLabelColor)` Sets the color used by the marker labels attached to data points.
`void`	`setMatchNeedleColor(boolean newMatchNeedleColor)` Sets whether or not to match color of attached markers for needles.
`void`	`setMaximumMarkerSize(com.sas.measures.BaseLength newMaxSize)` Sets the maximum size of the markers.
`void`	`setMinimumMarkerSize(com.sas.measures.BaseLength newMinSize)` Sets the minimum size of the markers.
`void`	`setMissingPolicy(int newMissingPolicy)` Sets the graph behavior for displaying missing values.
`void`	`setNeedleLineStyle(LineStyle newNeedleLineStyle)` Set the needle appearance properties (color, thickness) that is applied to the needles on the marker elements.
`void`	`setRowAxisModel(GraphMatrixAxisModel newAxisModel)` Set the Graph's row axis model, which contains axis's appearance preferences.
`void`	`setShapeLegendModel(LegendModel newShapeLegendModel)` Sets the shape(marker's symbol) legend attributes.
`void`	`setSkin(int newSkin)` Set the style of skin to modify the marker appearance.
`void`	`setSkipMissing(boolean skipMissingFlag)` Sets if the missing values are skipped keeping the plot as single joined line or break the plot at the missing values.
`void`	`setTopMarkerLabelContent(int newContent)` Sets the type of content displayed at the top of the markers.
`void`	`setTopMarkerLabelTextStyle(AdvancedTextStyle textStyle)` Sets the text appearance model (font, color, justification and base angle) that is applied to the display labels above the markers.
`void`	`setUniformEnabled(boolean newUniformEnabled)` Sets whether or not the axis values are identical between all cells.
`void`	`setXAxisBaseline(double location)` Sets the base line anchor position for the x axis.
`void`	`setXAxisModel(AxisModel newAxisModel)` Set the display properties of the X axis.
`void`	`setY2AxisBaseline(double location)` Sets the base line anchor position for the secondary Y axis.
`void`	`setY2AxisModel(AxisModel newAxisModel)` Set the display properties for the Y2 axis.
`void`	`setYAxisBaseline(double location)` Sets the base line anchor position for the Y axis.
`void`	`setYAxisModel(AxisModel newAxisModel)` Sets a model which encapsulates all display properties of Y axis.

Methods inherited from class com.sas.graphics.components.GraphModel
`apply, getBackgroundFillStyle, getBrushModel, getDataElementStyles, getDataTipModel, getFrameLineStyle, getLogo, getLogoJustification, isAntialiasedGraphics, isAntialiasedText, setAntialiasedGraphics, setAntialiasedText, setBackgroundFillStyle, setBrushModel, setDataElementStyles, setDataTipModel, setFrameLineStyle, setLogo, setLogoJustification`

Methods inherited from class com.sas.graphics.components.ModelBase
`addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, setContainedModel`

Constructor Detail

ScatterPlotModel

public ScatterPlotModel()

Method Detail

apply

public void apply(ScatterPlotModel theOtherModel)

Utility method to convey properties contained in "theOtherModel" to this object.
Note: Contained "models" (i.e. properties that are subclasses of ModelBase) will in turn be called on to convey their properties to the like contained models in the other object. In that respect this can be considered a "tree" type copy.
Also Note: This is a deep copy. Thus after the copy, mutable properties will not be shared by the two instances.

Parameters:: theOtherModel - set of properties to copy from to this instance

setRowAxisModel

public void setRowAxisModel(GraphMatrixAxisModel newAxisModel)
                     throws java.lang.IllegalArgumentException

Set the Graph's row axis model, which contains axis's appearance preferences. The row axis appears when the Graph's "Row" variable is assigned to a valid data column. The row Axis manages groups of rows.

Parameters:: newAxisModel - row axis display attributes
Throws:: java.lang.IllegalArgumentException - if newAxis is null.
See Also:: getRowAxisModel(), GraphMatrixAxisModel.apply(com.sas.graphics.components.GraphMatrixAxisModel)

getRowAxisModel

public GraphMatrixAxisModel getRowAxisModel()

Returns the Graph's row axis model, which contains axis' appearance preferences. The row axis appears when the Graph's "Row" variable is assigned to a valid data column. The row Axis manages groups of rows.

Returns:: GraphMatrixAxisModel associated with the row axis
See Also:: setRowAxisModel(com.sas.graphics.components.GraphMatrixAxisModel), getColumnAxisModel()

setColumnAxisModel

public void setColumnAxisModel(GraphMatrixAxisModel newAxisModel)
                        throws java.lang.IllegalArgumentException

Set the Graph's column axis model, which contains axis's appearance preferences. The column axis appears when the Graph's "Column" variable is assigned to a valid data column. The column Axis manages groups of columns.

Parameters:: newAxisModel - the column axis display attributes
Throws:: java.lang.IllegalArgumentException - if newAxis is null.
See Also:: getColumnAxisModel(), GraphMatrixAxisModel.apply(com.sas.graphics.components.GraphMatrixAxisModel)

getColumnAxisModel

public GraphMatrixAxisModel getColumnAxisModel()

Returns the Graph's column axis model, which contains axis' appearance preferences. The column axis appears when the Graph's "Column" variable is assigned to a valid data column. The column Axis manages groups of columns.

Returns:: GraphMatrixAxisModel associated with the column axis
See Also:: setColumnAxisModel(com.sas.graphics.components.GraphMatrixAxisModel), getRowAxisModel()

setYAxisModel

public void setYAxisModel(AxisModel newAxisModel)
                   throws java.lang.IllegalArgumentException

Sets a model which encapsulates all display properties of Y axis. The Y axis is vertical axis placed at the left side of the plot. AxisModel stores the axis appearance preferences.

Parameters:: newAxisModel - new set of properties associated with the Y axis.
Throws:: java.lang.IllegalArgumentException - if newAxisModel is null.
See Also:: getYAxisModel(), AxisModel.apply(com.sas.graphics.components.AxisModel)

getYAxisModel

public AxisModel getYAxisModel()

Returns a model which encapsulates all display properties of Y axis.

Returns:: AxisModel associated with the left (primary) vertical Y axis
See Also:: setYAxisModel(com.sas.graphics.components.AxisModel), AxisModel.apply(com.sas.graphics.components.AxisModel)

setXAxisModel

public void setXAxisModel(AxisModel newAxisModel)
                   throws java.lang.IllegalArgumentException

Set the display properties of the X axis. The X Axis is the horizontal axis that is below the chart. The newAxisModel stores the appearance preferences.

Parameters:: newAxisModel - display properties associated with horizontal X axis
Throws:: java.lang.IllegalArgumentException - if newAxisModel is null.
See Also:: getXAxisModel()

getXAxisModel

public AxisModel getXAxisModel()

Returns a model which encapsulates all display properties of X axis.

Returns:: display properties associated with horizontal X axis
See Also:: AxisModel.apply(com.sas.graphics.components.AxisModel), setXAxisModel(com.sas.graphics.components.AxisModel)

setY2AxisModel

public void setY2AxisModel(AxisModel newAxisModel)
                    throws java.lang.IllegalArgumentException

Set the display properties for the Y2 axis. The Y2 axis is placed on right side of chart. The newAxisModel stores the appearance preferences for the axis.

Parameters:: newAxisModel - display properties associated with vertical Y2 axis
Throws:: java.lang.IllegalArgumentException - if newAxisModel is null.
See Also:: getY2AxisModel()

getY2AxisModel

public AxisModel getY2AxisModel()

Returns a model which encapsulates all display properties of Y2 axis.

Returns:: display properties associated with second vertical Y axis
See Also:: AxisModel.apply(com.sas.graphics.components.AxisModel), setY2AxisModel(com.sas.graphics.components.AxisModel)

setAxisWallModel

public void setAxisWallModel(AxisWallModel newAxisWallModel)
                      throws java.lang.IllegalArgumentException

Set the axis's walls and floor display properties. AxisWallModel stores all the walls and floor appearance preferences inside the X axis and Y axis.

Parameters:: newAxisWallModel - properties for all walls and floor.
Throws:: java.lang.IllegalArgumentException - if newAxisWallModel is null.
See Also:: getAxisWallModel()

getAxisWallModel

public AxisWallModel getAxisWallModel()

Return the ScatterPlot's axis walls and floor appearance properties.

Returns:: AxisWallModel properties of all walls and floor.
See Also:: setAxisWallModel(com.sas.graphics.components.AxisWallModel), AxisWallModel.apply(com.sas.graphics.components.AxisWallModel)

setColorLegendModel

public void setColorLegendModel(LegendModel newColorLegendModel)
                         throws java.lang.IllegalArgumentException

Set the color legend display attributes. ColorLegend is displayed if any one of the following conditions hold:

The colorVariable role is set to a valid value.
The groupVariable role is set to a valid value.
The yVariable and y2Variable are set to valid values
yVariable ory2Variable is set to valid multiple roles.

Parameters:: newColorLegendModel - properties of the color legend.
Throws:: java.lang.IllegalArgumentException - if newLegendModel is null.
See Also:: LegendModel.apply(com.sas.graphics.components.LegendModel), getColorLegendModel()

getColorLegendModel

public LegendModel getColorLegendModel()

Return the color legend's display attributes.

Returns:: display properties of the color legend
See Also:: setColorLegendModel(com.sas.graphics.components.LegendModel), LegendModel.apply(com.sas.graphics.components.LegendModel)

setShapeLegendModel

public void setShapeLegendModel(LegendModel newShapeLegendModel)
                         throws java.lang.IllegalArgumentException

Sets the shape(marker's symbol) legend attributes. ShapeLegend is displayed if any one of the following conditions hold:

The shapeVariable role is set to a valid value and it is not same as colorVariable.
The groupVariable role is set to a valid value and it is not same as colorVariable.
The colorVariable role is set to a valid value and the yVariable and y2Variable are set to valid values.
The colorVariable role is set to a valid value and either yVariable or y2Variable is set to valid multiple values.

Parameters:: newShapeLegendModel - properties for the marker's symbol legend.
Throws:: java.lang.IllegalArgumentException - if newLegendModel is null.
See Also:: LegendModel.apply(com.sas.graphics.components.LegendModel), getShapeLegendModel()

getShapeLegendModel

public LegendModel getShapeLegendModel()

Return the shape (marker's symbol) legend's attributes.

Returns:: display properties of the shape legend
See Also:: setShapeLegendModel(com.sas.graphics.components.LegendModel), LegendModel.apply(com.sas.graphics.components.LegendModel)

setInterpolationEnabled

public void setInterpolationEnabled(boolean enabledFlag)

Sets the interpolation among the markers visible. Default value is false. If this is set to true then the interpolation defined in the MarkerStyle are used to connect markers. Otherwise, no interpolation is displayed. See Interpolation Lines to find out how to get and modify marker style properties.

Parameters:: enabledFlag - true to show the interpolations.
See Also:: isInterpolationEnabled()

isInterpolationEnabled

public boolean isInterpolationEnabled()

Returns true if the interpolations between the markers are visible.

Returns:: true if interpolations are displayed.
See Also:: setInterpolationEnabled(boolean)

setXAxisBaseline

public void setXAxisBaseline(double location)

Sets the base line anchor position for the x axis. If interpolation on MarkerStyle is set to MarkerStyle.INTERPOLATION_HORIZONTAL_NEEDLES then a vertical base line is drawn passing through the anchor. All the data points are joined to this base line using horizontal needles. See the description section to find out how to modify marker interpolation properties. The Default value is Double.NEGATIVE_INFINITY. This treats Y axis as the baseline. This value does not affect the x axis range.

Parameters:: location - base line anchor value based on X axis.
See Also:: getXAxisBaseline()

getXAxisBaseline

public double getXAxisBaseline()

Returns the base line anchor for x axis.

Returns:: x axis base line anchor value.
See Also:: setXAxisBaseline(double)

setYAxisBaseline

public void setYAxisBaseline(double location)

Sets the base line anchor position for the Y axis. If interpolation on MarkerStyle is set to MarkerStyle.INTERPOLATION_VERTICAL_NEEDLES then a horizontal base line is drawn passing through the anchor. All the x-y data points are joined to this base line using vertical needles. See the description section to find out how to modify marker interpolation properties. The Default value is Double.NEGATIVE_INFINITY. This treats X axis as baseline. This value does not affect the Y axis range.

Parameters:: location - base line anchor value based on Y axis.
See Also:: getYAxisBaseline()

getYAxisBaseline

public double getYAxisBaseline()

Returns the base line anchor for Y axis.

Returns:: Y axis base line anchor value.
See Also:: setYAxisBaseline(double)

setY2AxisBaseline

public void setY2AxisBaseline(double location)

Sets the base line anchor position for the secondary Y axis. If interpolation on MarkerStyle is set to MarkerStyle.INTERPOLATION_VERTICAL_NEEDLES then a horizontal base line is drawn passing through the anchor on the Y2 axis. All the X-y2 data points are joined to this base line using vertical needles. See the description section to find out how to modify marker interpolation properties. The Default value is Double.NEGATIVE_INFINITY. This treats X axis as baseline. This value does not affect the Y2 axis range.

Parameters:: location - base line anchor value based on Y2 axis.
See Also:: getY2AxisBaseline()

getY2AxisBaseline

public double getY2AxisBaseline()

Returns the base line anchor for Y2 axis.

Returns:: Y2 axis base line anchor value.
See Also:: setY2AxisBaseline(double)

setMarkerEnabled

public void setMarkerEnabled(boolean enabledFlag)

Sets the markers for the data points enabled. Default value is true. If this is set to true then the markers are displayed to represent data points. Otherwise, no marker is displayed. Marker properties are stored in markerStyles list inside DataElementStyles. See Plot Markers find out how to get and modify marker properties.

Parameters:: enabledFlag - true to show the markers.
See Also:: isMarkerEnabled()

isMarkerEnabled

public boolean isMarkerEnabled()

Returns if the markers are enabled.

Returns:: true if markers are enabled.
See Also:: setMarkerEnabled(boolean)

setFillAreaEnabled

public void setFillAreaEnabled(boolean enabledFlag)

Sets the area under the plot to be filled or not. The color for the area is same as the color of the plot. See Filled Areas to find out how to get and modify fill properties.

Parameters:: enabledFlag - true to fill the area under the plot.
See Also:: isFillAreaEnabled()

isFillAreaEnabled

public boolean isFillAreaEnabled()

Returns if the area fill under the plot is enabled.

Returns:: true if the area fill under the plot is enabled.
See Also:: setFillAreaEnabled(boolean)

setMinimumMarkerSize

public void setMinimumMarkerSize(com.sas.measures.BaseLength newMinSize)
                          throws java.lang.IllegalArgumentException

Sets the minimum size of the markers. This is used only if the sizeVariable is defined.

Parameters:: newMinSize - minimum size of the markers.
Throws:: java.lang.IllegalArgumentException - if newMinSize is null.
See Also:: getMinimumMarkerSize()

getMinimumMarkerSize

public com.sas.measures.BaseLength getMinimumMarkerSize()

Returns the minimum size of the marker.

Returns:: BaseLength minimum size of the marker
See Also:: setMinimumMarkerSize(com.sas.measures.BaseLength)

setMaximumMarkerSize

public void setMaximumMarkerSize(com.sas.measures.BaseLength newMaxSize)
                          throws java.lang.IllegalArgumentException

Sets the maximum size of the markers. This is used only if the sizeVariable is defined.

Parameters:: newMaxSize - maximum size of the markers
Throws:: java.lang.IllegalArgumentException - if newMaxSize is null.
See Also:: getMaximumMarkerSize()

getMaximumMarkerSize

public com.sas.measures.BaseLength getMaximumMarkerSize()

Returns the maximum size of the marker.

Returns:: the maximum size of the markers
See Also:: setMaximumMarkerSize(com.sas.measures.BaseLength)

setMatchNeedleColor

public void setMatchNeedleColor(boolean newMatchNeedleColor)

Sets whether or not to match color of attached markers for needles. If this is false then color defined in the needleLineStyle is used by the needles. Otherwise the color from the markers is used. Default is true.

Parameters:: newMatchNeedleColor - false if needle uses marker's color.
See Also:: isMatchNeedleColor()

isMatchNeedleColor

public boolean isMatchNeedleColor()

Returns false if needles use color from the property needleLineStyle. Otherwise needles uses the color from the markers to which they are attached.

Returns:: true if needle use marker's color
See Also:: setMatchNeedleColor(boolean)

setNeedleLineStyle

public void setNeedleLineStyle(LineStyle newNeedleLineStyle)
                        throws java.lang.IllegalArgumentException

Set the needle appearance properties (color, thickness) that is applied to the needles on the marker elements. Needles are displayed if both of the following hold:

interpolationEnabled property is set to true.
interpolation property in the MarkerStyle is set to MarkerStyle.INTERPOLATION_VERTICAL_NEEDLES or MarkerStyle.INTERPOLATION_HORIZONTAL_NEEDLES.

Parameters:: newNeedleLineStyle - the lineStyle for the needle's display attributes.
Throws:: java.lang.IllegalArgumentException - if newNeedleStyle is null.
See Also:: getNeedleLineStyle(), LineStyle.apply(com.sas.graphics.components.LineStyle), MarkerStyle.setInterpolation(int)

getNeedleLineStyle

public LineStyle getNeedleLineStyle()

Return the line appearance properties (color and thickness) that is applied to the needles attached to the markers.

Returns:: line attributes for the needles.
See Also:: setNeedleLineStyle(com.sas.graphics.components.LineStyle)

setMatchErrorColor

public void setMatchErrorColor(boolean newMatchErrorColor)

Sets the error-markers and error-lines to use color from the markers to which they are attached. If this is false then errorlines get the color from errorLineStyles in dataElementStyles. This can be accessed using following code:

 StrokeLineStyle[] errorStyles = scatterPlotModel.getDataElementStyles.getErrorLineStyles() ;

The colors are assigned based on the following rules:

If there is only one element in errorStyles , then everybody gets the color from this element.
If number of elements in errorStyles is two or more but less than four, then LeftError and UpError get the color from the first element and RightError and DownError get the color from the second element.
If there are four or more elements in errorStyles , then LeftError gets the color from first element, RightError gets it from second element, UpError gets it from third element and DownError gets it from fourth element.

Similarly errorMarkers gets the color from errorMarkerStyles defined in dataElementStyles. If this is true, then everybody uses the color from the markers to which the error-data is associated with. Default is false.

Parameters:: newMatchErrorColor - false to use error-color to display error-lines and markers.
See Also:: isMatchErrorColor()

isMatchErrorColor

public boolean isMatchErrorColor()

Returns true if the error-markers and error-lines use color from the markers to which they are attached.

Returns:: false if the error color is used to display error lines and markers.
See Also:: setMatchErrorColor(boolean)

setTopMarkerLabelTextStyle

public void setTopMarkerLabelTextStyle(AdvancedTextStyle textStyle)
                                throws java.lang.IllegalArgumentException

Sets the text appearance model (font, color, justification and base angle) that is applied to the display labels above the markers. This is displayed only if the topMarkerLabelVariable role is set to a valid value or topMarkerLabelContent is set to GraphModel.DATA_LABEL_X or GraphModel.DATA_LABEL_X. Color is used from this property only if the matchMarkerLabelColor property is set to false. If a GraphStyle is applied to its ScatterPlot, then this gets overwritten by the graphStyle's dataLabelTextStyle property.

Parameters:: textStyle - the text attributes for the display values above the markers.
Throws:: java.lang.IllegalArgumentException - if textStyle is null.
See Also:: getTopMarkerLabelTextStyle(), AdvancedTextStyle.apply(com.sas.graphics.components.AdvancedTextStyle), setMatchMarkerLabelColor(boolean)

getTopMarkerLabelTextStyle

public AdvancedTextStyle getTopMarkerLabelTextStyle()

Returns the text appearance model (font, color, justification and base angle) that is applied to the display labels above the markers.

Returns:: text attributes for the value text above the markers.
See Also:: setTopMarkerLabelTextStyle(com.sas.graphics.components.AdvancedTextStyle)

setTopMarkerLabelContent

public void setTopMarkerLabelContent(int newContent)

Sets the type of content displayed at the top of the markers. Valid values are :

   GraphConstants.DATA_LABEL_AUTOMATIC  // displays the topMarkerVariable, if it is defined in ScatterPlotTableDataModel
   GraphConstants.DATA_LABEL_NONE,
   GraphConstants.DATA_LABEL_X                  // displays appropriate X value for each marker
   GraphConstants.DATA_LABEL_Y                  // displays appropriate Y or Y2 value for each marker

Parameters:: newContent - the topMarkerLabel type
Throws:: java.lang.IllegalArgumentException - if an invalid parameter value is specified.
See Also:: getTopMarkerLabelContent()

getTopMarkerLabelContent

public int getTopMarkerLabelContent()

Returns the type of content in label displayed at the top of the marker.

Returns:: the type of topMarkerLabel
See Also:: setTopMarkerLabelContent(int)

setBottomMarkerLabelTextStyle

public void setBottomMarkerLabelTextStyle(AdvancedTextStyle textStyle)
                                   throws java.lang.IllegalArgumentException

Sets the text appearance model (font, color, justification and base angle) that is applied to the display labels below the markers. This is displayed only if the bottomMarkerLabelVariable role is set to a valid value or bottomMarkerLabelContent is set to GraphModel.DATA_LABEL_X or GraphModel.DATA_LABEL_X. Color is used from this property only if the matchMarkerLabelColor property is set to false. If a GraphStyle is applied to a ScatterPlot, then this gets overwritten by the graphStyle's dataLabelTextStyle property.

Parameters:: textStyle - the new attributes for the values below the markers.
Throws:: java.lang.IllegalArgumentException - if textStyle is null.
See Also:: getBottomMarkerLabelTextStyle(), AdvancedTextStyle.apply(com.sas.graphics.components.AdvancedTextStyle), setMatchMarkerLabelColor(boolean)

getBottomMarkerLabelTextStyle

public AdvancedTextStyle getBottomMarkerLabelTextStyle()

Returns the text appearance model (font, color, justification and base angle) that is applied to the value below the markers.

Returns:: text attributes for the value below the markers.
See Also:: setBottomMarkerLabelTextStyle(com.sas.graphics.components.AdvancedTextStyle)

setBottomMarkerLabelContent

public void setBottomMarkerLabelContent(int newContent)

Sets the type of content displayed below the markers. Valid values are :

   GraphConstants.DATA_LABEL_AUTOMATIC  // displays the bottomMarkerVariable, if it is defined in ScatterPlotTableDataModel
   GraphConstants.DATA_LABEL_NONE,
   GraphConstants.DATA_LABEL_X                  // displays appropriate X value for each marker
   GraphConstants.DATA_LABEL_Y                  // displays appropriate Y or Y2 value for each marker

Parameters:: newContent - the bottomMarkerLabel type
Throws:: java.lang.IllegalArgumentException - if an invalid parameter value is specified.
See Also:: getBottomMarkerLabelContent()

getBottomMarkerLabelContent

public int getBottomMarkerLabelContent()

Returns the type of content in label displayed below the markers.

Returns:: the type of bottomMarkerLabel
See Also:: setBottomMarkerLabelContent(int)

setMatchMarkerLabelColor

public void setMatchMarkerLabelColor(boolean newMatchMarkerLabelColor)

Sets the color used by the marker labels attached to data points. If this is false then color defined in the TopMarkerLabelTextStyle and BottomMarkerLabelTextStyle are used by the label above and below the markers respectively. Otherwise the color from the markers is used. Default is true.

Parameters:: newMatchMarkerLabelColor - true if marker labels use markers' color.
See Also:: isMatchMarkerLabelColor()

isMatchMarkerLabelColor

public boolean isMatchMarkerLabelColor()

Returns true if marker labels use color from the markers to which they are labeling. If this is false then the color defined in the TopMarkerTextStyle and BottomMarkerTextStyle are used.

Returns:: true if labels use marker's color
See Also:: setMatchMarkerLabelColor(boolean)

setSkipMissing

public void setSkipMissing(boolean skipMissingFlag)

Sets if the missing values are skipped keeping the plot as single joined line or break the plot at the missing values. Default is true.

Parameters:: skipMissingFlag - true if skip the missing values is desired.
See Also:: isSkipMissing()

isSkipMissing

public boolean isSkipMissing()

Returns true if the missing values are skipped keeping the plot as single joined line. Default is true.

Returns:: true if the ScatterPlot skips the missing values.
See Also:: setSkipMissing(boolean)

setUniformEnabled

public void setUniformEnabled(boolean newUniformEnabled)

Sets whether or not the axis values are identical between all cells.

Parameters:: newUniformEnabled - The uniformEnabled to set
See Also:: isUniformEnabled()

isUniformEnabled

public boolean isUniformEnabled()

Returns whether or not the category axis values are identical between all cells.

Returns:: boolean whether or not the axis values are identical between all cells.
See Also:: setUniformEnabled(boolean)

hashCode

public int hashCode()

Returns the hash code for this instance.

Overrides:: hashCode in class GraphModel

Returns:: a hash code value for this object.

setMissingPolicy

public void setMissingPolicy(int newMissingPolicy)
                      throws java.lang.IllegalArgumentException

Sets the graph behavior for displaying missing values. (Similar to the server side "missing" statement in prog gchart.)
Valid values are:

GraphConstants.AUTOMATIC (default)
GraphConstants.TRUE
GraphConstants.FALSE

GraphConstants.AUTOMATIC is the same as the server side proc gplot default (which is to display all classification variable missing values but not to display plot variables (X and Y) missing values).
GraphConstants.TRUE is the same as GraphConstants.AUTOMATIC with the exception that if the X and/or Y axes are non-continuous then missing X and/or Y values will appear on the corresponding axes.
GraphConstants.FALSE will filter out the missing classification variables and not display the missing plot values.

Special note:
The following String values are interpreted as missing values:

null
com.sas.MissingValues objects
zero length string
a string containing only spaces

The following Number values are interpreted as missing values:

null
com.sas.MissingValues objects
a non-Number objects in a Number data column
Double.NaN
Double.POSITIVE_INFINITY
Double.NEGATIVE_INFINITY

Throws:: java.lang.IllegalArgumentException - if newMissing is invalid.
See Also:: getMissingPolicy()

getMissingPolicy

public int getMissingPolicy()

Returns the graph behavior for displaying missing values. See setMissingPolicy() for the list of valid missing value policies.

Returns:: how to display missing values.
See Also:: setMissingPolicy(int)

setSkin

public void setSkin(int newSkin)
             throws java.lang.IllegalArgumentException

Set the style of skin to modify the marker appearance. Valid values are:
GraphConstants.SKIN_AUTOMATIC GraphConstants.SKIN_NONE GraphConstants.SKIN_SATIN GraphConstants.SKIN_MODERN

The default is GraphConstants.SKIN_AUTOMATIC.

Parameters:: newSkin - Which skin style to use
Throws:: java.lang.IllegalArgumentException - if newSkin is invalid.
See Also:: getSkin()

getSkin

public int getSkin()

Get the style used to modify the displayed markers.

Returns:: skin style to be used.
See Also:: setSkin(int)

equals

public boolean equals(java.lang.Object obj)

Determines whether another object is equal to this ScatterPlotModel.

The result is true if and only if the argument is not null and is a ScatterPlotModel object that has the same properties as this object.

Overrides:: equals in class GraphModel

Parameters:: obj - the object to test for equality with this ScatterPlotModel
Returns:: true if the objects are the same; false otherwise.