com.ibm.tivoli.maximo.skd.control.chart

Class Axis

  • java.lang.Object
    • java.util.AbstractMap
      • java.util.HashMap
        • com.ibm.json.java.JSONObject
          • com.ibm.tivoli.maximo.skd.control.chart.Axis
  • All Implemented Interfaces:
    com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map

    public class Axis
extends com.ibm.json.java.JSONObject
    Represents the Chart Axis.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry, java.util.AbstractMap.SimpleImmutableEntry

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

        java.util.Map.Entry

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String DROP_LABELS
      dropLabels (Boolean, optional): Whether the axis automatically drops labels at regular interval or not to avoid labels overlapping.
      static java.lang.String ENABLE_CACHE
      enableCache (Boolean, optional): Whether the ticks and labels are cached from one rendering to another.
      static java.lang.String FIX_LOWER
      (String, optional): Align the smallest value on the axis with the specified tick level.
      static java.lang.String FIX_UPPER
      (String, optional): Align the greatest value on the axis with the specified tick level.
      static java.lang.String FIXED
      fixed (Boolean, optional): Force all axis labels to be fixed numbers.
      static java.lang.String FONT
      font (String, optional): An optional font definition (as used in the CSS font property) for labels.
      static java.lang.String FONT_COLOR
      fontColor (String|dojo.Color, optional): An optional color to be used in drawing labels.
      static java.lang.String FROM
      from (Number, optional): Force the chart to render data visible from this value.
      static java.lang.String HTML_LABELS
      htmlLabels (Boolean, optional): Flag to use HTML (as opposed to the native vector graphics engine) to draw labels.
      static java.lang.String ID
      Unique Id for the Axis
      static java.lang.String INCLUDE_ZERO
      includeZero (Boolean, optional): Include 0 on the axis rendering.
      static java.lang.String LABEL_FUNC
      labelFunc (Function, optional): An optional function to use to compute label text.
      static java.lang.String LABEL_SIZE_CHANGE
      labelSizeChange (Boolean, optional): Indicates to the axis whether the axis labels are changing their size on zoom.
      static java.lang.String LABELS
      labels (Object[], optional): An array of labels for major ticks, with corresponding numeric values, ordered by value.
      static java.lang.String LEFT_BOTTOM
      (Boolean, optional): The position of a vertical axis; if true, will be placed against the left-bottom corner of the chart.
      static java.lang.String MAJOR_LABELS
      majorLabels (Boolean, optional): Flag to draw labels at major ticks.
      static java.lang.String MAJOR_TICK
      majorTick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a major tick.
      static java.lang.String MAJOR_TICK_STEP
      majorTickStep (Number, optional): The amount to skip before a major tick is drawn.
      static java.lang.String MAX
      max (Number, optional): The largest value on an axis.
      static java.lang.String MAX_LABEL_SIZE
      maxLabelSize (Number, optional):The maximum size, in pixels, for a label.
      static java.lang.String MICRO_TICK
      microTick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a micro tick.
      static java.lang.String MICRO_TICK_STEP
      microTickStep (Number, optional): The amount to skip before a micro tick is drawn.
      static java.lang.String MICRO_TICKS
      microTicks (Boolean, optional): Flag to draw micro ticks on an axis.
      static java.lang.String MIN
      min (Number, optional): The smallest value on an axis.
      static java.lang.String MINOR_LABELS
      minorLabels (Boolean, optional): Flag to labels on minor ticks when there is enough space.
      static java.lang.String MINOR_TICK
      minorTick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a minor tick.
      static java.lang.String MINOR_TICK_STEP
      minorTickStep (Number, optional): The amount to skip before a minor tick is drawn.
      static java.lang.String MINOR_TICKS
      minorTicks (Boolean, optional): Flag to draw minor ticks on an axis.
      static java.lang.String NATURAL
      (Boolean, optional): Ensure tick marks are made on "natural" numbers.
      static java.lang.String STROKE
      stroke ([JSONObject Value(type: object, value: undefined)], optional): An optional stroke to be used for drawing an axis.
      static java.lang.String TICK
      tick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a tick.
      static java.lang.String TITLE_FONT
      titleFont (String, optional): An optional font definition for axis title
      static java.lang.String TITLE_FONT_COLOR
      titleFontColor (String, optional): An optional axis title color
      static java.lang.String TITLE_GAP
      titleGap (Number, optional): An optional grap between axis title and axis label
      static java.lang.String TITLE_ORIENTATION
      titleOrientation (String, optional): An optional orientation for axis title.
      static java.lang.String TO
      to (Number, optional): Force the chart to render data visible to this value.
      static java.lang.String VERTICAL
      (Boolean, optional): A flag that says whether an axis is vertical (i.e.

    • Constructor Summary

      Constructors 
      Constructor and Description
      Axis(java.lang.String axisId)
      Creates a new Axis object with the given id, usually 'x', or 'y'

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static Axis newXAxis()
      Creates a newly configured X Axis, with ONLY major ticks and labels, and no 0
      static Axis newYAxis()
      creates a newly configured Y axis

      • Methods inherited from class com.ibm.json.java.JSONObject

        isValidObject, isValidType, parse, parse, parse, put, serialize, serialize, serialize, serialize, serialize, serialize, toString

      • Methods inherited from class java.util.HashMap

        clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • Methods inherited from class java.util.AbstractMap

        equals, hashCode

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        equals, hashCode

    • Field Detail

      • VERTICAL

        public static final java.lang.String VERTICAL
        (Boolean, optional): A flag that says whether an axis is vertical (i.e. y axis) or horizontal. Default is false (horizontal).
        See Also:
        Constant Field Values

      • FIX_UPPER

        public static final java.lang.String FIX_UPPER
        (String, optional): Align the greatest value on the axis with the specified tick level. Options are "major", "minor", "micro", or "none". Defaults to "none".
        See Also:
        Constant Field Values

      • FIX_LOWER

        public static final java.lang.String FIX_LOWER
        (String, optional): Align the smallest value on the axis with the specified tick level. Options are "major", "minor", "micro", or "none". Defaults to "none".
        See Also:
        Constant Field Values

      • NATURAL

        public static final java.lang.String NATURAL
        (Boolean, optional): Ensure tick marks are made on "natural" numbers. Defaults to false.
        See Also:
        Constant Field Values

      • LEFT_BOTTOM

        public static final java.lang.String LEFT_BOTTOM
        (Boolean, optional): The position of a vertical axis; if true, will be placed against the left-bottom corner of the chart. Defaults to true.
        See Also:
        Constant Field Values

      • INCLUDE_ZERO

        public static final java.lang.String INCLUDE_ZERO
        includeZero (Boolean, optional): Include 0 on the axis rendering. Default is false.
        See Also:
        Constant Field Values

      • FIXED

        public static final java.lang.String FIXED
        fixed (Boolean, optional): Force all axis labels to be fixed numbers. Default is true.
        See Also:
        Constant Field Values

      • MAJOR_LABELS

        public static final java.lang.String MAJOR_LABELS
        majorLabels (Boolean, optional): Flag to draw labels at major ticks. Default is true.
        See Also:
        Constant Field Values

      • MINOR_TICKS

        public static final java.lang.String MINOR_TICKS
        minorTicks (Boolean, optional): Flag to draw minor ticks on an axis. Default is true.
        See Also:
        Constant Field Values

      • MINOR_LABELS

        public static final java.lang.String MINOR_LABELS
        minorLabels (Boolean, optional): Flag to labels on minor ticks when there is enough space. Default is true.
        See Also:
        Constant Field Values

      • MICRO_TICKS

        public static final java.lang.String MICRO_TICKS
        microTicks (Boolean, optional): Flag to draw micro ticks on an axis. Default is false.
        See Also:
        Constant Field Values

      • HTML_LABELS

        public static final java.lang.String HTML_LABELS
        htmlLabels (Boolean, optional): Flag to use HTML (as opposed to the native vector graphics engine) to draw labels. Default is true.
        See Also:
        Constant Field Values

      • MIN

        public static final java.lang.String MIN
        min (Number, optional): The smallest value on an axis. Default is 0.
        See Also:
        Constant Field Values

      • MAX

        public static final java.lang.String MAX
        max (Number, optional): The largest value on an axis. Default is 1.
        See Also:
        Constant Field Values

      • FROM

        public static final java.lang.String FROM
        from (Number, optional): Force the chart to render data visible from this value. Default is 0.
        See Also:
        Constant Field Values

      • TO

        public static final java.lang.String TO
        to (Number, optional): Force the chart to render data visible to this value. Default is 1.
        See Also:
        Constant Field Values

      • MAJOR_TICK_STEP

        public static final java.lang.String MAJOR_TICK_STEP
        majorTickStep (Number, optional): The amount to skip before a major tick is drawn. When not set the major ticks step is computed from the data range.
        See Also:
        Constant Field Values

      • MINOR_TICK_STEP

        public static final java.lang.String MINOR_TICK_STEP
        minorTickStep (Number, optional): The amount to skip before a minor tick is drawn. When not set the minor ticks step is computed from the data range.
        See Also:
        Constant Field Values

      • MICRO_TICK_STEP

        public static final java.lang.String MICRO_TICK_STEP
        microTickStep (Number, optional): The amount to skip before a micro tick is drawn. When not set the micro ticks step is computed from
        See Also:
        Constant Field Values

      • LABELS

        public static final java.lang.String LABELS
        labels (Object[], optional): An array of labels for major ticks, with corresponding numeric values, ordered by value.
        See Also:
        Constant Field Values

      • LABEL_FUNC

        public static final java.lang.String LABEL_FUNC
        labelFunc (Function, optional): An optional function to use to compute label text. It takes precedence over the default text when available. The function must be of the following form:
        See Also:
        Constant Field Values

      • MAX_LABEL_SIZE

        public static final java.lang.String MAX_LABEL_SIZE
        maxLabelSize (Number, optional):The maximum size, in pixels, for a label. To be used with the optional label function.
        See Also:
        Constant Field Values

      • STROKE

        public static final java.lang.String STROKE
        stroke ([JSONObject Value(type: object, value: undefined)], optional): An optional stroke to be used for drawing an axis.
        See Also:
        Constant Field Values

      • MAJOR_TICK

        public static final java.lang.String MAJOR_TICK
        majorTick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a major tick.
        See Also:
        Constant Field Values

      • MINOR_TICK

        public static final java.lang.String MINOR_TICK
        minorTick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a minor tick.
        See Also:
        Constant Field Values

      • MICRO_TICK

        public static final java.lang.String MICRO_TICK
        microTick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a micro tick.
        See Also:
        Constant Field Values

      • TICK

        public static final java.lang.String TICK
        tick (JSONObject, optional): An object containing a dojox.gfx.Stroke, and a length (number) for a tick.
        See Also:
        Constant Field Values

      • FONT

        public static final java.lang.String FONT
        font (String, optional): An optional font definition (as used in the CSS font property) for labels.
        See Also:
        Constant Field Values

      • FONT_COLOR

        public static final java.lang.String FONT_COLOR
        fontColor (String|dojo.Color, optional): An optional color to be used in drawing labels.
        See Also:
        Constant Field Values

      • TITLE_GAP

        public static final java.lang.String TITLE_GAP
        titleGap (Number, optional): An optional grap between axis title and axis label
        See Also:
        Constant Field Values

      • TITLE_FONT

        public static final java.lang.String TITLE_FONT
        titleFont (String, optional): An optional font definition for axis title
        See Also:
        Constant Field Values

      • TITLE_FONT_COLOR

        public static final java.lang.String TITLE_FONT_COLOR
        titleFontColor (String, optional): An optional axis title color
        See Also:
        Constant Field Values

      • TITLE_ORIENTATION

        public static final java.lang.String TITLE_ORIENTATION
        titleOrientation (String, optional): An optional orientation for axis title. "axis" means the title facing the axis, "away" means facing away. If no value is set "axis" is used.
        See Also:
        Constant Field Values

      • ENABLE_CACHE

        public static final java.lang.String ENABLE_CACHE
        enableCache (Boolean, optional): Whether the ticks and labels are cached from one rendering to another. This improves the rendering performance of successive rendering but penalize the first rendering. For labels it is only working with gfx labels not html ones. Default false.
        See Also:
        Constant Field Values

      • DROP_LABELS

        public static final java.lang.String DROP_LABELS
        dropLabels (Boolean, optional): Whether the axis automatically drops labels at regular interval or not to avoid labels overlapping. This gives better results but require more computations. You can disable it to save computation time when you know your labels won't overlap. Default is true.
        See Also:
        Constant Field Values

      • LABEL_SIZE_CHANGE

        public static final java.lang.String LABEL_SIZE_CHANGE
        labelSizeChange (Boolean, optional): Indicates to the axis whether the axis labels are changing their size on zoom. If false this allows to optimize the axis by avoiding recomputing labels maximum size on zoom actions. Default is false.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Axis

        public Axis(java.lang.String axisId)
        Creates a new Axis object with the given id, usually 'x', or 'y'
        Parameters:
        axisId -

    • Method Detail

      • newXAxis

        public static Axis newXAxis()
        Creates a newly configured X Axis, with ONLY major ticks and labels, and no 0
        Returns:

      • newYAxis

        public static Axis newYAxis()
        creates a newly configured Y axis
        Returns:
Skip navigation links