Class Service

Service 服务类.

Constructors

  • 构造函数

    Parameters

    • url: string

      服务地址

    • Optional token: string

      访问凭证

    • Optional req: IRequest

      请求的方法实现(默认内部实现)

    Returns Service

Properties

accessToken: string = ""

访问凭证

serverUrl: string = ""

服务器地址

Methods

  • 增加访问key

    Parameters

    • key: string

      key值

    Returns Set<string>

  • 增加秘钥key

    Parameters

    • key: string

      key值

    Returns Set<string>

  • 服务根地址

    Returns string

  • 空白瓦片地址

    Returns string

  • 检查文件是否上传过

    Parameters

    • filemd5: string

      文件md5值

    Returns Promise<any>

  • 清空服务器缓存数据

    Parameters

    • prefix: string = ""

      key前缀

    Returns Promise<unknown>

  • 克隆一个新的服务实例对象

    Parameters

    • Optional isCloneWorkspace: boolean

      是否克隆当前工作区 (默认是)

    Returns Service

    Service

  • 清空地图的几何和瓦片缓存数据

    Parameters

    • mapid: string

      地图ID

    • version: string

      版本号

    Returns Promise<any>

  • 清空地图的瓦片缓存数据

    Parameters

    • mapid: string

      地图ID

    • version: string

      版本号

    Returns Promise<any>

  • 获取创建实体的几何数据

    Parameters

    • param: ICreateEntitiesGeomData

      参数

    • Optional cb: ((point) => [number, number])

      结果中每个点的处理回调。如果返回空的话,则用默认处理方法

        • (point): [number, number]
        • Parameters

          • point: [number, number]

          Returns [number, number]

    Returns Promise<any>

  • 删除地图缓存

    Parameters

    Returns Promise<any>

  • 删除地图

    Parameters

    • mapid: string

      地图ID

    • version: string

      版本号,如删除所有版本,输入"*"号

    • Optional retainVersionMaxCount: number

      删除所有版本时,保留的最新的版本总数。如总共有10个版本,retainVersionMaxCount为3时,会保存最新的3个版本,其余的都会删除

    Returns Promise<any>

  • 删除地图样式

    Parameters

    Returns Promise<any>

  • 导出布局空间为dwg图

    Parameters

    Returns Promise<any>

  • 获取地图的AccessKey,获取之前请确保已成功打开了地图

    Parameters

    • mapid: string

      地图ID

    • key: string

      secretKey秘钥和超级管理员superKey

    Returns Promise<any>

  • 获取图形中有数据的范围区域

    Parameters

    • Optional mapid: string

      地图id

    • Optional version: string

      版本号

    Returns Promise<GeoBounds>

  • 获取支持的格式类型

    Returns Promise<any>

  • 比较地图不同

    Parameters

    Returns Promise<any>

  • 目标匹配

    Parameters

    Returns Promise<any>

  • 投影prj文件WKT字符转proj4字符串

    Parameters

    • wkt: string
    • Optional from: "" | "url" | "wmsauto" | "xml" | "urn" | "crsurl" | "micoordsys" | "pci"

      字符串来源,为空为话为WKT

    Returns Promise<any>

  • 地图ID重命名

    Parameters

    • oldMapID: string

      旧地图ID

    • newMapID: string

      新地图ID

    Returns Promise<any>

  • 重置地图的AccessKey,获取之前请确保已成功打开了地图

    Parameters

    • mapid: string

      地图ID

    • key: string

      secretKey秘钥和超级管理员superKey

    Returns Promise<any>

  • 获取当前运行状态

    Parameters

    • Optional bDetail: boolean

      是否需要细节 (默认false)

    Returns Promise<any>

  • 重置地图的密码,如果之前有密码,则是修改密码。如果之前没有密码,则是把此地图设置了密码保护。如果设置密码为空,则取消对此地图的密码保护。

    Parameters

    • mapid: string

      地图ID

    • key: string

      旧的secretKey秘钥和超级管理员superKey

    • newKey: string

      新的secretKey秘钥

    Returns Promise<any>

  • 对图层进行切片缓存

    Parameters

    Returns Promise<any>

  • 切换图层

    Parameters

    • visibleLayers: string[]

      让可见的图层列表数组

    Returns Promise<any>

  • 坐标转换

    Parameters

    • srs: string

      源坐标系名称,如 EPSG:4326

    • crs: string

      目标坐标系名称,如 EPSG:3857

    • points: GeoPoint | GeoPoint[]

      要转换的坐标

    • Optional fourParameter: string | string[]

      四参数(x偏移,y偏移,缩放,旋转弧度),可选,对坐标最后进行修正

    • Optional isInverseFourParamter: boolean

      是否是上面四参数坐标的反算

    Returns Promise<any>

  • 更新样式

    Parameters

    Returns Promise<any>

    Example:

    const res = svc.cmdUpdateStyle({
    name: "style1",
    layeron: [0,1,2,4,5,6,7,8,9],
    layeroff: "",
    clipbounds: "",
    backcolor: 0,
    lineweight:[1,1,0]
    expression: "gOutColorRed := gInColorGreen;gOutColorGreen := gInColorBlue;gOutColorBlue := gInColorRed;gOutColorAlpha := gInColorAlpha;"
    });
  • 条件查询实体

    Parameters

    • param: IConditionQueryFeatures

      参数

    • Optional cb: ((point) => [number, number])

      结果中每个点的处理回调。如果返回空的话,则用默认处理方法

        • (point): [number, number]
        • Parameters

          • point: [number, number]

          Returns [number, number]

    Returns Promise<any>

  • 获取样式图层名

    Parameters

    • style: IMapStyleParam

      样式参数

    • Optional mapid: string

      地图ID

    • Optional version: string

      版本号,为空,则获取最新的;

    • Optional isGeomLayer: boolean

      几何渲染图层优先(默认true)

    Returns Promise<any>

  • 删除用户自定义数据

    Parameters

    • key: string | string[]

      键名,如果是数组的话,可以查询

    • Optional isPrefix: boolean

      是否删除所有前缀为key的所有键值,默认false

    Returns Promise<any>

  • 执行命令

    Parameters

    • cmdname: string
    • Optional param: Record<string, any>
    • Optional mapid: string
    • Optional version: string
    • Optional useGet: boolean

    Returns Promise<any>

  • 表达式查询实体

    Parameters

    • param: IExprQueryFeatures

      参数

    • Optional cb: ((point) => [number, number])

      结果中每个点的处理回调。如果返回空的话,则用默认处理方法

        • (point): [number, number]
        • Parameters

          • point: [number, number]

          Returns [number, number]

    Returns Promise<any>

  • 获取文件的Md5值

    Parameters

    • file: File

    Returns Promise<any>

  • 获取服务后台常量设置

    Returns Promise<any>

  • 获取当前的工作区名称

    Returns string

  • 获取用户自定义数据

    Parameters

    • key: string | string[]

      键名,如果是数组的话,可以查询.

    • Optional options: {
          contentType?: "" | "image";
          retDataType?: "" | "value" | "prop";
      }

      选项 retDataType为空时查询数据及属性,"value"只查询数据,"prop"只查询属性。contentType返回类型,为空时为json,为"image"时为图片.

      • Optional contentType?: "" | "image"
      • Optional retDataType?: "" | "value" | "prop"

    Returns Promise<any>

  • 通过前缀获取用户自定义数据的键值

    Parameters

    • prefix: string

      键名前缀

    Returns Promise<any>

  • 得到所有矢量字体名称

    Returns Promise<unknown>

  • 得到地图图层集合,调用前请确保地图已打开,否则会抛异常

    Returns IMapLayer[]

  • 获取已缓存的切片级别

    Parameters

    Returns Promise<any>

  • 获取样式图层名

    Parameters

    • mapid: string

      地图ID

    • Optional version: string

      版本号,为空,则获取最新的;

    • Optional isGeomLayer: boolean

      几何渲染图层优先(默认true)

    • Optional name: string

      有名称时,根据名称来查找;

    Returns Promise<any>

  • 获取所有工作区(如果不是root权限的token获取非公开的工作区名称将返回空)

    Returns Promise<any>

  • 字体地址

    Returns string

  • 获取所有地图信息

    Parameters

    • mapid: string | string[] | {
          curPage: number;
          mapIds?: string[];
          pageCount: number;
      } = "_"

      地图ID,为空,则获取所有的;如果传入的是地图ID数组,则获取指定的地图ID数组的信息。如果不想一次性获取,可通过传入分页对象获取,如{curPage: 1, pageCount: 10}

    • version: string = "_"

      版本号,为空,则获取最新的; * 则获取所有的版本

    Returns Promise<any>

  • 获取地图元数据

    Parameters

    • Optional mapid: string

      地图ID ,为空, 则为当前打开的图形

    • Optional version: string

      版本号,为空 则为当前打开的版本;

    Returns Promise<any>

  • 打开图

    Parameters

    • param: IOpenMapParam
    • isWaitFinish: boolean = true

      是否等待打开完成

    Returns Promise<any>

  • 点查询实体

    Parameters

    • param: IPointQueryFeatures

      参数

    • Optional cb: ((point) => [number, number])

      结果中每个点的处理回调。如果返回空的话,则用默认处理方法

        • (point): [number, number]
        • Parameters

          • point: [number, number]

          Returns [number, number]

    Returns Promise<any>

  • 处理查询结果

    Parameters

    • param: any

      参数

    • Optional cb: ((point) => [number, number])

      结果中每个点的处理回调。如果返回空的话,则用默认处理方法

        • (point): [number, number]
        • Parameters

          • point: [number, number]

          Returns [number, number]

    Returns any

  • 密码转换为秘钥

    Parameters

    • pwd: string

      密码

    Returns string

  • 二维码图片地址

    Parameters

    • content: string

      生成二维码的内容

    • Optional size: number

      生成二维码的大小,默认256

    Returns string

  • 空白栅格style

    Parameters

    • Optional minzoom: number

      最小级别,缺省0

    • Optional maxzoom: number

      最大级别,缺省24

    • Optional prefix: string

      前缀,缺省rasterBlank

    Returns {
        glyphs: string;
        layers: {
            id: string;
            layout: {
                visibility: string;
            };
            maxzoom: number;
            minzoom: number;
            source: string;
            type: string;
        }[];
        sources: {};
        version: number;
    }

    • glyphs: string
    • layers: {
          id: string;
          layout: {
              visibility: string;
          };
          maxzoom: number;
          minzoom: number;
          source: string;
          type: string;
      }[]
    • sources: {}
      • version: number
    • 获取栅格图层ID

      Parameters

      • Optional prefix: string

      Returns string

    • 获取栅格源ID

      Parameters

      • Optional prefix: string

      Returns string

    • 栅格style

      Parameters

      • Optional tileUrl: string

        栅格瓦片地址

      • Optional minzoom: number

        最小级别,缺省0

      • Optional maxzoom: number

        最大级别,缺省24

      • Optional prefix: string

        前缀,缺省raster

      Returns {
          glyphs: string;
          layers: {
              id: string;
              layout: {
                  visibility: string;
              };
              maxzoom: number;
              minzoom: number;
              source: string;
              type: string;
          }[];
          sources: {};
          version: number;
      }

      • glyphs: string
      • layers: {
            id: string;
            layout: {
                visibility: string;
            };
            maxzoom: number;
            minzoom: number;
            source: string;
            type: string;
        }[]
      • sources: {}
        • version: number
      • 栅格瓦片地址

        Parameters

        Returns string

      • 矩形查询实体

        Parameters

        • param: IRectQueryFeatures

          参数

        • Optional cb: ((point) => [number, number])

          结果中每个点的处理回调。如果返回空的话,则用默认处理方法

            • (point): [number, number]
            • Parameters

              • point: [number, number]

              Returns [number, number]

        Returns Promise<any>

      • 移除访问key, 如果key为undefined时,则移除所有的

        Parameters

        • key: string

          key值

        Returns void

      • 移除秘钥key, 如果key为undefined时,则移除所有的

        Parameters

        • key: string

          key值

        Returns Set<string>

      • 保存用户自定义数据

        Parameters

        • key: string | {
              key: string;
              prop?: any;
              ttl?: number;
              value: any;
          }[]

          键名(必须唯一,否则会覆盖之前的数据,同类型的key前缀尽量一样),如果是数组的话,可以批量

        • Optional value: any

          键值

        • Optional prop: any

          属性值

        • Optional ttl: number

          有效时间,单位秒,默认长期有效

        Returns Promise<any>

      • 得到服务地址

        Parameters

        • u: string

          要拼接的地址

        Returns string

        string

      • 设置精灵图片名称

        Parameters

        • name: string

          精灵名称

        Returns string

      • 精灵图片名称

        Parameters

        • name: string

          精灵名称

        Returns string

      • 获取字符串的Md5值

        Parameters

        • str: string

        Returns string

      • 得到style的版本号

        Returns number

      • 切换至工作区

        Parameters

        • workspaceName: string

          工作区名称

        Returns void

      • 获取图的缩略图

        Parameters

        • Optional mapid: string
        • Optional version: string
        • Optional width: number
        • Optional height: number
        • Optional darkTheme: boolean

          是否是深色主题,是的话,图片将反色(黑色变白色)

        Returns string

      • 转成文档字符串

        Parameters

        • content: string | Record<string, any>

          如果传入了内容,则以content为主。json格式

        Returns string

      • 把图层名称数组转成图层索引数组

        Parameters

        • layernames: string[]

          图层名称数组

        • layers: any[]

          图层列表

        Returns number[]

      • 更新地图

        Parameters

        • param: IUpdateMapParam
        • isWaitFinish: boolean = true

          是否等待打开完成

        Returns Promise<any>

      • 修改地图元数据

        Parameters

        • meta: Record<string, string | number | boolean>

          要修改的元数据项

        • Optional mapid: string

          地图ID ,为空, 则为当前打开的图形

        • Optional version: string

          版本号,为空 则为当前打开的版本;

        Returns Promise<any>

      • 上传地图

        Parameters

        • file: File

        Returns Promise<any>

      • 返回上传文件的url地址

        Returns string

      • 矢量style

        Parameters

        • Optional tileUrl: string | Record<string, any>

          矢量瓦片地址 或者为一个Object,为Object时,设置项为参数的每个项值,做为一个参数传入

        • Optional minzoom: number

          最小级别,缺省0

        • Optional maxzoom: number

          最大级别,缺省24

        • Optional prefix: string

          前缀,缺省vector

        • Optional hoverColor: string

          高亮时颜色,缺省rgba(0,0,255,255)

        • Optional hoverOpacity: number

          高亮时透明度,缺省0.5

        • Optional hoverLineWidth: number

          高亮时线宽,缺省3

        • Optional customColorCaseExpr: any[]

          自定义颜色表达式,必须为数组[条件1,值,条件2,值,...],如[['==', ['feature-state', 'status'], 'alarm'], '#ff0000', ['==', ['feature-state', 'status'], 'normal'], '#00ff00'],缺省默认

        • Optional customOpacityCaseExpr: any[]

          自定义透明度表达式,必须为数组,缺省默认

        • Optional customLineWidthCaseExpr: any[]

          自定义线宽表达式,必须为数组,缺省默认

        • Optional disableHover: boolean

          禁止hover

        Returns {
            glyphs: string;
            layers: ({
                id: string;
                layout?: undefined;
                paint: {
                    circle-color?: undefined;
                    circle-opacity?: undefined;
                    circle-radius?: undefined;
                    circle-stroke-color?: undefined;
                    fill-antialias?: undefined;
                    fill-color?: undefined;
                    fill-opacity?: undefined;
                    fill-outline-color?: undefined;
                    line-blur?: undefined;
                    line-color: any[];
                    line-opacity: any[];
                    line-width: (string | number | boolean | (string | boolean | string[])[])[];
                };
                source: string;
                source-layer: string;
                type: string;
            } | {
                id: string;
                layout: {
                    line-cap?: undefined;
                };
                paint: {
                    circle-color?: undefined;
                    circle-opacity?: undefined;
                    circle-radius?: undefined;
                    circle-stroke-color?: undefined;
                    fill-antialias: boolean;
                    fill-color: any[];
                    fill-opacity: any[];
                    fill-outline-color: any[];
                    line-blur?: undefined;
                    line-color?: undefined;
                    line-opacity?: undefined;
                    line-width?: undefined;
                };
                source: string;
                source-layer: string;
                type: string;
            } | {
                id: string;
                layout: {
                    line-cap: string;
                };
                paint: {
                    circle-color?: undefined;
                    circle-opacity?: undefined;
                    circle-radius?: undefined;
                    circle-stroke-color?: undefined;
                    fill-antialias?: undefined;
                    fill-color?: undefined;
                    fill-opacity?: undefined;
                    fill-outline-color?: undefined;
                    line-blur: (string | number | boolean | (string | boolean | string[])[])[];
                    line-color: any[];
                    line-opacity: any[];
                    line-width: any[];
                };
                source: string;
                source-layer: string;
                type: string;
            } | {
                id: string;
                layout?: undefined;
                paint: {
                    circle-color: any[];
                    circle-opacity: any[];
                    circle-radius: any[];
                    circle-stroke-color: any[];
                    fill-antialias?: undefined;
                    fill-color?: undefined;
                    fill-opacity?: undefined;
                    fill-outline-color?: undefined;
                    line-blur?: undefined;
                    line-color?: undefined;
                    line-opacity?: undefined;
                    line-width?: undefined;
                };
                source: string;
                source-layer: string;
                type: string;
            })[];
            sources: {};
            version: number;
        }

        • glyphs: string
        • layers: ({
              id: string;
              layout?: undefined;
              paint: {
                  circle-color?: undefined;
                  circle-opacity?: undefined;
                  circle-radius?: undefined;
                  circle-stroke-color?: undefined;
                  fill-antialias?: undefined;
                  fill-color?: undefined;
                  fill-opacity?: undefined;
                  fill-outline-color?: undefined;
                  line-blur?: undefined;
                  line-color: any[];
                  line-opacity: any[];
                  line-width: (string | number | boolean | (string | boolean | string[])[])[];
              };
              source: string;
              source-layer: string;
              type: string;
          } | {
              id: string;
              layout: {
                  line-cap?: undefined;
              };
              paint: {
                  circle-color?: undefined;
                  circle-opacity?: undefined;
                  circle-radius?: undefined;
                  circle-stroke-color?: undefined;
                  fill-antialias: boolean;
                  fill-color: any[];
                  fill-opacity: any[];
                  fill-outline-color: any[];
                  line-blur?: undefined;
                  line-color?: undefined;
                  line-opacity?: undefined;
                  line-width?: undefined;
              };
              source: string;
              source-layer: string;
              type: string;
          } | {
              id: string;
              layout: {
                  line-cap: string;
              };
              paint: {
                  circle-color?: undefined;
                  circle-opacity?: undefined;
                  circle-radius?: undefined;
                  circle-stroke-color?: undefined;
                  fill-antialias?: undefined;
                  fill-color?: undefined;
                  fill-opacity?: undefined;
                  fill-outline-color?: undefined;
                  line-blur: (string | number | boolean | (string | boolean | string[])[])[];
                  line-color: any[];
                  line-opacity: any[];
                  line-width: any[];
              };
              source: string;
              source-layer: string;
              type: string;
          } | {
              id: string;
              layout?: undefined;
              paint: {
                  circle-color: any[];
                  circle-opacity: any[];
                  circle-radius: any[];
                  circle-stroke-color: any[];
                  fill-antialias?: undefined;
                  fill-color?: undefined;
                  fill-opacity?: undefined;
                  fill-outline-color?: undefined;
                  line-blur?: undefined;
                  line-color?: undefined;
                  line-opacity?: undefined;
                  line-width?: undefined;
              };
              source: string;
              source-layer: string;
              type: string;
          })[]
        • sources: {}
          • version: number
        • 矢量瓦片地址

          Parameters

          Returns string

        • 等待地图打开完成

          Parameters

          • mapid: string

            地图ID

          • version: string

            地图版本号

          • tryTime: number = 5

            每次尝试时间间隔(秒)

          • maxTryTimes: number = 120

            最大尝试次数

          Returns Promise<any>

        • 获取服务器地图服务地址

          Parameters

          • tileProvider: {
                fourParameterAfter?: string;
                fourParameterBefore?: string;
                mapbounds?: string;
                srs?: string;
                tileCrs?: "gcj02" | "wgs84";
                tileFlipY?: boolean;
                tileMaxZoom?: number;
                tileRetina?: number;
                tileShards?: string;
                tileSize?: number;
                tileToken?: string | string[];
                tileUrl: string | string[];
            }
            • Optional fourParameterAfter?: string
            • Optional fourParameterBefore?: string
            • Optional mapbounds?: string
            • Optional srs?: string
            • Optional tileCrs?: "gcj02" | "wgs84"
            • Optional tileFlipY?: boolean
            • Optional tileMaxZoom?: number
            • Optional tileRetina?: number
            • Optional tileShards?: string
            • Optional tileSize?: number
            • Optional tileToken?: string | string[]
            • tileUrl: string | string[]

          Returns string

        • Parameters

          Returns string

        • 创建工作区(默认需要root权限)

          Parameters

          Returns Promise<any>

        • 删除工作区(会同时删除工作区下面的所有目录文件)(默认需要root权限)

          Parameters

          • name: string

            要删除的工作区名称

          Returns Promise<any>

        • 修改工作区(默认需要root权限)

          Parameters

          Returns Promise<any>