Class: Theme3DLayer

Theme3DLayer

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

new mapboxgl.supermap.Theme3DLayer(id, layerOptions)

mapboxgl/overlay/theme/Theme3DLayer.js, line 4
Name Type Description
id string

专题图图层id

layerOptions Object

专题图图层配置项
opacity -{number} 图层透明度,默认1
parseNumber -{boolean} 是否预处理数据,将数据转换为number,默认false
enableHighlight -{boolean} 是否开启高亮,默认false
highlight -{Object} 高亮颜色,默认"#ADA91E"
baseHeightField -{string} 数据中表示基础高度的字段
height -{number} 高度。如果数据指定的heightField(默认height)没有可以表示高度的字段,可以为所有数据统一设置一个高度
heightField -{string} 数据中表示高度的字段
themeField -{string} 专题展示的字段
showLegend -{boolean} 是否显示图例,默认显示
legendTitle -{string} 图例标题
legendTheme -{string} 图例主题,取值:'light','dark',默认:'light'
legendOrientation -{string} 图例方向,取值:'horizontal','vertical',默认:'horizontal'
legendPosition -{string} 图例位置,取值:'top-right'|'top-left'|'bottom-left'|'bottom-right'

Members

baseHeightFieldstring

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

enableHighlightboolean

是否开启高亮,默认false

heightnumber

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

heightFieldstring

数据中表示高度的字段

highlightObject

高亮相关配置,默认null

idstring

mapbox gl图层id

legendOrientationstring

图例方向,取值:'horizontal','vertical',默认:'horizontal'

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

图层透明度,默认1

parseNumberboolean

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

showLegendBoolean

是否显示图例

themeFieldstring

专题展示的字段

Methods

addTo(map){this}

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

添加图层到地图上

Name Type Description
map Object

mapboxgl 地图对象

Returns:
Type Description
this

getData(){Object}

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

获取数据,返回的数据格式为geojson

Returns:
Type Description
Object

getHighlightStyleOptions(){Object}

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

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

Returns:
Type Description
Object mapbox gl样式对象

getLayerStyleOptions(){Object}

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

获取图层样式

Returns:
Type Description
Object mapbox gl样式对象

remove(){this}

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

从地图上移除图层

Returns:
Type Description
this

setData(data, parseNumber)

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

设置数据,数据格式必须为geojson格式

Name Type Description
data object

geojson格式数据

parseNumber object

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

setHighlightStyleOptions(highlightOptions){this}

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

设置图层高亮相关参数

Name Type Description
highlightOptions object

该专题图图层高亮相关参数
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

该专题图图层相关参数

  • opacity -{number} 图层透明度,默认1
    parseNumber -{boolean} 是否预处理数据,将数据转换为number,默认false
    baseHeightField -{string} 数据中表示基础高度的字段
    height -{number} 高度。如果数据指定的heightField(默认height)没有可以表示高度的字段,可以为所有数据统一设置一个高度
    heightField -{string} 数据中表示高度的字段
    themeField -{string} 专题展示的字段
    showLegend -{boolean} 是否显示图例,默认显示
    legendTitle -{string} 图例标题
    legendTheme -{string} 图例主题,取值:'light','dark',默认:'light'
    legendOrientation -{string} 图例方向,取值:'horizontal','vertical',默认:'horizontal'
    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