Package com.orchestranetworks.addon.dpra.function.chart

Class AxisConfig

  • public abstract class AxisConfig
extends java.lang.Object
    Defines a chart axis configuration.

    The following types are supported:

    • Category axis: String values.
    • Value axis: Numeric values.

    Since:
    4.2.0
    See Also:
    ChartConfigForFunction.newBuilder(AxisConfig)

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AxisConfig outputLabelAsCategory​(java.lang.String... outputNamesForValueAxis)
      As output values serve as the value axis, output labels are considered as the chart category.
      static AxisConfig outputLabelAsCategory​(java.util.Collection<java.lang.String> outputNamesForValueAxis)
      As output values serve as the value axis, output labels are considered as the chart category.
      static AxisConfig outputValueAsCategory​(java.lang.String outputNameForCategoryAxis, java.lang.String outputNameForValueAxis)
      Specifies two outputs for the category axis and the value axis, respectively.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • outputLabelAsCategory

        public static AxisConfig outputLabelAsCategory​(java.lang.String... outputNamesForValueAxis)
        As output values serve as the value axis, output labels are considered as the chart category.
        Parameters:
        outputNamesForValueAxis - Names of output definitions for the value axis.
        See Also:
        OutputDefinition.getName(), OutputDefinition.getLabel()

      • outputLabelAsCategory

        public static AxisConfig outputLabelAsCategory​(java.util.Collection<java.lang.String> outputNamesForValueAxis)
        As output values serve as the value axis, output labels are considered as the chart category.
        Parameters:
        outputNamesForValueAxis - Names of output definitions for value axis.
        See Also:
        OutputDefinition.getName(), OutputDefinition.getLabel()

      • outputValueAsCategory

        public static AxisConfig outputValueAsCategory​(java.lang.String outputNameForCategoryAxis,
                                               java.lang.String outputNameForValueAxis)
        Specifies two outputs for the category axis and the value axis, respectively.
        Parameters:
        outputNameForCategoryAxis - The name of the output definition for category axis.
        outputNameForValueAxis - The name of the output definition for the value axis. The output definition for the value axis must be numeric.
        See Also:
        OutputDefinition.getName()