DTS二次开发文档

Class: TileLayer

TileLayer

TileLayer增、删、改、查相关的操作
一般通过api.tileLayer调用其方法

<protected> new TileLayer()

See:

Extends

Methods

add(data, fn)

添加一个或多个TileLayer对象

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • fileName (string) 3dt文件路径

  • visible (boolean) 添加后是否可见，默认值：true 可见

  • viewHeightRange (array) 可见高度范围：[最小可见高度, 远最大可见高度]，默认值: [-1000000000, 1000000000]

  • releaseWhenHidden (boolean) 隐藏图层时是否释放资源，默认值：false 不释放

  • location (array) 位置坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • rotation (array) 旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • scale (array) 缩放：[X,Y,Z]，数组元素类型：(number)，取值范围：[任意正整数]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addHole(data, fn)

根据挖洞多边形的坐标添加一个或多个挖洞操作，注意：同时只能对一个图层id进行挖洞操作

Parameters:
Name Type Description
data object | array

对象或数组类型，如果是数组类型，对于每个数组元素，有以下属性：

  • id (string) 挖洞操作唯一标识符
  • tileLayerId (string) TileLayer对象的ID
  • coordinates (array) 挖洞多边形的坐标数组，二维数组，数组元素类型：挖洞多边形的坐标，取值示例
  • innerRings (array) 挖洞多边形的内环，三维数组，数组元素类型：挖洞多边形的坐标数组
  • isReverseCut (boolean) 挖洞多边形是否反转，默认值：false
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addHoleByShapeFile(data, fn)

根据shapeFile添加一个或多个挖洞操作

Parameters:
Name Type Description
data object | array

对象或数组类型，如果是数组类型，对于每个数组元素，有以下属性：

  • tileLayerId (string) TileLayer对象的ID
  • shapeFilePath (string) shapeFilePath文件路径，支持本地路径和网络路径，资源引入说明
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addModifier(id, tileLayerId, coordinates, ententBufferSize, fn)

添加一个压平操作

Parameters:
Name Type Description
id string

唯一标识符
tileLayerId string

TileLayer对象的ID
coordinates array

压平多边形的坐标，取值示例
ententBufferSize number

羽化范围，取值范围：[任意正浮点数]，单位：米
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addModifierByShapeFile(data, fn)

根据shapeFile添加一个或多个压平操作

Parameters:
Name Type Description
data object | array

对象或数组类型，如果是数组类型，对于每个数组元素，有以下属性：

  • id (string) 压平操作唯一标识符
  • tileLayerId (string) TileLayer对象的ID
  • shapeFilePath (string) shapeFilePath文件路径，支持本地路径和网络路径，资源引入说明
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addModifiers(data, fn)

根据多边形的坐标添加一个或多个压平操作，注意：同时只能对一个图层id进行压平操作

Parameters:
Name Type Description
data object | array

对象或数组类型，如果是数组类型，对于每个数组元素，有以下属性：

  • id (string) 压平操作唯一标识符
  • tileLayerId (string) TileLayer对象的ID
  • coordinates (array) 压平多边形的坐标数组，二维数组，数组元素类型：压平多边形的坐标，取值示例
  • innerRings (array) 压平多边形的内环，三维数组，数组元素类型：压平多边形的坐标数组
  • ententBufferSize (number) 羽化范围，取值范围：[任意正浮点数]，单位：米
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

clear(fn)

清空接口添加的所有图层对象

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

clearHole(ids, fn)

清空所有挖洞操作

Parameters:
Name Type Description
ids string | array

TileLayer对象的ID或数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

clearModifier(ids, fn)

清空所有压平操作

Parameters:
Name Type Description
ids string | array

TileLayer对象的ID或数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

createQuery()

创建数据库查询条件对象

Returns:

QueryOption类的对象

delete(ids, fn)

删除一个或多个TileLayer对象

Parameters:
Name Type Description
ids string | array

要删除的TileLayer对象的ID或者ID数组（可以删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

deleteHole(id, tileLayerId, fn)

删除一个挖洞操作

Parameters:
Name Type Description
id string

唯一标识符
tileLayerId string

TileLayer对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

deleteModifier(id, tileLayerId, fn)

删除一个压平操作

Parameters:
Name Type Description
id string

唯一标识符
tileLayerId string

TileLayer对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

disableClip(ids, fn)

禁止TileLayer图层参与剖切

Parameters:
Name Type Description
ids number | array

TileLayer的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

disableXRay(ids, fn)

禁用X光

Parameters:
Name Type Description
ids number | array

TileLayer的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

enableClip(ids, fn)

设置TileLayer图层参与剖切

Parameters:
Name Type Description
ids number | array

TileLayer的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

enableDecal(data, fn)

设置图层对贴花类型对象的贴合支持，包含Decal对象和HeatMap对象

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • tileLayerId (string) 图层Id

  • supportAttach (boolean) 图层是否支持对贴花类型对象的贴合
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

enableImageLayerDecal(data, fn)

设置指定图层是否支持对网络图层服务(WMTS、WMS、MVT等)进行贴合

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • tileLayerId (string) 图层Id

  • supportAttach (boolean) 图层是否支持对WMTS服务进行贴合
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

enableXRay(ids, color, fn)

启用X光，效果图如下：

Parameters:
Name Type Description
ids number | array

TileLayer的ID或者ID数组
color Color

颜色，支持四种格式，取值示例
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focus(ids, distance, flyTime, rotation, fn)

自动定位到合适的观察距离

Parameters:
Name Type Description
ids string | array

TileLayer对象的ID或者ID数组
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focusActor(id, objectId, distance, flyTime, rotation, fn)

定位一个Actor

Parameters:
Name Type Description
id string

TileLayer的ID
objectId string

Actor的ID
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focusActors(data, distance, flyTime, rotation, fn)

定位一个或多个Actor

Parameters:
Name Type Description
data object

数据对象，对象支持以下属性：

  • id (string) TileLayer的ID
  • objectIds (array) TileLayer里的Actor的ObjectID（单个或者数组）
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

get(ids, fn)

根据ID获取TileLayer的详细信息

Parameters:
Name Type Description
ids string | array

要获取的TileLayer对象ID或者ID数组（可以获取一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回TileLayer的详细信息
{
            "id":	"1",
            "groupId":	"",
            "userData":	"",
            "dbTabId": "", //存储在空间数据库的tileLayer对应的数据库表id
            "fileName":	"G:\\TEMP\\Explorer\\SDK\\JS\\media\\project\\demo_files\\SDKDemo.3dt",
            "location":	[174.309998, -589.890015, 0.000000],
            "rotation":	[0.000000, 0.000000, 0.000000],
            "scale":	[1.000000, 1.000000, 1.000000],
            "minVisibleHeight": 1, //最小可见高度
            "maxVisibleHeight": 100000,//最大可见高度
            "bFlattenSupported": 0 //图层是否支持压平
            "bbox":	[-501384.875000, -1520.400024, -1499.900024, -498384.875000, 1479.599976, 1500.099976] //三维图层包围盒
        }

getActorInfo(data, fn)

通过OID查询Actor的矩阵和bound等信息

Parameters:
Name Type Description
data object | array

对象或数组类型，如果是数组类型，对于每个数组元素，有以下属性：

  • id (string) TileLayer对象的ID
  • objectIds (array) TileLayer里的Actor的ObjectID字符串（单个或者数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Examples
请求代码示例
fdapi.tileLayer.getActorInfo({
            id: 1,
            objectIds: ["SM_outdoor_wall_01_2"]
        });
返回的Actor的矩阵和bound等数据结构
     [{
            "location":	[316.089996, -600.369995, 3.599998],
            "rotation":	[0.000000, 0.000000, 0.000000],
            "scale":	[1.000000, 1.000000, 1.000000],
            "boundsMin":	[283.429169, -602.198792, 3.599805],
            "boundsMax":	[316.110809, -595.981201, 23.368118]
        }]

getActorInfoFromDB(data, fn)

从空间数据库获取TileLayer下指定Actor的详细属性信息 注意:调用前需先配置Explorer里空间库的对应信息，配置示例如下图：

Parameters:
Name Type Description
data array | object

对象或数组类型，如果是数组类型，每个元素有以下属性：tileLayerId, objectIds

  • tileLayerId (string) TileLayer对象的ID
  • objectIds (array) TileLayer里的Actor的ObjectID字符串（单个或者数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Examples
请求代码示例
    //getActorInfoFromDB方法的参数可以是object或者array
			fdapi.tileLayer.getActorInfoFromDB([{ "tileLayerId": "91B748AB429AF0823D12EEBFA6334EBF", "objectIds":["SM1","SM2","SM3"] },{ "tileLayerId": "6388C5CC461B85523F69C2B04144BF2E", "objectIds":["Floor1","Floor2"] }]);
函数返回对象结构详细信息示例
     [{
            "uuid":	"85995df1-bdee-438c-a16b-13caa47ffe66-0004d740",
            "category":	"墙",
            "file":	"data/rvt/gld/arch/-1F装修.rvt",
            "room":	"NULL",
            "geom":	"NULL",
            "elementid":	317248,
            "mep":	0,
            "level":	-14.763780,
            "projectlevel":	-14.763780,
            "properties":	[{
                    "ElementID":	"317248",
                    "UniqueID":	"85995df1-bdee-438c-a16b-13caa47ffe66-0004d740",
                    "RevitFileIndex":	"0",
                    "Category":	"墙",
                    "MEP":	"False",
                    "标高名称":	"-1F",
                    "标高":	"-14.7637795275642",
                    "工程标高":	"-14.7637795275642",
                    "房间边界":	"true",
                    "顶部延伸距离":	"0 毫米",
                    "类型":	"钢筋混凝土墙体_300mm",
                    "族":	"钢筋混凝土墙体_300mm",
                    "在插入点包络":	"不包络",
                    "厚度":	"300 毫米",
                    "类型名称":	"钢筋混凝土墙体_300mm",
                    "吸收率":	"0.7 ",
                    "在端点包络":	"无",
                    "粗糙度":	"3",
                    "族名称":	"基本墙",
                    "粗略比例填充样式":	"混凝土-素砼",
                    "粗略比例填充颜色":	"0",
                    "功能":	"内部",
                    "幕墙":	"false",
                    "结构":	"true",
                    "族与类型":	"钢筋混凝土墙体_300mm",
                    "类型 ID":	"钢筋混凝土墙体_300mm",
                    "底部约束":	"-1F",
                    "已附着底部":	"false",
                    "已附着顶部":	"false",
                    "无连接高度":	"4500.00000000158 毫米",
                    "体积":	"2.40862595316295 立方米",
                    "启用分析模型":	"true",
                    "面积":	"8.02875317720987 平方米",
                    "钢筋保护层 - 外部面":	"钢筋保护层 1",
                    "定位线":	"墙中心线",
                    "底部偏移":	"0 毫米",
                    "钢筋保护层 - 内部面":	"钢筋保护层 1",
                    "底部延伸距离":	"0 毫米",
                    "顶部偏移":	"0 毫米",
                    "结构用途":	"承重",
                    "与体量相关":	"false",
                    "钢筋保护层 - 其他面":	"钢筋保护层 1",
                    "创建的阶段":	"新构造",
                    "顶部约束":	"1F",
                    "长度":	"3999.99999999814 毫米"
                }]
        }]

getAllFlattenInfo(fn)

查询所有图层是否支持压平

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回所有TileLayer是否支持压平
[{
            "id":	"0",
            "bFlattenSupported":	0 //不支持压平
        },{
            "id":	"1",
            "bFlattenSupported":	1 //支持压平
        },{
            "id":	"1",
            "bFlattenSupported":	1 //支持压平
        }]

getCollision(tileLayerIds, fn)

查询图层包含的碰撞检测信息

Parameters:
Name Type Description
tileLayerIds string | array

TileLayer对象的ID或ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回数据示例：
[{
            "id":	"E637D8FE42335EE96C58A1840BCAD0CE",
            "enabled":	1,
            "mouseInteract":	1,
            "mouseFunction":	1,
            "characterCollision":	1
        }]

getObjectIDs(ids, fn)

获取指定TileLayer包含的所有Actor对象的ID

Parameters:
Name Type Description
ids string | array

TileLayer的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回TileLayer的所有ObjectID信息结构示例
[{
            "id":	"1",
            "objectIds":	["WorldSettings", "Brush_0", "SM_colum_02_2", "SM_colum_3", "SM_floor_130", "SM_floor_195", "SM_floor_313", "SM_floor_352", "SM_colum_24", "SM_colum_25", "SM_floor_399", "SM_Road_04_5", "SM_Road_05_8", "SM_Road_5", "SM_Road_6", "SM_floor_400", "SM_floor_401", "SM_floor_402", "SM_floor_403", "SM_entrance_roof_01_11", "P_raunfall2", "P_raunfall4", "SM_pot_4", "SM_pot_9", "PointLight13", "PointLight14", "SM_wall_30", "SM_main_door_02_2", "SM_main_door_3", "SM_wall_51", "SM_outdoor_wall_01_2", "SM_column_04_2", "SM_column_24", "SM_column_29", "SM_column_35", "SM_ATM_4", "SM_wall_140", "SM_wall_141", "SM_wall_142", "SM_floor_01_28", "SM_floor_2", "SM_floor_3", "SM_floor_4", "SM_floor_5", "SM_floor_6", "SM_floor_7", "SM_floor_8", "SM_floor_9", "SM_floor_10", "SM_floor_11", "SM_floor_12", "SM_floor_03_414", "SM_floor_05_15", "SM_floor_06_57", "SM_sofa_3", "SM_sofa_4", "Palm_01_30", "Palm_02_33", "Palm_04_36", "Palm_03_39", "SM_pot_5", "SM_pot_6", "SM_pot_7", "SM_pot_8", "SM_reception_01_2", "PointLight22", "PointLight23", "PointLight24", "PointLight27", "SM_column_03_17", "SM_column_4", "SM_column_5", "SM_wall_55", "SM_wall_56", "SM_wall_57", "PointLight38", "PointLight69", "SM_elevator_glass_fence_31", "SM_colum_13", "SM_colum_20", "SM_glass_window_01_4", "SM_glass_window_2", "SM_glass_window_3", "SM_glass_window_4", "SM_glass_window_5", "SM_elevator_wall_03_15", "SM_table_3", "SM_table_4", "SM_bed_6", "SM_bed_7", "SM_ATM_01_2", "DecalActor75_2", "DecalActor77", "SM_wall_352", "SM_ATM_6", "EmergencyRoom_C_3"]
        }]

hide(ids, fn)

隐藏TileLayer图层

Parameters:
Name Type Description
ids string | array

TileLayer对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hideActor(id, objectId, fn)

隐藏Actor

Parameters:
Name Type Description
id string

TileLayer的ID
objectId string

Actor的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hideActors(data, fn)

隐藏一个或多个Actor

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (string) TileLayer的ID
  • objectIds (array) TileLayer里的Actor的ObjectID（单个或者数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hideAllActors(tileLayerIds)

隐藏指定tilelayer的所有Actor

Parameters:
Name Type Description
tileLayerIds string | array

TileLayer的ID或ID数组

highlightActor(id, objectId, fn)

高亮一个Actor，效果图如下：

Parameters:
Name Type Description
id string

TileLayer的ID
objectId string

Actor的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

highlightActors(data, fn)

高亮多个Actor，同时支持高亮多个图层的Actor

Parameters:
Name Type Description
data object | array

数据对象，支持以下属性：

  • id (string) TileLayer的ID
  • objectIds (array) TileLayer里的Actor的ObjectID（单个或者数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

<async> query(queryOption, fn)

根据TileLayer的ID在PG数据库中查询

Parameters:
Name Type Description
queryOption QueryOption

查询条件对象 请参考： QueryOption
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setCollision(tileLayerIds, enabled, mouseInteract, mouseFunction, characterCollision, fn)

设置TileLayer是否参与碰撞检测

Parameters:
Name Type Description
tileLayerIds string | array

TileLayer对象的ID或ID数组
enabled boolean

是否开启碰撞检测的总开关，如果此参数设置为false，则下面三个参数均会失效
mouseInteract boolean

是否开启鼠标交互，默认值：true 开启
mouseFunction boolean

是否开启鼠标相关的功能交互，包含鼠标拾取、分析工具、测量工具等，默认值：true 开启
characterCollision boolean

是否开启角色碰撞，默认值：true 开启角色碰撞
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setFileName(id, newVal, fn)

修改TileLayer图层的3dt文件路径

Parameters:
Name Type Description
id string

TileLayer的ID
newVal string

3dt文件路径
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setHeatMapStyle(tileLayerIds, colors, fn)

设置TileLayer为分层热力样式

Parameters:
Name Type Description
tileLayerIds string | array

TileLayer的ID或ID数组
colors array

颜色分层调色板数组，数组包含的每一个对象包含高度属性和对应颜色值

  • value (number) 3dt图层的高度
  • color (array) 高度对应的颜色值，示例：[1,0,0,1]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setLocation(id, newVal, fn)

设置平移

Parameters:
Name Type Description
id string

TileLayer的ID
newVal array

新的位置坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setPointCloudSize(id, pointCloudSize, fn)

设置TileLayer图层的点云大小，注意：仅对点云数据转换的3dt图层模型生效

Parameters:
Name Type Description
id string

TileLayer的ID
pointCloudSize number

点云缩放的倍数，取值范围：[0.01~4]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setRotation(id, newVal, fn)

设置旋转

Parameters:
Name Type Description
id string

TileLayer的ID
newVal array

新的旋转坐标：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setScale(id, newVal, fn)

设置缩放

Parameters:
Name Type Description
id string

TileLayer的ID
newVal any

新的缩放：[X,Y,Z]，数组元素类型：(number)，取值范围：[任意正整数]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setStyle(tileLayerIds, style, color, saturation, brightness, contrast, contrastBase, fn)

设置TileLayer的样式

Parameters:
Name Type Description
tileLayerIds string | array

TileLayer的ID或ID数组
style number

样式， 0：默认；1：X光；2：纯色；3：水晶体；4：暗黑；5：科幻；6：扩散
color Color

颜色，默认值:Color.White，支持四种格式，取值示例
saturation number

饱和度，仅在默认样式0下生效，取值范围：[0~2]，默认值：1.0
brightness number

亮度 ，仅在默认样式0下生效，取值范围：[0.1~10]，默认值：1.0
contrast number

对比度，仅在默认样式0下生效，取值范围：[0.2~5]，默认值：1.0
contrastBase number

对比度基准，仅在默认样式0下生效，取值范围：[0.036~0.9]，默认值：0.18
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Since:
  • 2020.01.11 Version:325

setViewHeightRange(id, minViewHeight, maxViewHeight, fn)

设置TileLayer图层的可视高度范围

Parameters:
Name Type Description
id string

TileLayer的ID
minViewHeight number

可视高度范围最小值，取值范围：[任意负数~任意正数]，单位：米
maxViewHeight number

可视高度范围最大值，取值范围：[任意负数~任意正数]，单位：米
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setViewportVisible(id, vp, fn)

多视口状态下，设置图层在各视口的可见性

Parameters:
Name Type Description
id string

TileLayer唯一标识符
vp Viewport

视口掩码（Viewport位运算）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

show(ids, fn)

显示TileLayer图层

Parameters:
Name Type Description
ids string | array

TileLayer对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showActor(id, objectId, fn)

显示Actor

Parameters:
Name Type Description
id string

TileLayer的ID
objectId string

Actor的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showActors(data, fn)

显示一个或多个Actor

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (string) TileLayer的ID
  • objectIds (array) TileLayer里的Actor的ObjectID（单个或者数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showAllActors(tileLayerIds)

显示指定tilelayer的所有Actor

Parameters:
Name Type Description
tileLayerIds string | array

TileLayer的ID或ID数组

stopHighlightActor(id, objectId, fn)

取消高亮一个Actor

Parameters:
Name Type Description
id string

TileLayer的ID
objectId string

Actor的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

stopHighlightActors(data, fn)

停止高亮多个Actor，同时支持停止高亮多个图层的Actor

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (string) TileLayer的ID
  • objectIds (array) TileLayer里的Actor的ObjectID（单个或者数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

stopHighlightAllActors(fn)

停止高亮所有Actor

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

update(data, fn)

修改一个或多个TileLayer对象

Parameters:
Name Type Description
data object | array

数据结构，请参考add方法
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:
Overrides:
Example
fdapi.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     fdapi.xxx.setColor(i, Color.Yellow);
} 
fdapi.xxx.updateEnd(function () {
     log('update finished!');
});

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Inherited From:
Overrides:

updateHole(id, tileLayerId, holeCoordinate, isReverseCut, fn)

修改一个挖洞操作

Parameters:
Name Type Description
id string

唯一标识符
tileLayerId string

TileLayer对象的ID
holeCoordinate array

待修改挖洞的坐标，取值示例
isReverseCut boolean

挖洞多边形是否反转，默认值：false
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateModifier(id, tileLayerId, coordinates, ententBufferSize, fn)

修改一个压平操作

Parameters:
Name Type Description
id string

唯一标识符
tileLayerId string

TileLayer对象的ID
coordinates array

压平多边形的坐标
ententBufferSize number

羽化范围，取值范围：[任意正浮点数]，单位：米
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

<async> updateRecord(id, newValMap, where, fn)

更新TileLayer关联的数据库记录

Parameters:
Name Type Description
id string

tileLayer的ID
newValMap object

要设置的新值格式：{Key:Value}
where string

查询条件
fn function

可选的回调函数，请参考二次开发：异步接口调用方式