GeoMapScale (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.data.Geometry
    - - com.supermap.data.GeoMapScale

所有已实现的接口:

IDisposable
```
public class GeoMapScale
extends Geometry
```
地图比例尺几何对象类。
该类用于向地图布局中添加比例尺对象。
设置布局中比例尺对象需先设置比例尺（setScale() 方法）和比例尺单位（setScaleUnit()方法），然后才能设置小节长度（setSegmentLength()）。

构造器概要

构造器
构造器和说明
`GeoMapScale()` 构造一个新的 GeoMapScale 对象。
`GeoMapScale(GeoMapScale geoMapScale)` 根据给定的 GeoMapScale 对象构造一个与其完全相同的新对象。
`GeoMapScale(int geoMapID, Point2D leftBottom, double width, double height)` 根据指定的参数来构造一个 GeoMapScale 的新对象。
`GeoMapScale(Point2D leftBottom, double width, double height)` 根据指定的参数来构造一个 GeoMapScale 的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`GeoMapScale`	`clone()` 克隆一个Geometry对象。
`void`	`dispose()` 释放该对象所占用的资源。
`int`	`getBindingGeoMapID()` 返回地图比例尺几何对象所关联的地图几何对象的 ID。
`GeoMapScaleDisplayType`	`getDivisionDisplayType()` 返回地图比例尺几何对象的刻度显示类型
`int`	`getDivisions()` 返回地图比例尺几何对象的细分刻度个数
`boolean`	`getDrawFromRightToLeft()`
`double`	`getHeight()` 返回地图比例尺几何对象的高度。
`boolean`	`getIsDrawLeftDivision()`
`boolean`	`getIsHaveBeenSplited()`
`Point2D`	`getLeftBottom()` 返回地图比例尺几何对象的左下角点。
`int`	`getLeftDivisionCount()` 返回地图比例尺几何对象的左翼分段个数。
`double`	`getMainDivisionHeight()` 返回比例尺的长刻度高度
`GeoMapScaleDisplayType`	`getNumberDisplayType()` 返回地图比例尺几何对象的数值显示类型
`double`	`getScale()` 返回比例尺。
`Unit`	`getScaleShowUnit()` 返回地图比例尺几何对象显示用的比例尺单位
`GeoMapScaleType`	`getScaleType()` 返回地图比例尺几何对象的比例尺类型。
`Unit`	`getScaleUnit()` 返回地图比例尺几何对象的比例尺单位。
`int`	`getSegmentCount()` 返回地图比例尺几何对象的小节个数。
`double`	`getSegmentLength()` 返回地图比例尺几何对象的小节长度。
`double`	`getShortDivisionHeight()` 返回比例尺的短刻度高度
`GeoStyle`	`getStyle()` 重写setStyle，解决UGOJ2282，保证比例尺可以设置前景色和背景色
`TextStyle`	`getTextStyle()` 返回地图比例尺几何对象的文本风格。
`double`	`getWidth()` 返回比例尺几何对象的宽度。
`void`	`setBindingGeoMapID(int value)` 设置地图比例尺几何对象所关联的地图几何对象的 ID。
`void`	`setDivisionDisplayType(GeoMapScaleDisplayType value)` 设置地图比例尺几何对象的刻度显示类型
`void`	`setDivisions(int value)` 设置地图比例尺几何对象的细分刻度个数
`void`	`setDrawFromRightToLeft(boolean value)`
`void`	`setHeight(double value)` 设置地图比例尺几何对象的高度。
`void`	`setIsDrawLeftDivision(boolean value)`
`void`	`setLeftDivisionCount(int value)` 设置地图比例尺几何对象的左翼分段个数,最小值是2。
`void`	`setMainDivisionHeight(double value)` 设置比例尺的长刻度高度
`void`	`setNumberDisplayType(GeoMapScaleDisplayType value)` 设置地图比例尺几何对象的数值显示类型
`void`	`setScale(double value)` 设置比例尺。
`void`	`setScaleShowUnit(Unit unit)` 设置地图比例尺几何对象显示用的比例尺单位
`void`	`setScaleType(GeoMapScaleType geoMapScaleType)` 设置地图比例尺几何对象的比例尺类型。
`void`	`setScaleUnit(Unit unit)` 设置地图比例尺几何对象的比例尺单位。
`void`	`setSegmentCount(int value)` 设置地图比例尺几何对象的小节个数。
`void`	`setSegmentLength(double value)` 设置地图比例尺几何对象的小节长度。
`void`	`setShortDivisionHeight(double value)` 设置比例尺的短刻度高度
`void`	`setStyle(GeoStyle value)` 重写setStyle，解决UGOJ2282，保证比例尺可以设置前景色和背景色
`void`	`setTextStyle(TextStyle textStyle)` 设置地图比例尺几何对象的文本风格。

从类继承的方法 com.supermap.data.Geometry
addCustomGeometryCreatedListener, fromXML, getBounds, getID, getInnerPoint, getType, getVariantID, hitTest, isEmpty, mirror, offset, removeCustomGeometryCreatedListener, resize, rotate, setBounds, setEmpty, setID, toXML

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - GeoMapScale
```
public GeoMapScale()
```
    构造一个新的 GeoMapScale 对象。
  - GeoMapScale
```
public GeoMapScale(GeoMapScale geoMapScale)
```
    根据给定的 GeoMapScale 对象构造一个与其完全相同的新对象。
    
    参数:
    
    geoMapScale - 给定的 GeoMapScale 对象。
  - GeoMapScale
```
public GeoMapScale(Point2D leftBottom,
                   double width,
                   double height)
```
    根据指定的参数来构造一个 GeoMapScale 的新对象。
    
    参数:
    
    leftBottom - 指定的左下角点。
    
    width - 指定的宽度。单位：0.1毫米。
    
    height - 指定的高度。单位：0.1毫米。
  - GeoMapScale
```
public GeoMapScale(int geoMapID,
                   Point2D leftBottom,
                   double width,
                   double height)
```
    根据指定的参数来构造一个 GeoMapScale 的新对象。
    
    参数:
    
    geoMapID - 指定地图比例尺几何对象所服务的地图几何对象的 ID。
    
    leftBottom - 指定的左下角点。
    
    width - 指定的宽度。单位：0.1毫米。
    
    height - 指定的高度。单位：0.1毫米。
- 方法详细资料
  - getBindingGeoMapID
```
public int getBindingGeoMapID()
```
    返回地图比例尺几何对象所关联的地图几何对象的 ID。
    
    返回:
    
    地图比例尺几何对象所关联的地图几何对象的 ID。
    
    默认值:
    
    默认值为 -1。
  - setBindingGeoMapID
```
public void setBindingGeoMapID(int value)
```
    设置地图比例尺几何对象所关联的地图几何对象的 ID。
    
    参数:
    
    index - 地图比例尺几何对象所关联的地图几何对象的 ID。
  - getScaleType
```
public GeoMapScaleType getScaleType()
```
    返回地图比例尺几何对象的比例尺类型。
    
    返回:
    
    地图比例尺几何对象的比例尺类型。
    
    默认值:
    
    默认值为 RAILWAY_MID_SPLIT。
  - setScaleType
```
public void setScaleType(GeoMapScaleType geoMapScaleType)
```
    设置地图比例尺几何对象的比例尺类型。
    
    参数:
    
    geoMapScaleType - 地图比例尺几何对象的比例尺类型。
  - getScale
```
public double getScale()
```
    返回比例尺。
    
    返回:
    
    比例尺。
    
    默认值:
    
    默认值为 0.000001。
  - setScale
```
public void setScale(double value)
```
    设置比例尺。
    
    参数:
    
    value - 比例尺。
  - getDivisions
```
public int getDivisions()
```
    返回地图比例尺几何对象的细分刻度个数
    
    返回:
  - setDivisions
```
public void setDivisions(int value)
```
    设置地图比例尺几何对象的细分刻度个数
    
    参数:
    
    value -
  - getNumberDisplayType
```
public GeoMapScaleDisplayType getNumberDisplayType()
```
    返回地图比例尺几何对象的数值显示类型
    
    返回:
  - setNumberDisplayType
```
public void setNumberDisplayType(GeoMapScaleDisplayType value)
```
    设置地图比例尺几何对象的数值显示类型
    
    参数:
    
    value -
  - getDivisionDisplayType
```
public GeoMapScaleDisplayType getDivisionDisplayType()
```
    返回地图比例尺几何对象的刻度显示类型
    
    返回:
  - setDivisionDisplayType
```
public void setDivisionDisplayType(GeoMapScaleDisplayType value)
```
    设置地图比例尺几何对象的刻度显示类型
    
    参数:
    
    value -
  - getSegmentCount
```
public int getSegmentCount()
```
    返回地图比例尺几何对象的小节个数。
    
    返回:
    
    地图比例尺几何对象的小节个数。
    
    默认值:
    
    默认值为 2。
  - setSegmentCount
```
public void setSegmentCount(int value)
```
    设置地图比例尺几何对象的小节个数。
    
    参数:
    
    value - 地图比例尺几何对象的小节个数。
  - getMainDivisionHeight
```
public double getMainDivisionHeight()
```
    返回比例尺的长刻度高度
    
    返回:
  - setMainDivisionHeight
```
public void setMainDivisionHeight(double value)
```
    设置比例尺的长刻度高度
    
    参数:
    
    value -
  - getShortDivisionHeight
```
public double getShortDivisionHeight()
```
    返回比例尺的短刻度高度
    
    返回:
  - setShortDivisionHeight
```
public void setShortDivisionHeight(double value)
```
    设置比例尺的短刻度高度
    
    参数:
    
    value -
  - getIsDrawLeftDivision
```
public boolean getIsDrawLeftDivision()
```
  - setIsDrawLeftDivision
```
public void setIsDrawLeftDivision(boolean value)
```
  - getSegmentLength
```
public double getSegmentLength()
```
    返回地图比例尺几何对象的小节长度。
    
    返回:
    
    地图比例尺几何对象的小节长度。
    
    默认值:
    
    默认值为 20。
  - setSegmentLength
```
public void setSegmentLength(double value)
```
    设置地图比例尺几何对象的小节长度。单位：0.1毫米。
    设置布局中比例尺对象需先设置比例尺（setScale() 方法）和比例尺单位（setScaleUnit()方法），然后才能设置小节长度（setSegmentLength()）。
    
    参数:
    
    value - 地图比例尺几何对象的小节长度。单位：0.1毫米。
  - getLeftDivisionCount
```
public int getLeftDivisionCount()
```
    返回地图比例尺几何对象的左翼分段个数。
    
    返回:
    
    地图比例尺几何对象的左翼分段个数。
    
    默认值:
    
    默认值为 2。
  - setLeftDivisionCount
```
public void setLeftDivisionCount(int value)
```
    设置地图比例尺几何对象的左翼分段个数,最小值是2。
    
    参数:
    
    value - 地图比例尺几何对象的左翼分段个数，最小值是2。
  - getScaleUnit
```
public Unit getScaleUnit()
```
    返回地图比例尺几何对象的比例尺单位。
    
    返回:
    
    地图比例尺几何对象的比例尺单位。
    
    默认值:
    
    默认值为 KILOMETER。
  - setScaleUnit
```
public void setScaleUnit(Unit unit)
```
    设置地图比例尺几何对象的比例尺单位。
    
    参数:
    
    unit - 地图比例尺几何对象的比例尺单位。
  - getScaleShowUnit
```
public Unit getScaleShowUnit()
```
    返回地图比例尺几何对象显示用的比例尺单位
    
    返回:
  - setScaleShowUnit
```
public void setScaleShowUnit(Unit unit)
```
    设置地图比例尺几何对象显示用的比例尺单位
    
    参数:
    
    unit -
  - getTextStyle
```
public TextStyle getTextStyle()
```
    返回地图比例尺几何对象的文本风格。
    
    返回:
    
    地图比例尺几何对象的文本风格。
    
    默认值:
    
    默认值为 {Alignment = TOPLEFT,BackColor = java.awt.Color[r=0,g=0,b=0],BackOpaque = false,Bold = false,FontName = ,FontHeight = 30.0,FontWidth = 0.0,FontColor = java.awt.Color[r=2,g=2,b=2],IsSizeFixed = false,Italic = false,Outline = false,Rotation = 0.0,Shadow = false,Strikeout = false,Underline = false,Weight = 0}。
  - setTextStyle
```
public void setTextStyle(TextStyle textStyle)
```
    设置地图比例尺几何对象的文本风格。
    
    参数:
    
    textStyle - 地图比例尺几何对象的文本风格。
  - getWidth
```
public double getWidth()
```
    返回比例尺几何对象的宽度。单位：0.1毫米。
    
    返回:
    
    比例尺几何对象的宽度。单位：0.1毫米。
    
    默认值:
    
    默认值为 400。
  - getHeight
```
public double getHeight()
```
    返回地图比例尺几何对象的高度。单位：0.1毫米。
    
    返回:
    
    地图比例尺几何对象的高度。单位：0.1毫米。
    
    默认值:
    
    默认值为 400。
  - setHeight
```
public void setHeight(double value)
```
    设置地图比例尺几何对象的高度。单位：0.1毫米。
    
    参数:
    
    value - 地图比例尺几何对象的高度。单位：0.1毫米。
  - getLeftBottom
```
public Point2D getLeftBottom()
```
    返回地图比例尺几何对象的左下角点。
    
    返回:
    
    地图比例尺几何对象的左下角点。
  - clone
```
public GeoMapScale clone()
```
    从类复制的说明: Geometry
    
    克隆一个Geometry对象。
    
    指定者:
    
    clone 在类中 Geometry
    
    返回:
    
    克隆的Geometry对象。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。当调用该方法之后，此对象不再可用。
    
    指定者:
    
    dispose 在接口中 IDisposable
    
    指定者:
    
    dispose 在类中 Geometry
  - getStyle
```
public GeoStyle getStyle()
```
    重写setStyle，解决UGOJ2282，保证比例尺可以设置前景色和背景色
    
    覆盖:
    
    getStyle 在类中 Geometry
    
    返回:
    
    几何对象的风格。
  - setStyle
```
public void setStyle(GeoStyle value)
```
    重写setStyle，解决UGOJ2282，保证比例尺可以设置前景色和背景色
    
    覆盖:
    
    setStyle 在类中 Geometry
    
    参数:
    
    value - 用来设置几何对象风格的 GeoStyle 对象。
    
    另请参阅:
    
    Geometry.offset(double, double)
  - getDrawFromRightToLeft
```
public boolean getDrawFromRightToLeft()
```
  - setDrawFromRightToLeft
```
public void setDrawFromRightToLeft(boolean value)
```
  - getIsHaveBeenSplited
```
public boolean getIsHaveBeenSplited()
```

类 GeoMapScale

构造器概要

方法概要

从类继承的方法 com.supermap.data.Geometry

从类继承的方法 com.supermap.data.InternalHandleDisposable

从类继承的方法 java.lang.Object

构造器详细资料

GeoMapScale

GeoMapScale

GeoMapScale

GeoMapScale

方法详细资料

getBindingGeoMapID

setBindingGeoMapID

getScaleType

setScaleType

getScale

setScale

getDivisions

setDivisions

getNumberDisplayType

setNumberDisplayType

getDivisionDisplayType

setDivisionDisplayType

getSegmentCount

setSegmentCount

getMainDivisionHeight

setMainDivisionHeight

getShortDivisionHeight

setShortDivisionHeight

getIsDrawLeftDivision

setIsDrawLeftDivision

getSegmentLength

setSegmentLength

getLeftDivisionCount

setLeftDivisionCount

getScaleUnit

setScaleUnit

getScaleShowUnit

setScaleShowUnit

getTextStyle

setTextStyle

getWidth

getHeight

setHeight

getLeftBottom

clone

dispose

getStyle

setStyle

getDrawFromRightToLeft

setDrawFromRightToLeft

getIsHaveBeenSplited