com.supermap.mapping

Class ThemeRangeItem

  • java.lang.Object
    • com.supermap.mapping.ThemeRangeItem


  • public class ThemeRangeItem
    extends java.lang.Object
    The ThemeRangeItem class.

    In the ranges map, the expression values of range field are divided into a number of extent ranges according to certain ranges mode. Each range has its range start value, end value, name, style, etc. The extent represented by each range is [Start, End).

    • Constructor Summary

      Constructors 
      Constructor and Description
      ThemeRangeItem()
      Initializes a new instance of the ThemeRangeItem class.
      ThemeRangeItem(double start, double end, GeoStyle style)
      Initializes a new instance of the ThemeRangeItem structure with the specified start value, end value and style of the ThemeRangeItem object.
      ThemeRangeItem(double start, double end, GeoStyle style, java.lang.String caption)
      Initializes a new instance of the ThemeRangeItem structure with the specified start value, end value, style and caption of the ThemeRangeItem object.
      ThemeRangeItem(ThemeRangeItem themeRangeItem)
      Initializes a new instance of the ThemeRangeItem structure which is identical with the specified ThemeRangeItem object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getCaption()
      Returns the name of the range map item.
      double getEnd()
      Returns the end value of the range map item.
      double getStart()
      Returns the start value of the range map item.
      GeoStyle getStyle()
      Returns the style for each item of a ranges map.
      boolean isVisible()
      Returns whether the ranges map item is visible.
      void setCaption(java.lang.String caption)
      Sets the name of the range map item.
      void setEnd(double end)
      Sets the end value of the range map item.
      void setStart(double start)
      Sets the start value of the range map item.
      void setStyle(GeoStyle style)
      Sets the style for the item of the ranges map.
      void setVisible(boolean value)
      Sets whether the ranges map item is visible.
      java.lang.String toString()
      Returns the readable strings of a ranges thematic map item with a specific format.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ThemeRangeItem

        public ThemeRangeItem()
        Initializes a new instance of the ThemeRangeItem class.
      • ThemeRangeItem

        public ThemeRangeItem(double start,
                              double end,
                              GeoStyle style)
        Initializes a new instance of the ThemeRangeItem structure with the specified start value, end value and style of the ThemeRangeItem object.
        Parameters:
        start - The start value of the specified range map item.
        end - Returns the end value of the range map item.
        style - The display style of the ThemeLabelItem object.
      • ThemeRangeItem

        public ThemeRangeItem(double start,
                              double end,
                              GeoStyle style,
                              java.lang.String caption)
        Initializes a new instance of the ThemeRangeItem structure with the specified start value, end value, style and caption of the ThemeRangeItem object.
        Parameters:
        start - The start value of the specified range map item.
        end - Returns the end value of the range map item.
        style - The display style of the ThemeLabelItem object.
        caption - The caption of the ThemeGraphItem object.
      • ThemeRangeItem

        public ThemeRangeItem(ThemeRangeItem themeRangeItem)
        Initializes a new instance of the ThemeRangeItem structure which is identical with the specified ThemeRangeItem object.
        Parameters:
        themeRangeItem - The specified ThemeRangeItem object.
    • Method Detail

      • getStart

        public double getStart()
        Returns the start value of the range map item.

        Note: If the ThemeGridRangeItem object is the first item, the start value is the minimum value of the range. If the index of the ThemeGridRangeItem object is greater than one, the start value of the item must be identical with the end value of the previous item; otherwise an exception will be thrown.

        Returns:
        Gets or sets the start value of the ThemeRangeItem object.
        Default:
        The default value is -3.4028235e+038
      • setStart

        public void setStart(double start)
        Sets the start value of the range map item.

        Note: If the ThemeGridRangeItem object is the first item, the start value is the minimum value of the range. If the index of the ThemeGridRangeItem object is greater than one, the start value of the item must be identical with the end value of the previous item; otherwise an exception will be thrown.

        Parameters:
        start - The start value of the specified range map item.
      • getEnd

        public double getEnd()
        Returns the end value of the range map item.
        Returns:
        Gets or sets the end value of the ThemeRangeItem object.
        Default:
        The default value is -3.4028235e+038
      • setEnd

        public void setEnd(double end)
        Sets the end value of the range map item.
        Parameters:
        end - Returns the end value of the range map item.
      • isVisible

        public boolean isVisible()
        Returns whether the ranges map item is visible.
        Returns:
        True or false indicating whether the ranges map item is visible.
        Default:
        The default value is true.
      • setVisible

        public void setVisible(boolean value)
        Sets whether the ranges map item is visible.
        Parameters:
        value - Whether the ranges map item is visible.
      • getStyle

        public GeoStyle getStyle()
        Returns the style for each item of a ranges map.
        Returns:
        The style for the item of the ranges map.
        Default:
        The default value is {FillBackColor=Color [A=255, R=255, G=255, B=255],FillForeColor=Color [A=255, R=189, G=235, B=255],FillGradientAngle=0,FillGradientMode=None,FillGradientOffsetRatioX=0,FillGradientOffsetRatioY=0,FillOpaqueRate=100,FillSymbolID=0,LineColor=Color [A=255, R=0, G=0, B=0],LineSymbolID=0,LineWidth=1,MarkerAngle=0,MarkerSize={Width=28,Height=-1},MarkerSymbolID=0}.
      • setStyle

        public void setStyle(GeoStyle style)
        Sets the style for the item of the ranges map.
        Parameters:
        style - The style for the item of the ranges map.
      • getCaption

        public java.lang.String getCaption()
        Returns the name of the range map item.
        Returns:
        The name of the range map item.
        Default:
        The default value is "UntitledThemeRangeItem".
      • setCaption

        public void setCaption(java.lang.String caption)
        Sets the name of the range map item.
        Parameters:
        caption - The name of the range map item.
      • toString

        public java.lang.String toString()
        Returns the readable strings of a ranges thematic map item with a specific format. The format is {Caption="china",Start=10 End=20, Visible=true?false ,Style={linestyle=,markerstyle=,fillstyle=} }.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The formatted string representing the ranges map item.