Class: Theme3DLayer

mapboxgl.supermap.Theme3DLayer

三维专题图基类,不能直接实例化。

new mapboxgl.supermap.Theme3DLayer(id, layerOptions)

mapboxgl/overlay/theme/Theme3DLayer.js, line 7
Name Type Default Description
id string 可选

专题图图层 id。默认使用 CommonUtil.createUniqueID("theme3DLayer") 创建专题图层 ID。
layerOptions Object

专题图图层配置项。

Name Type Default Description
opacity number 1 可选

图层透明度。
parseNumber boolean fasle 可选

是否预处理数据，将数据转换为 number。
enableHighlight boolean false 可选

是否开启高亮。
highlight string "#ADA91E" 可选

高亮颜色。
baseHeightField string 可选

数据中表示基础高度的字段。
height number 可选

高度。如果数据指定的 heightField (为height)没有可以表示高度的字段，可以为所有数据统一设置一个高度。
heightField string 可选

数据中表示高度的字段。
themeField string 可选

专题展示的字段。
playerOptions.showLegend boolean true 可选

是否显示图例。
layerOptions.legendTitle string 可选

图例标题。
layerOptions.legendTheme string 'light' 可选

图例主题，取值：'light','dark'。
layerOptions.legendOrientation string 'horizontal' 可选

图例方向，取值：'horizontal','vertical'。
layerOptions.legendPosition string 可选

图例位置，取值：'top-right'|'top-left'|'bottom-left'|'bottom-right'。

Members

baseHeightFieldstring

数据中表示基础高度的字段。

enableHighlightboolean

是否开启高亮。

heightnumber

高度。如果数据指定的 heightField (默认 height) 没有可以表示高度的字段，可以为所有数据统一设置一个高度。

heightFieldstring

数据中表示高度的字段。

highlightObject

高亮相关配置。

Default Value:
{color: "#ADA91E"}

idstring

Mapbox GL 图层 id。

legendOrientationstring

图例方向，取值：'horizontal','vertical'。

Default Value:
'horizontal'

legendPositionstring

图例位置，取值：'top-right'|'top-left'|'bottom-left'|'bottom-right'。

Default Value:
'bottom-right'

legendThemestring

图例主题，取值：'light','dark'。

Default Value:
'light'

legendTitlestring

图例标题。

mapObject

Mapbox GL 地图对象。

opacitynumber

图层透明度。

Default Value:
1

parseNumberboolean

是否进行数据预处理,有些字段是 string 类型，需要转换为 number。

showLegendboolean

是否显示图例。

Default Value:
true

themeFieldstring

专题展示的字段。

Methods

addTo(map){this}

mapboxgl/overlay/theme/Theme3DLayer.js, line 191

添加图层到地图上。

Name Type Description
map mapboxgl.Map

Mapbox GL 地图对象。
Returns:
Type Description
this this 对象。

getData(){GeoJSONObject}

mapboxgl/overlay/theme/Theme3DLayer.js, line 182

获取数据。

Returns:
Type Description
GeoJSONObject 获取的数据。

getHighlightStyleOptions(){Object}

mapboxgl/overlay/theme/Theme3DLayer.js, line 266

获取高亮样式,子类重写实现。

Returns:
Type Description
Object Mapbox GL 样式对象。

getLayerStyleOptions(){Object}

mapboxgl/overlay/theme/Theme3DLayer.js, line 257

获取图层样式。

Returns:
Type Description
Object Mapbox GL 样式对象。

remove(){this}

mapboxgl/overlay/theme/Theme3DLayer.js, line 228

从地图上移除图层。

Returns:
Type Description
this this 对象。

setData(data, parseNumber)

mapboxgl/overlay/theme/Theme3DLayer.js, line 158

设置数据，数据格式必须为 GeoJSON 格式。

Name Type Default Description
data GeoJSONObject

GeoJSON 格式数据。
parseNumber boolean false 可选

是否进行数据预处理,有些字段是 string 类型，需要转换为 number。

setHighlightStyleOptions(highlightOptions){this}

mapboxgl/overlay/theme/Theme3DLayer.js, line 145

设置图层高亮相关参数。

Name Type Description
highlightOptions Object

该专题图图层高亮相关参数。

Name Type Description
color string 可选

颜色。
callback function

回调,返回数据参数（data,event）。
Returns:
Type Description
this

setLayerOptions(layerOptions){this}

mapboxgl/overlay/theme/Theme3DLayer.js, line 123

设置图层相关参数。

Name Type Description
layerOptions Object

该专题图图层相关参数。

Name Type Default Description
opacity number 1 可选

图层透明度。
parseNumber boolean false 可选

是否预处理数据，将数据转换为 number。
baseHeightField string 可选

数据中表示基础高度的字段
height number 可选

高度。如果数据指定的heightField(默认height)没有可以表示高度的字段，可以为所有数据统一设置一个高度。
heightField string 可选

数据中表示高度的字段。
themeField string 可选

专题展示的字段。
showLegend boolean true 可选

是否显示图例。
legendTitle string

图例标题。
legendTheme string 'light' 可选

图例主题，取值：'light','dark'。
legendOrientation string 'horizontal' 可选

图例方向，取值：'horizontal','vertical'。
legendPosition string 可选

图例位置，取值：'top-right'|'top-left'|'bottom-left'|'bottom-right'。
Returns:
Type Description
this

show(options){this}

mapboxgl/overlay/theme/Theme3DLayer.js, line 207

显示图层。

Name Type Description
options Object

图层配置项。
Returns:
Type Description
this this 对象。