Class: Household

Summary

Methods:

fromJSON	将JSON对象转成相应的要素类
getAttributes	获取当前要素的属性信息
getFid	获取系统保留的唯一标识
getFloor	获取户室所在楼层
getRoomName	获取户室名
getSurfaceSymbols	获取户室表面样式
getType	返回要素的类型
getUnitNumber	获取户室所在单元号
saveData	保存户室数据至对应矢量楼块图服务
setAttributes	设置地理要素的非空间属性。注意，该操作会覆盖原有属性
setBorderSymbol	设置边框样式
setGeometry	重新设置地理要素的几何体
setHouseholdHeight	设置户室高度
setHouseholdVisibility	设置可见性
setLabelVisibility	设置注记的可见性
setShowBorder	设置边框可见性
setSurfaceSymbols	设置户室表面样式
toJSON	将要素转化成JSON对象

Constructor

new Household(geometry, attributes, options)

Parameters:

Name Type Description

geometry

module:geom~Geometry

地理几何体

attributes

Object

一个对象，用来描述地理要素的非空间属性,可用来存储户室的地址等自定义属性

Name	Type	Description
`height`	Number	楼层高度，单位为米，默认为户室所在楼层高度
`unitId`	Number	户室所在单元号
`unitName`	String	单元名称
`roomName`	String	户室名，例如102室
`description`	String	户室描述
`roomType`	Number	房间类型 0-厅 1-卧室 2-卫生间 3-厨房 4-商户 5-仓库 6-设备间 7-办公室 8-监舍 9-会客厅
`datasetName`	String	数据集名称
`label`	String	注记本文

options

Object

可选属性设置

Name	Type	Description
`showBorder`	Boolean	是否显示边框
`borderSymbol`	module:style~LineSymbol	边框样式，目前仅支持设置线的宽度，实线/虚线，其中虚线时dashRatio不支持
`roofSymbol`	module:style~FillSymbol	顶面样式设置，样式设置透明度效果受绘制顺序影响
`facadeSymbol`	module:style~FillSymbol	侧面样式设置，样式设置透明度效果受绘制顺序影响
`surfaceSymbol`	module:style~FillSymbol	表面纯色样式设置，当设置roofSymbol和facadeSymbol的时候surfaceSymbol纯色无效，优先级低于前两者。样式设置透明度效果受绘制顺序影响

Example

const polygon = new hmap.geom.Polygon([lineRing]);
let household = new hmap.indoor.Household(polygon, null, {
 surfaceSymbol: new hmap.style.ColorFill(new hmap.style.Color(0, 0, 255, 1)),
 showBorder: true
});

Methods

static fromJSON(json) → {module:indoor~Household}

将JSON对象转成相应的要素类

Parameters:

Name	Type	Description
`json`	JSON	JSON对象

Returns:

module:indoor~Household -

户室

getAttributes() → {JSON}

获取当前要素的属性信息

Returns:

JSON -

当前要素的属性信息

getFid() → {String}

获取系统保留的唯一标识

Returns:

String -

唯一标识

getFloor() → {module:indoor~Floor}

获取户室所在楼层

Returns:

module:indoor~Floor -

户室所在楼层

getRoomName() → {String}

获取户室名

Returns:

String -

户室名

getSurfaceSymbols() → {Object}

获取户室表面样式

Returns:

Object -

户室表面样式

getType() → {String}

返回要素的类型

Returns:

String -

要素类型

getUnitNumber() → {Number}

获取户室所在单元号

Returns:

Number -

户室所在单元号

saveData() → {Promise}

保存户室数据至对应矢量楼块图服务

Throws:

户室对象必须添加到楼层对象中，才能执行saveData方法

Returns:

Promise -

返回保存是否成功的信息

setAttributes(attributes)

设置地理要素的非空间属性。注意，该操作会覆盖原有属性

Parameters:

Name	Type	Description
`attributes`	JSON	属性信息

setBorderSymbol(lineSymbol)

设置边框样式

Parameters:

Name	Type	Description
`lineSymbol`	module:style~LineSymbol	边框样式

setGeometry(geom)

重新设置地理要素的几何体

Parameters:

Name	Type	Description
`geom`	module:geom~Geometry	几何体对象

Throws:

当参数geom不是Geometry子类的实例时，抛出异常："Household setGeometry: the parameter is not a Geometry ."

setHouseholdHeight(height)

设置户室高度

Parameters:

Name	Type	Description
`height`	Number	户室高度，单位米

setHouseholdVisibility(visible)

设置可见性

Parameters:

Name	Type	Description
`visible`	Boolean	可见用true;不可见用false

Example

household.setHouseholdVisibility(true);

setLabelVisibility(visible)

设置注记的可见性

Parameters:

Name	Type	Description
`visible`	Boolean	是否可见，可见时为true，不可见为false

setShowBorder(visible)

设置边框可见性

Parameters:

Name	Type	Description
`visible`	Boolean	边框的可见性

setSurfaceSymbols(symbols)

设置户室表面样式

Parameters:

Name Type Description

symbols

Object

Name	Type	Description
`roofSymbol`	module:style~FillSymbol	顶面样式设置
`facadeSymbol`	module:style~FillSymbol	侧面样式设置
`surfaceSymbol`	module:style~FillSymbol	表面纯色样式设置，当设置roofSymbol和facadeSymbol的时候surfaceSymbol纯色无效，优先级低于前两者

toJSON() → {JSON}

将要素转化成JSON对象

Returns:

JSON -

JSON对象