tianditu-types/src/layer/tileLayer.d.ts

- 天地图接口类型声明文件

declare namespace T {
  namespace TileLayer {
    class WMS extends TileLayerWMS {}
    class TDT extends TileLayerTDT {}
  }
  class TileLayer {
    // static WMS: typeof TileLayerWMS;
    // static TDT: typeof TileLayerTDT;

    /** 以指定的参数创建TileLayer对象,这个对象是在地图上叠加栅格地图的时候用到的 */
    constructor(url: string, opts?: TileLayerOptions);
    /** 改变图层的透明度 */
    setOpacity(opacity: number): TileLayer;
    /** 设置图层的叠放顺序 */
    setZIndex(zIndex: number): TileLayer;
    /** 重新加载所有添加到此 TileLayer 的可见瓦片 */
    refresh(): TileLayer;
    /** 更新图层的URL地址并重绘他们 */
    setUrl(url: string): TileLayer;
    /** 瓦片的标签容器 */
    getContainer(): HTMLElement;
    /** 添加事件监听函数 */
    addEventListener<E extends keyof TileLayerEvents>(event: E, handler: TileLayerEvents[E]): void;
    /** 移除事件监听函数 */
    removeEventListener<E extends keyof TileLayerEvents>(event: E, handler: TileLayerEvents[E]): void;
  }

  interface TileLayerOptions {
    /** 此图层的最低缩放级别。default:0 */
    minZoom?: number;
    /** 此图层的最高缩放级别 。default:18*/
    maxZoom?: number;
    /** 当没有瓦片时所显示的错误图片地址 */
    errorTileUrl?: string;
    /** 设置图层的透明度（0.0-1.0）。default:1.0 */
    opacity?: number;
    /** 图层的显示顺序 */
    zIndex?: number;
    /** 设置指定范围内显示瓦片 */
    bounds?: LngLatBounds;
  }

  interface TileLayerEvents {
    /** 当瓦片图层开始加载瓦片时触发 */
    loading(e: Pick<TileLayerEvent, "type" | "target">): void;
    /** 当瓦片图层加载完可见瓦片后触发 */
    load(e: Pick<TileLayerEvent, "type" | "target">): void;
    /** 瓦片请求和开始加载时触发 */
    tileloadstart(e: TileLayerEvent): void;
    /** 在加载瓦片时触发 */
    tileload(e: TileLayerEvent): void;
    /** 在瓦片被移除时触发（比如打开了unloadInvisibleTiles） */
    tileunload(e: TileLayerEvent): void;
    /** 瓦片错误时触发 */
    tileerror(e: TileLayerEvent): void;
  }

  interface TileLayerEvent {
    /** 事件类型 */
    type: string;
    /** 图层对象 */
    target: TileLayer;
    /** 像素坐标对象 */
    coords: Point;
    /** 瓦片图片 */
    tile: HTMLImageElement;
  }
}