Class LineChartPlotConfiguration

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class LineChartPlotConfiguration
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    A line chart plotting configuration.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vmware.vapi.data.StructValue __dynamicStructureFields  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends com.vmware.vapi.bindings.Structure>
      T
      _convertTo​(java.lang.Class<T> clazz)  
      java.lang.String _getCanonicalName()  
      static java.lang.String _getCanonicalTypeName()
      Returns the canonical type name.
      static com.vmware.vapi.bindings.type.StructType _getClassType()
      WARNING: Internal method, subject to change in future versions.
      com.vmware.vapi.data.StructValue _getDataValue()  
      com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)  
      java.util.Set<java.lang.String> _getDynamicFieldNames()  
      com.vmware.vapi.bindings.type.StructType _getType()  
      boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)  
      static LineChartPlotConfiguration _newInstance​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Returns new instance of this binding class and injects the provided data value.
      WARNING: The returned object is not fully initialized.
      static LineChartPlotConfiguration _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.lang.Boolean getAllowMaximize()
      Allow maximize capability for this widget
      java.lang.String getCondition()
      If the condition is met then the given chart config is applied to the widget configuration.
      java.lang.Boolean getFillGradientArea()
      Fill the line chart area with a gradient series color.
      java.lang.Long getNumOfSeriesToDisplay()
      Specifies the number of series to be displayed in a line chart.
      java.lang.Boolean getShowCurvedLines()
      Used for displaying the curved lines for a series in a line chart.
      java.lang.Boolean getShowDataInTooltip()
      Show the data in tooltip.
      java.lang.Boolean getShowDataPoints()
      Controls the visiblity of the data points on the line chart.
      java.lang.Boolean getShowGridLines()
      Controls the visiblity of the grid lines in line chart.
      java.lang.Boolean getShowGroupedTooltip()
      Controls the visiblity of the grouped tooltip in a line chart across all series.
      java.lang.Boolean getShowMinMaxOnSeries()
      Controls the visiblity of the min and max value across line series in line chart.
      java.lang.Boolean getShowUnitInTooltip()
      Show the data unit in tooltip.
      java.lang.Boolean getSortDataInGroupedTooltip()
      Sort the data in grouped tooltip.
      java.lang.Boolean getSortSeries()
      Specifies whether the series should be sorted by the latest data point.
      int hashCode()  
      void setAllowMaximize​(java.lang.Boolean allowMaximize)
      Allow maximize capability for this widget
      void setCondition​(java.lang.String condition)
      If the condition is met then the given chart config is applied to the widget configuration.
      void setFillGradientArea​(java.lang.Boolean fillGradientArea)
      Fill the line chart area with a gradient series color.
      void setNumOfSeriesToDisplay​(java.lang.Long numOfSeriesToDisplay)
      Specifies the number of series to be displayed in a line chart.
      void setShowCurvedLines​(java.lang.Boolean showCurvedLines)
      Used for displaying the curved lines for a series in a line chart.
      void setShowDataInTooltip​(java.lang.Boolean showDataInTooltip)
      Show the data in tooltip.
      void setShowDataPoints​(java.lang.Boolean showDataPoints)
      Controls the visiblity of the data points on the line chart.
      void setShowGridLines​(java.lang.Boolean showGridLines)
      Controls the visiblity of the grid lines in line chart.
      void setShowGroupedTooltip​(java.lang.Boolean showGroupedTooltip)
      Controls the visiblity of the grouped tooltip in a line chart across all series.
      void setShowMinMaxOnSeries​(java.lang.Boolean showMinMaxOnSeries)
      Controls the visiblity of the min and max value across line series in line chart.
      void setShowUnitInTooltip​(java.lang.Boolean showUnitInTooltip)
      Show the data unit in tooltip.
      void setSortDataInGroupedTooltip​(java.lang.Boolean sortDataInGroupedTooltip)
      Sort the data in grouped tooltip.
      void setSortSeries​(java.lang.Boolean sortSeries)
      Specifies whether the series should be sorted by the latest data point.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • LineChartPlotConfiguration

        public LineChartPlotConfiguration()
        Default constructor.
      • LineChartPlotConfiguration

        protected LineChartPlotConfiguration​(com.vmware.vapi.data.StructValue __dynamicStructureFields)
    • Method Detail

      • getAllowMaximize

        public java.lang.Boolean getAllowMaximize()
        Allow maximize capability for this widget
        Returns:
        The current value of the property.
      • setAllowMaximize

        public void setAllowMaximize​(java.lang.Boolean allowMaximize)
        Allow maximize capability for this widget
        Parameters:
        allowMaximize - New value for the property.
      • getCondition

        public java.lang.String getCondition()
        If the condition is met then the given chart config is applied to the widget configuration.
        Returns:
        The current value of the property.
      • setCondition

        public void setCondition​(java.lang.String condition)
        If the condition is met then the given chart config is applied to the widget configuration.
        Parameters:
        condition - New value for the property.
      • getFillGradientArea

        public java.lang.Boolean getFillGradientArea()
        Fill the line chart area with a gradient series color.
        Returns:
        The current value of the property.
      • setFillGradientArea

        public void setFillGradientArea​(java.lang.Boolean fillGradientArea)
        Fill the line chart area with a gradient series color.
        Parameters:
        fillGradientArea - New value for the property.
      • getNumOfSeriesToDisplay

        public java.lang.Long getNumOfSeriesToDisplay()
        Specifies the number of series to be displayed in a line chart. If no value is provided all the series will be displayed. format: int32
        Returns:
        The current value of the property.
      • setNumOfSeriesToDisplay

        public void setNumOfSeriesToDisplay​(java.lang.Long numOfSeriesToDisplay)
        Specifies the number of series to be displayed in a line chart. If no value is provided all the series will be displayed. format: int32
        Parameters:
        numOfSeriesToDisplay - New value for the property.
      • getShowCurvedLines

        public java.lang.Boolean getShowCurvedLines()
        Used for displaying the curved lines for a series in a line chart. By default, straight line is used to for a series in a line chart.
        Returns:
        The current value of the property.
      • setShowCurvedLines

        public void setShowCurvedLines​(java.lang.Boolean showCurvedLines)
        Used for displaying the curved lines for a series in a line chart. By default, straight line is used to for a series in a line chart.
        Parameters:
        showCurvedLines - New value for the property.
      • getShowDataInTooltip

        public java.lang.Boolean getShowDataInTooltip()
        Show the data in tooltip.
        Returns:
        The current value of the property.
      • setShowDataInTooltip

        public void setShowDataInTooltip​(java.lang.Boolean showDataInTooltip)
        Show the data in tooltip.
        Parameters:
        showDataInTooltip - New value for the property.
      • getShowDataPoints

        public java.lang.Boolean getShowDataPoints()
        Controls the visiblity of the data points on the line chart. If value is set to false data points wont be high- lighted on the lines.
        Returns:
        The current value of the property.
      • setShowDataPoints

        public void setShowDataPoints​(java.lang.Boolean showDataPoints)
        Controls the visiblity of the data points on the line chart. If value is set to false data points wont be high- lighted on the lines.
        Parameters:
        showDataPoints - New value for the property.
      • getShowGridLines

        public java.lang.Boolean getShowGridLines()
        Controls the visiblity of the grid lines in line chart.
        Returns:
        The current value of the property.
      • setShowGridLines

        public void setShowGridLines​(java.lang.Boolean showGridLines)
        Controls the visiblity of the grid lines in line chart.
        Parameters:
        showGridLines - New value for the property.
      • getShowGroupedTooltip

        public java.lang.Boolean getShowGroupedTooltip()
        Controls the visiblity of the grouped tooltip in a line chart across all series.
        Returns:
        The current value of the property.
      • setShowGroupedTooltip

        public void setShowGroupedTooltip​(java.lang.Boolean showGroupedTooltip)
        Controls the visiblity of the grouped tooltip in a line chart across all series.
        Parameters:
        showGroupedTooltip - New value for the property.
      • getShowMinMaxOnSeries

        public java.lang.Boolean getShowMinMaxOnSeries()
        Controls the visiblity of the min and max value across line series in line chart.
        Returns:
        The current value of the property.
      • setShowMinMaxOnSeries

        public void setShowMinMaxOnSeries​(java.lang.Boolean showMinMaxOnSeries)
        Controls the visiblity of the min and max value across line series in line chart.
        Parameters:
        showMinMaxOnSeries - New value for the property.
      • getShowUnitInTooltip

        public java.lang.Boolean getShowUnitInTooltip()
        Show the data unit in tooltip.
        Returns:
        The current value of the property.
      • setShowUnitInTooltip

        public void setShowUnitInTooltip​(java.lang.Boolean showUnitInTooltip)
        Show the data unit in tooltip.
        Parameters:
        showUnitInTooltip - New value for the property.
      • getSortDataInGroupedTooltip

        public java.lang.Boolean getSortDataInGroupedTooltip()
        Sort the data in grouped tooltip.
        Returns:
        The current value of the property.
      • setSortDataInGroupedTooltip

        public void setSortDataInGroupedTooltip​(java.lang.Boolean sortDataInGroupedTooltip)
        Sort the data in grouped tooltip.
        Parameters:
        sortDataInGroupedTooltip - New value for the property.
      • getSortSeries

        public java.lang.Boolean getSortSeries()
        Specifies whether the series should be sorted by the latest data point.
        Returns:
        The current value of the property.
      • setSortSeries

        public void setSortSeries​(java.lang.Boolean sortSeries)
        Specifies whether the series should be sorted by the latest data point.
        Parameters:
        sortSeries - New value for the property.
      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure
      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure
      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)
      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object
      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure
      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                                     com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.
      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure
      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name
      • _newInstance

        public static LineChartPlotConfiguration _newInstance​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Returns new instance of this binding class and injects the provided data value.
        WARNING: The returned object is not fully initialized.
        Parameters:
        structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
        Returns:
        the static bindings StructType
      • _newInstance2

        public static LineChartPlotConfiguration _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.