com.supermap.data
类 GeoMapScale

java.lang.Object
  com.supermap.data.Geometry
      com.supermap.data.GeoMapScale

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() 返回当前 GeoMapScale 对象的一个拷贝。
void	dispose() 释放该对象所占用的资源。
boolean	fromXML(java.lang.String xml) 此类不支持该接口。
int	getBindingGeoMapID() 返回地图比例尺几何对象所关联的地图几何对象的 ID。
double	getHeight() 返回地图比例尺几何对象的高度。
Point2D	getLeftBottom() 返回地图比例尺几何对象的左下角点。
int	getLeftDivisionCount() 返回地图比例尺几何对象的左翼分段个数。
double	getScale() 返回比例尺。
GeoMapScaleType	getScaleType() 返回地图比例尺几何对象的比例尺类型。
Unit	getScaleUnit() 返回地图比例尺几何对象的比例尺单位。
int	getSegmentCount() 返回地图比例尺几何对象的小节个数。
double	getSegmentLength() 返回地图比例尺几何对象的小节长度。
TextStyle	getTextStyle() 返回地图比例尺几何对象的文本风格。
double	getWidth() 返回比例尺几何对象的宽度。
boolean	isEmpty() 此类不支持该接口。
Geometry	mirror(Point2D startPoint, Point2D endPoint) 此类不支持该接口。
void	setBindingGeoMapID(int index) 设置地图比例尺几何对象所关联的地图几何对象的 ID。
void	setEmpty() 此类不支持该接口。
void	setHeight(double value) 设置地图比例尺几何对象的高度。
void	setLeftDivisionCount(int value) 设置地图比例尺几何对象的左翼分段个数,最小值是2。
void	setScale(double value) 设置比例尺。
void	setScaleType(GeoMapScaleType geoMapScaleType) 设置地图比例尺几何对象的比例尺类型。
void	setScaleUnit(Unit unit) 设置地图比例尺几何对象的比例尺单位。
void	setSegmentCount(int value) 设置地图比例尺几何对象的小节个数。
void	setSegmentLength(double value) 设置地图比例尺几何对象的小节长度。
void	setTextStyle(TextStyle textStyle) 设置地图比例尺几何对象的文本风格。
java.lang.String	toXML() 此类不支持该接口。

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

addCustomGeometryCreatedListener, getBounds, getID, getInnerPoint, getStyle, getType, getVariantID, hitTest, offset, removeCustomGeometryCreatedListener, resize, rotate, setID, setStyle

从类 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 index)

设置地图比例尺几何对象所关联的地图几何对象的 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 - 比例尺。

getSegmentCount

public int getSegmentCount()

返回地图比例尺几何对象的小节个数。

返回：

地图比例尺几何对象的小节个数。

默认值:

默认值为 2。

setSegmentCount

public void setSegmentCount(int value)

设置地图比例尺几何对象的小节个数。

参数：

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 - 地图比例尺几何对象的比例尺单位。

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()

返回地图比例尺几何对象的左下角点。

返回：

地图比例尺几何对象的左下角点。

dispose

public void dispose()

释放该对象所占用的资源。当调用该方法之后，此对象不再可用。

覆盖：

类 Geometry 中的 dispose

clone

public GeoMapScale clone()

返回当前 GeoMapScale 对象的一个拷贝。

覆盖：

类 java.lang.Object 中的 clone

返回：

通过克隆操作得到的 GeoMapScale 对象。

fromXML

public boolean fromXML(java.lang.String xml)

此类不支持该接口。

覆盖：

类 Geometry 中的 fromXML

参数：

xml - XML 格式的字符串。

返回：

如果构造成功返回 true，否则返回 false。

另请参见：

Geometry.offset(double, double)

toXML

public java.lang.String toXML()

此类不支持该接口。

覆盖：

类 Geometry 中的 toXML

返回：

表示几何对象的 XML 字符串。

另请参见：

Geometry.offset(double, double)

setEmpty

public void setEmpty()

此类不支持该接口。

覆盖：

类 Geometry 中的 setEmpty

isEmpty

public boolean isEmpty()

此类不支持该接口。

覆盖：

类 Geometry 中的 isEmpty

返回：

一个布尔值指定几何对象是否为空。

另请参见：

Geometry.offset(double, double)

mirror

public Geometry mirror(Point2D startPoint,
                       Point2D endPoint)

此类不支持该接口。

覆盖：

类 Geometry 中的 mirror

参数：

startPoint - 线段的起点。

endPoint - 线段的终点。

返回：

该几何对象关于指定对称的几何对象。

另请参见：

Geometry.offset(double,double)