Class StyleKeys


  • public class StyleKeys
    extends java.lang.Object
    Contains many common config keys and associated utility methods.
    Since:
    25 Feb 2013
    Author:
    Mark Taylor
    • Field Detail

      • MARK_SHAPE

        public static final ConfigKey<MarkShape> MARK_SHAPE
        Config key for marker shape.
      • SIZE

        public static final ConfigKey<java.lang.Integer> SIZE
        Config key for marker size.
      • XYSHAPE

        public static final ConfigKey<XYShape> XYSHAPE
        Config key for XY shape.
      • COLOR

        public static final ConfigKey<java.awt.Color> COLOR
        Config key for style colour.
      • OPAQUE

        public static final ConfigKey<java.lang.Double> OPAQUE
        Config key for the opacity limit of transparent plots. This is the number of times a point has to be hit to result in a saturated (opaque) pixel.
      • AUX_OPAQUE

        public static final ConfigKey<java.lang.Double> AUX_OPAQUE
        Config key for the opacity limit of auxiliary shaded plots.
      • TRANSPARENT_LEVEL

        public static final ConfigKey<java.lang.Double> TRANSPARENT_LEVEL
        Config key for transparency level of adaptive transparent plots.
      • TRANSPARENCY

        public static final ConfigKey<java.lang.Double> TRANSPARENCY
        Config key for "normal" transparency - it's just 1-alpha.
      • DASH

        public static final ConfigKey<float[]> DASH
        Config key for line dash style.
      • GRID_COLOR

        public static final ConfigKey<java.awt.Color> GRID_COLOR
        Config key for axis grid colour.
      • AXLABEL_COLOR

        public static final ConfigKey<java.awt.Color> AXLABEL_COLOR
        Config key for axis label colour.
      • CUMULATIVE

        public static final ConfigKey<java.lang.Boolean> CUMULATIVE
        Config key for cumulative histogram flag.
      • NORMALISE

        public static final ConfigKey<Normalisation> NORMALISE
        Config key for histogram normalisation mode on generic axis.
      • ANTIALIAS

        public static final ConfigKey<java.lang.Boolean> ANTIALIAS
        Config key for line antialiasing.
      • GRID_ANTIALIAS

        public static final ConfigKey<java.lang.Boolean> GRID_ANTIALIAS
        Config key for axis grid antialiasing.
      • ANCHOR

        public static final ConfigKey<Anchor> ANCHOR
        Config key for text anchor positioning.
      • LEVEL_MODE

        public static final ConfigKey<LevelMode> LEVEL_MODE
        Config key for scaling level mode.
      • VECTOR_SHAPE

        public static final MultiPointConfigKey VECTOR_SHAPE
        Config key for vector marker style.
      • ELLIPSE_SHAPE

        public static final MultiPointConfigKey ELLIPSE_SHAPE
        Config key for ellipse marker style.
      • ERROR_SHAPE_1D

        public static final MultiPointConfigKey ERROR_SHAPE_1D
        Config key for 1d (vertical) error marker style.
      • ERROR_SHAPE_2D

        public static final MultiPointConfigKey ERROR_SHAPE_2D
        Config key for 2d error marker style.
      • ERROR_SHAPE_3D

        public static final MultiPointConfigKey ERROR_SHAPE_3D
        Config key for 3d error marker style.
      • AUX_CROWD

        public static final ConfigKey<java.lang.Double> AUX_CROWD
        Config key for aux axis tick crowding.
      • SHADE_LOW

        public static final ConfigKey<java.lang.Double> SHADE_LOW
        Config key for aux shader lower limit.
      • SHADE_HIGH

        public static final ConfigKey<java.lang.Double> SHADE_HIGH
        Config key for aux shader upper limit.
      • SHADE_SUBRANGE

        public static final ConfigKey<Subrange> SHADE_SUBRANGE
        Config key for aux shader subrange.
      • AUX_NULLCOLOR

        public static final ConfigKey<java.awt.Color> AUX_NULLCOLOR
        Config key for aux null colour.
      • SCALE

        public static final ConfigKey<java.lang.Double> SCALE
        Config key for scaling of markers in data space.
      • SCALE_PIX

        public static final ConfigKey<java.lang.Double> SCALE_PIX
        Config key for scaling of markers in pixel space.
      • AUTOSCALE

        public static final ConfigKey<java.lang.Boolean> AUTOSCALE
        Config key for autoscale flag for markers in data space.
      • AUTOSCALE_PIX

        public static final ConfigKey<java.lang.Boolean> AUTOSCALE_PIX
        Config key for autoscale flag for markers in pixel space.
      • LABEL

        public static final ConfigKey<java.lang.String> LABEL
        Config key for a layer label string.
      • SHOW_LABEL

        public static final ConfigKey<java.lang.Boolean> SHOW_LABEL
        Config key for legend inclusion flag.
      • MINOR_TICKS

        public static final ConfigKey<java.lang.Boolean> MINOR_TICKS
        Config key for minor tick drawing key.
      • ZOOM_FACTOR

        public static final ConfigKey<java.lang.Double> ZOOM_FACTOR
        Config key for zoom factor.
      • CAPTIONER

        public static final CaptionerKeySet CAPTIONER
        Config key set for axis and general captioner.
      • AUX_RAMP

        public static final RampKeySet AUX_RAMP
        Config key set for global Aux axis colour ramp.
      • DENSITY_RAMP

        public static final RampKeySet DENSITY_RAMP
        Config key set for density point shading.
    • Method Detail

      • createStroke

        public static java.awt.Stroke createStroke​(ConfigMap config,
                                                   int cap,
                                                   int join)
        Obtains a line drawing stroke based on a config map. The keys used are those returned by getStrokeKeys. The line join and cap policy must be provided.
        Parameters:
        config - config map
        cap - one of BasicStroke's CAP_* constants
        join - one of BasicStroke's JOIN_* constants
        Returns:
        stroke
      • createCrowdKey

        public static ConfigKey<java.lang.Double> createCrowdKey​(ConfigMeta meta)
        Returns an axis tick mark crowding config key.
        Parameters:
        meta - metadata
        Returns:
        new key
      • createAxisLabelKey

        public static ConfigKey<java.lang.String> createAxisLabelKey​(java.lang.String axName)
        Returns an axis labelling config key.
        Parameters:
        axName - axis name
        Returns:
        new key
      • createNullColorKey

        public static ConfigKey<java.awt.Color> createNullColorKey​(java.lang.String axname,
                                                                   java.lang.String axName)
        Returns a key for acquiring a colour used in place of a shading ramp colour in case that the input data is null.
        Parameters:
        axname - short form of axis name, used in text parameter names
        axName - long form of axis name, used in descriptions
        Returns:
        new key
      • createThicknessKey

        public static ConfigKey<java.lang.Integer> createThicknessKey​(int dfltThick)
        Returns a config key for line thickness with a given default value.
        Parameters:
        dfltThick - default value for line width in pixels
        Returns:
        new config key
      • getAlphaColor

        public static java.awt.Color getAlphaColor​(ConfigMap config,
                                                   ConfigKey<java.awt.Color> colorKey,
                                                   ConfigKey<java.lang.Double> transparencyKey)
        Returns a colour specified by a basic colour key and a transparency key.
        Parameters:
        config - config map
        colorKey - key for colour, for instance COLOR
        transparencyKey - key for 1-alpha, for instance TRANSPARENCY
      • createAuxShaders

        public static ClippedShader[] createAuxShaders()
        Returns a list of shaders suitable for aux axis shading.
        Returns:
        shaders