Class: ThemeRangeItem

ThemeRangeItem

范围分段专题图子项类。在分段专题图中,字段值按照某种分段模式被分成多个范围段, 每个范围段即为一个子项,同一范围段的要素属于同一个分段专题图子项。 每个子项都有其分段起始值、终止值、名称和风格等。每个分段所表示的范围为 [start, end)。

new ThemeRangeItem(options)

Usage
import { ThemeRangeItem } from '@supermapgis/iclient-leaflet';

new ThemeRangeItem(options);
<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.ThemeRangeItem({paramsNames});
  // 弃用的写法
  new SuperMap.ThemeRangeItem(options);
</script>
common/iServer/ThemeRangeItem.js, line 7
Name Type Description
options Object

参数。

Name Type Default Description
caption string 可选

子项的标题。

end number 0 可选

子项的终止值。

start number 0 可选

子项的起始值。

style ServerStyle

子项的风格。

visible boolean true 可选

子项是否可见。

API Relations

Returned by: ThemeRangeItem.fromObj.

Members

captionstring

分段专题图子项的标题。

endnumber

分段专题图子项的终止值,即该段专题值范围的最大值。
如果该子项是分段中最后一个子项,则该终止值应大于分段字段(ThemeRange 类的 rangeExpression 属性)的最大值,若该终止值小于分段字段最大值, 则剩余部分由内部随机定义其颜色;如果不是最后一项,该终止值必须与其下一子项的起始值相同,否则系统抛出异常; 如果设置了范围分段模式和分段数,则会自动计算每段的范围 [start, end),故无需设置 [start, end);当然可以设置,那么结果就会按您设置的值对分段结果进行调整。

startnumber

分段专题图子项的起始值,即该段专题值范围的最小值。
如果该子项是分段中第一个子项,那么该起始值就是分段的最小值;如果子项的序号大于等于 1 的时候,该起始值必须与前一子项的终止值相同,否则系统会抛出异常。 如果设置了范围分段模式和分段数,则会自动计算每段的范围 [start, end),故无需设置 [start, end);当然可以设置,那么结果就会按您设置的值对分段结果进行调整。

分段专题图子项的风格。 每一个分段专题图子项都对应一种显示风格。

visibleboolean

分段专题图子项是否可见。

Default Value:
true

Methods

static fromObj(obj){ThemeRangeItem}

common/iServer/ThemeRangeItem.js, line 101

从传入对象获取范围分段专题图子项类。

Name Type Description
obj Object

传入对象。

Returns:
Type Description
ThemeRangeItem ThemeRangeItem 对象。

destroy()

common/iServer/ThemeRangeItem.js, line 68

释放资源,将引用资源的属性置空。

toServerJSONObject(){Object}

common/iServer/ThemeRangeItem.js, line 85

转换成对应的 JSON 格式对象。

Returns:
Type Description
Object 对应的 JSON 格式对象。