JSAPI Three API Reference
    正在准备搜索索引...

    类 EngineWidgets

    引擎UI控件入口
    该类会随Engine的初始化自动实例化，不需要开发者手动执行初始化调用，通过engine.widgets访问

    // 动态启用组件
    engine.widgets.logo.enabled = true;

    // 初始化时配置组件
    const engine = new Engine(container, {
        widgets: {
            logo: {
                enabled: true,
            },
            zoom: {
                enabled: true
            },
            scale: {
                enabled: true
            },
            fullscreen: {
                enabled: true
            },
            geoLocate: {
                enabled: true
            },
            exportImage: {
                enabled: true
            },
            mapInfo: {
                enabled: true,
                template: 'CHP',
                separator: ', '
            },
            compass: {
                enabled: true
            },
            drawer: {
                enabled: true,
                draws: [{
                    defaultChecked: true,
                    name: '点图层',
                    data: 'point',
                    onChange: (checked, data, engine) => {
                        console.log(checked, data, engine);
                    }
                }, {
                    name: '面图层',
                    data: 'polygon',
                    onChange: (checked, data, engine) => {
                        console.log(checked, data, engine);
                    }
                }]
            }
        }
    });
    索引

    构造函数

    constructor

    访问器

    compass container engine exportImage fullscreen geoLocate logo mapInfo scale zoom

    构造函数

    • 参数

      • engine: Engine

        引擎实例

      • options: {
            compass: { enabled: boolean };
            drawer: {
                draws: {
                    data: object;
                    defaultChecked: boolean;
                    name: object;
                    onChange: Function;
                };
                enabled: boolean;
            };
            exportImage: { enabled: boolean };
            fullscreen: { enabled: boolean };
            geoLocate: { enabled: boolean };
            logo: { enabled: boolean };
            mapInfo: { enabled: boolean; separator: object; template: object };
            scale: { enabled: boolean };
            zoom: { enabled: boolean };
        } = {}

        控件配置选项

        • compass: { enabled: boolean }

          指南针控件配置

          • enabled: boolean

            是否启用指南针控件

        • drawer: {
              draws: {
                  data: object;
                  defaultChecked: boolean;
                  name: object;
                  onChange: Function;
              };
              enabled: boolean;
          }

          抽屉控件配置

          • draws: { data: object; defaultChecked: boolean; name: object; onChange: Function }

            抽屉控件的绘制配置

            • data: object

              抽屉控件的数据

            • defaultChecked: boolean

              抽屉控件的默认选中状态

            • name: object

              抽屉控件的名称

            • onChange: Function

              抽屉控件的选中状态改变回调函数

          • enabled: boolean

            是否启用抽屉控件

        • exportImage: { enabled: boolean }

          导出图片控件配置

          • enabled: boolean

            是否启用导出图片控件

        • fullscreen: { enabled: boolean }

          全屏控件配置

          • enabled: boolean

            是否启用全屏控件

        • geoLocate: { enabled: boolean }

          定位控件配置

          • enabled: boolean

            是否启用定位控件

        • logo: { enabled: boolean }

          logo控件配置

          • enabled: boolean

            是否启用logo控件

        • mapInfo: { enabled: boolean; separator: object; template: object }

          地图信息控件配置

          • enabled: boolean

            是否启用地图信息控件

          • separator: object

            地图信息分隔符，默认值为' | '

          • template: object

            地图信息模板，默认值为'CR'，其中'C'表示中心点，'R'表示视野距离，'H'表示旋转角度，'P'表示倾斜角度

        • scale: { enabled: boolean }

          比例尺控件配置

          • enabled: boolean

            是否启用比例尺控件

        • zoom: { enabled: boolean }

          缩放控件配置

          • enabled: boolean

            是否启用缩放控件

      返回 EngineWidgets

    访问器

    • get compass(): Compass

      compass组件实例，通过.enable属性控制启用

      返回 Compass

    • get container(): any

      mapvthree的容器

      返回 any

    • get engine(): any

      engine对象

      返回 any

    • get exportImage(): ExportImage

      exportImage组件实例，通过.enable属性控制启用

      返回 ExportImage

    • get fullscreen(): Fullscreen

      fullscreen组件实例，通过.enable属性控制启用

      返回 Fullscreen

    • get geoLocate(): GeoLocate

      geoLocate组件实例，通过.enable属性控制启用

      返回 GeoLocate

    • logo组件实例，通过.enable属性控制启用

      返回 Logo

    • get mapInfo(): MapInfo

      mapInfo组件实例，通过.enable属性控制启用

      返回 MapInfo

    • get scale(): Scale

      scale组件实例，通过.enable属性控制启用

      返回 Scale

    • get zoom(): Zoom

      zoom组件实例，通过.enable属性控制启用

      返回 Zoom

    显示设置

    成员可见性

    目录

    构造函数
    访问器