Documentation of 'sgtplot.plot.PlotLayerHints' Java class
PlotLayerHints
Skip navigation links
sgtplot.plot

Class PlotLayerHints

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map

    public class PlotLayerHints
extends java.lang.Object
implements java.util.Map, java.lang.Cloneable
    Since:
    2.x

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K,V>

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String KEY_ASPECT_RATIO
      AspectRatio hint key
      static java.lang.String KEY_LAYER_PLACEMENT
      Layer Placement hint key
      static java.lang.String KEY_PLOTKEY_LOCATION
      PlotKey location hint key
      static java.lang.String KEY_PLOTKEY_TYPE
      PlotKey Type hint key
      static java.lang.String KEY_X_AXIS_LOCATION
      Axis location should actually go through a series of steps X Axis Location 1) bottom of plot region 2) top of plot region 3) below bottom axis (increase border if needed) 4) above top axis (increase border if needed) Y Axis Locations 1) left of plot region 2) right of plot region 3) outside left axis (increase border if needed) 4) outside right axis (increase border if needed) X Axis Location hint key
      static java.lang.String KEY_X_TRANSFORM
      Decision to create a new transform or re-use an existing transform should follow the following steps 1) Use transform from same LayerStack 2) Use transform from same JPlotPane 3) Create a new transform to use existing transform 1) both must be space or both time (test cant be defeated) 2) must have units that are convertable to existing transform 3) must have identical units X Transform hint key
      static java.lang.String KEY_Y_AXIS_LOCATION
      Y Axis Location hint key
      static java.lang.String KEY_Y_TRANSFORM
      Y Transform hint key
      static java.lang.String VALUE_ASPECT_RATIO_LOCK
      AspecRatio hint values -- lock X and Y scales
      static java.lang.String VALUE_ASPECT_RATIO_NO_LOCK
      AspecRatio hint values -- dont lock X and Y scales (during resize)
      static java.lang.String VALUE_LAYER_PLACEMENT_OVERLAY
      Layer Placement hint values -- overlay
      static java.lang.String VALUE_PLOTKEY_IN_POPUP
      PlotKey Type hint values -- in pop-up window
      static java.lang.String VALUE_PLOTKEY_IN_TABLE
      PlotKey Type hint values -- in JTable
      static java.lang.String VALUE_PLOTKEY_NONE
      PlotKey Type hint values -- no key
      static java.lang.String VALUE_PLOTKEY_ON_LAYER
      PlotKey Type hint values -- on layer
      static java.lang.String VALUE_PLOTKEY_ON_SEPERATE_LAYER
      PlotKey Type hint values -- on seperate layer
      static java.lang.String VALUE_X_AXIS_LOCATION_BOTTOM
      X Axis Location hint values -- bottom
      static java.lang.String VALUE_X_AXIS_LOCATION_DEFAULT
      X Axis Location hint values -- default First try bottom, top, below bottom, then above top
      static java.lang.String VALUE_X_AXIS_LOCATION_TOP
      X Axis Location hint values -- top
      static java.lang.String VALUE_X_TRANSFORM_DEFAULT
      X Transform hint values -- default First try LayerStack, JPlotPane, then create new transform
      static java.lang.String VALUE_X_TRANSFORM_NEW
      X Transform hint values -- new
      static java.lang.String VALUE_X_TRANSFORM_USEPLOTPANE
      X Transform hint values -- use JPlotPane
      static java.lang.String VALUE_Y_AXIS_LOCATION_DEFAULT
      Y Axis Location hint values -- default First try left, right, outside right, then outside left
      static java.lang.String VALUE_Y_AXIS_LOCATION_LEFT
      Y Axis Location hint values -- left
      static java.lang.String VALUE_Y_AXIS_LOCATION_RIGHT
      Y Axis Location hint values -- right
      static java.lang.String VALUE_Y_TRANSFORM_DEFAULT
      Y Transform hint values -- default First try LayerStack, JPlotPane, then create new transform
      static java.lang.String VALUE_Y_TRANSFORM_NEW
      Y Transform hint values -- new
      static java.lang.String VALUE_Y_TRANSFORM_USEPLOTPANE
      Y Transform hint values -- use JPlotPane

    • Constructor Summary

      Constructors 
      Constructor and Description
      PlotLayerHints(java.util.Map init) 
      PlotLayerHints(java.lang.String key, java.lang.String value) 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void add(PlotLayerHints hints) 
      void clear() 
      java.lang.Object clone() 
      boolean containsKey(java.lang.Object key) 
      boolean containsValue(java.lang.Object value) 
      java.util.Set entrySet() 
      boolean equals(java.lang.Object o) 
      java.lang.Object get(java.lang.Object key) 
      int hashCode() 
      boolean isEmpty() 
      java.util.Set keySet() 
      java.lang.Object put(java.lang.Object key, java.lang.Object value) 
      void putAll(java.util.Map m) 
      java.lang.Object remove(java.lang.Object key) 
      int size() 
      java.lang.String toString() 
      java.util.Collection values() 

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Field Detail

      • KEY_PLOTKEY_TYPE

        public static final java.lang.String KEY_PLOTKEY_TYPE
        PlotKey Type hint key
        See Also:
        Constant Field Values

      • VALUE_PLOTKEY_ON_LAYER

        public static final java.lang.String VALUE_PLOTKEY_ON_LAYER
        PlotKey Type hint values -- on layer
        See Also:
        Constant Field Values

      • VALUE_PLOTKEY_ON_SEPERATE_LAYER

        public static final java.lang.String VALUE_PLOTKEY_ON_SEPERATE_LAYER
        PlotKey Type hint values -- on seperate layer
        See Also:
        Constant Field Values

      • VALUE_PLOTKEY_IN_POPUP

        public static final java.lang.String VALUE_PLOTKEY_IN_POPUP
        PlotKey Type hint values -- in pop-up window
        See Also:
        Constant Field Values

      • VALUE_PLOTKEY_IN_TABLE

        public static final java.lang.String VALUE_PLOTKEY_IN_TABLE
        PlotKey Type hint values -- in JTable
        See Also:
        Constant Field Values

      • VALUE_PLOTKEY_NONE

        public static final java.lang.String VALUE_PLOTKEY_NONE
        PlotKey Type hint values -- no key
        See Also:
        Constant Field Values

      • KEY_PLOTKEY_LOCATION

        public static final java.lang.String KEY_PLOTKEY_LOCATION
        PlotKey location hint key
        See Also:
        Constant Field Values

      • KEY_LAYER_PLACEMENT

        public static final java.lang.String KEY_LAYER_PLACEMENT
        Layer Placement hint key
        See Also:
        Constant Field Values

      • VALUE_LAYER_PLACEMENT_OVERLAY

        public static final java.lang.String VALUE_LAYER_PLACEMENT_OVERLAY
        Layer Placement hint values -- overlay
        See Also:
        Constant Field Values

      • KEY_ASPECT_RATIO

        public static final java.lang.String KEY_ASPECT_RATIO
        AspectRatio hint key
        See Also:
        Constant Field Values

      • VALUE_ASPECT_RATIO_LOCK

        public static final java.lang.String VALUE_ASPECT_RATIO_LOCK
        AspecRatio hint values -- lock X and Y scales
        See Also:
        Constant Field Values

      • VALUE_ASPECT_RATIO_NO_LOCK

        public static final java.lang.String VALUE_ASPECT_RATIO_NO_LOCK
        AspecRatio hint values -- dont lock X and Y scales (during resize)
        See Also:
        Constant Field Values

      • KEY_X_AXIS_LOCATION

        public static final java.lang.String KEY_X_AXIS_LOCATION
        Axis location should actually go through a series of steps X Axis Location 1) bottom of plot region 2) top of plot region 3) below bottom axis (increase border if needed) 4) above top axis (increase border if needed) Y Axis Locations 1) left of plot region 2) right of plot region 3) outside left axis (increase border if needed) 4) outside right axis (increase border if needed) X Axis Location hint key
        See Also:
        Constant Field Values

      • VALUE_X_AXIS_LOCATION_DEFAULT

        public static final java.lang.String VALUE_X_AXIS_LOCATION_DEFAULT
        X Axis Location hint values -- default First try bottom, top, below bottom, then above top
        See Also:
        Constant Field Values

      • VALUE_X_AXIS_LOCATION_BOTTOM

        public static final java.lang.String VALUE_X_AXIS_LOCATION_BOTTOM
        X Axis Location hint values -- bottom
        See Also:
        Constant Field Values

      • VALUE_X_AXIS_LOCATION_TOP

        public static final java.lang.String VALUE_X_AXIS_LOCATION_TOP
        X Axis Location hint values -- top
        See Also:
        Constant Field Values

      • KEY_Y_AXIS_LOCATION

        public static final java.lang.String KEY_Y_AXIS_LOCATION
        Y Axis Location hint key
        See Also:
        Constant Field Values

      • VALUE_Y_AXIS_LOCATION_DEFAULT

        public static final java.lang.String VALUE_Y_AXIS_LOCATION_DEFAULT
        Y Axis Location hint values -- default First try left, right, outside right, then outside left
        See Also:
        Constant Field Values

      • VALUE_Y_AXIS_LOCATION_LEFT

        public static final java.lang.String VALUE_Y_AXIS_LOCATION_LEFT
        Y Axis Location hint values -- left
        See Also:
        Constant Field Values

      • VALUE_Y_AXIS_LOCATION_RIGHT

        public static final java.lang.String VALUE_Y_AXIS_LOCATION_RIGHT
        Y Axis Location hint values -- right
        See Also:
        Constant Field Values

      • KEY_X_TRANSFORM

        public static final java.lang.String KEY_X_TRANSFORM
        Decision to create a new transform or re-use an existing transform should follow the following steps 1) Use transform from same LayerStack 2) Use transform from same JPlotPane 3) Create a new transform to use existing transform 1) both must be space or both time (test cant be defeated) 2) must have units that are convertable to existing transform 3) must have identical units X Transform hint key
        See Also:
        Constant Field Values

      • VALUE_X_TRANSFORM_DEFAULT

        public static final java.lang.String VALUE_X_TRANSFORM_DEFAULT
        X Transform hint values -- default First try LayerStack, JPlotPane, then create new transform
        See Also:
        Constant Field Values

      • VALUE_X_TRANSFORM_NEW

        public static final java.lang.String VALUE_X_TRANSFORM_NEW
        X Transform hint values -- new
        See Also:
        Constant Field Values

      • VALUE_X_TRANSFORM_USEPLOTPANE

        public static final java.lang.String VALUE_X_TRANSFORM_USEPLOTPANE
        X Transform hint values -- use JPlotPane
        See Also:
        Constant Field Values

      • KEY_Y_TRANSFORM

        public static final java.lang.String KEY_Y_TRANSFORM
        Y Transform hint key
        See Also:
        Constant Field Values

      • VALUE_Y_TRANSFORM_DEFAULT

        public static final java.lang.String VALUE_Y_TRANSFORM_DEFAULT
        Y Transform hint values -- default First try LayerStack, JPlotPane, then create new transform
        See Also:
        Constant Field Values

      • VALUE_Y_TRANSFORM_NEW

        public static final java.lang.String VALUE_Y_TRANSFORM_NEW
        Y Transform hint values -- new
        See Also:
        Constant Field Values

      • VALUE_Y_TRANSFORM_USEPLOTPANE

        public static final java.lang.String VALUE_Y_TRANSFORM_USEPLOTPANE
        Y Transform hint values -- use JPlotPane
        See Also:
        Constant Field Values

    • Constructor Detail

      • PlotLayerHints

        public PlotLayerHints(java.util.Map init)

      • PlotLayerHints

        public PlotLayerHints(java.lang.String key,
                      java.lang.String value)

    • Method Detail

      • size

        public int size()
        Specified by:
        size in interface java.util.Map

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Map

      • containsKey

        public boolean containsKey(java.lang.Object key)
        Specified by:
        containsKey in interface java.util.Map

      • containsValue

        public boolean containsValue(java.lang.Object value)
        Specified by:
        containsValue in interface java.util.Map

      • get

        public java.lang.Object get(java.lang.Object key)
        Specified by:
        get in interface java.util.Map

      • put

        public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
        Specified by:
        put in interface java.util.Map

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map

      • remove

        public java.lang.Object remove(java.lang.Object key)
        Specified by:
        remove in interface java.util.Map

      • putAll

        public void putAll(java.util.Map m)
        Specified by:
        putAll in interface java.util.Map

      • keySet

        public java.util.Set keySet()
        Specified by:
        keySet in interface java.util.Map

      • values

        public java.util.Collection values()
        Specified by:
        values in interface java.util.Map

      • entrySet

        public java.util.Set entrySet()
        Specified by:
        entrySet in interface java.util.Map

      • equals

        public boolean equals(java.lang.Object o)
        Specified by:
        equals in interface java.util.Map
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map
        Overrides:
        hashCode in class java.lang.Object

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
Skip navigation links

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.