Appearance
utils
工具包
函数
| 函数 | 描述 |
|---|---|
| deepClone | 复制克隆对象 |
| formatNum | 格式化数字，返回指定小数位的数字 |
| template | 根据数据和格式化字符串模板，返回字符串 |
| getColorRampLegend | 获取当前图层的图例图片 |
| getRampValueColor | 根据给定值和 CanvasRenderingContext2D 获取颜色值 |
| loopArrayCallback | 遍历数组或对象（实际上，对于对象，此方法仅调用一次回调函数），并对每个元素（或对象本身）执行回调函数。 如果输入是数组，则收集回调函数的返回值到一个新数组中并返回该数组；如果输入是对象，则直接返回回调函数的返回值（注意：此行为可能需要根据实际需求调整）。 |
| deepMerge | 合并两个对象或数组 |
| deepMergeAll | 合并多个对象或数组 |
功能: Dom操作相关
| 函数 | 描述 |
|---|---|
| createDom | 创建一个tagName的HTML元素，将其class设置为className，并可选择将其添加到container元素中 |
| createSvg | 创建svg元素 |
| createVideo | 创建Video元素 |
| get | 返回给定DOM id的元素，或者返回元素本身 |
| parseDom | 将HTML字符串解析为DOM |
| remove | 从其父元素中移除元素 |
| empty | 删除所有子元素 |
| getStyle | 返回元素上某个样式属性的值 |
| hasClass | 判断元素是否有指定class样式 |
| addClass | 在元素上添加指定的name的class样式 |
| removeClass | 在元素上移除指定的name的class样式 |
| setClass | 在元素上赋值设置指定的name的class样式 |
| getClass | 获取dom元素上的class样式名称 |
| enterFullscreen | 进入全屏 |
| exitFullscreen | 退出全屏 |
功能: IS判断相关
| 函数 | 描述 |
|---|---|
| isDef | 是否已声明 |
| isUnDef | 是否未声明 |
| isObject | 是否为Object |
| isEmpty | 是否为空对象或数组或Map或Set或字符串 |
| isDate | 是否为日期对象 |
| isNumber | 是否为number |
| isPromise | 是否为Promise |
| isString | 是否为string |
| isFunction | 是否为方法函数 |
| isBoolean | 是否为boolean |
| isRegExp | 是否为正则对象 |
| isArray | 是否为数组 |
| isWindow | 是否为window对象 |
| isElement | 是否为dom节点 |
| isMap | 是否为Map对象 |
| isUrl | 是否为http或https开头的url |
| isDark | 是否浏览器系统的主题色是否被设置为暗色 |
| isImgPath | 是否为以http或https开头，以png/jpg/jpeg/gif/svg/webp/ico等结尾的图片链接 |
| isMergeableObject | 是否为可合并的对象 |
| isSimpleType | 判断对象是否为简单类型（包括：String\Boolean\Number\Array） |
功能: image操作相关
| 函数 | 描述 |
|---|---|
| dom2Base64 | html dom 转 Base64 |
| image2Base64 | 图片对象 转 Base64编码 |
| getImgBase64 | 根据路径获取图片Base64编码 |
| mergeImage | 合并两张图片 |
功能: 树结构相关
| 名称 | 描述 |
|---|---|
| TreeCallbackFn | 回调函数类型 - 类型 |
| TreeMappingConfig | 配置项类型 - 类型 |
| listToTree | 集合转成树结构数据 |
| treeToList | 树结构数据转成集合 |
| findNode | 找到一个符合条件的节点 |
| findNodeAll | 找到多个符合条件的节点 |
| findPath | 找到符合条件的最终节点，并将节点的父级一级一级向上全部返回 |
| findPathAll | 找到符合条件的最终节点集合，并将节点的父级一级一级向上全部返回 |
| filterTree | 根据条件过滤树结构数据 |
| forEachTree | 遍历树结构数据 |
| treeMap | 对树结构中每个数据进行指定函数的变换，并返回新的树 |
功能: 随机ID相关
| 函数 | 描述 |
|---|---|
| guid | guid生成器 |
| isGuid | 是否为guid |
| shortGuid | 获取一段短的guid |
| isShortGuid | 是否为短的guid |
参考
BaseEvent
重新导出 BaseEvent
命名空间
| 命名空间 | 描述 |
|---|---|
| camera | 相机视角相关工具函数 |
| effect | 特效工具函数 |
| layer | 图层相关工具函数 |
| map | - |
| material | 矢量数据材质工具函数 |
| widget | 控件工具函数 |
接口
| 接口 | 描述 |
|---|---|
| BaseListener | 基类事件监听器，通常将一类事件的所有监听器以集合的形式存储 |
| StartFlickerOptions | 高亮闪烁控制参数 |
| HighlightTilesetSchema | 3dtiles模型高亮模式类型 |
| HighlightTilesetOptions | 3dtiles模型高亮特效类构造函数 |
| MouseTooltipOptions | 鼠标移动提示框类构造参数类型 |
| PopupEventData | 弹窗类事件数据类型 |
| PopupOptions | 弹窗实例类构造参数类型 |
| Dom2Base64Option | html dom 转 Base64 相关参数，同domtoimage.toPng |
类
| 类 | 描述 |
|---|---|
| BaseClass | 基础类，SDK中所有类的基类 |
| FlickerEntity | 定时闪烁高亮Entity（点、线、面） |
| HighlightTileset | 3dtiles模型高亮特效类，支持feature的描边、单体颜色高亮 |
| LatLngArray | 表示经纬度点数组的工具类 |
| LatLngPoint | 表示经纬度点的工具类 |
| MouseTooltip | 鼠标移动提示框类，一般用于鼠标操作的文字提示 |
| Popup | 弹窗实例类 |
类型别名
| 类型别名 | 描述 |
|---|---|
| ParserLatLngPointInput | 解析器：可将如下类型转换为LatLngPoint对象 |
| ColorRamp | 色带数组类型 |