com.amap.api.maps2d.model

## 类 TileOverlayOptions

- java.lang.Object
- - com.amap.api.maps2d.model.TileOverlayOptions

-     public final class TileOverlayOptions
      extends java.lang.Object

  TileOverlay的初始化选项配置类。
  从以下版本开始:
    V2.2.0

- - ### 构造器概要

    构造器
    构造器和说明
    `TileOverlayOptions()` 构造一个TileOverlayOptions对象。

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `int` | `describeContents()`
    `TileOverlayOptions` | `diskCacheDir(java.lang.String path)` 设置栅格图层的磁盘缓存目录。
    `TileOverlayOptions` | `diskCacheEnabled(boolean enabled)` 设置是否开启磁盘缓存。
    `TileOverlayOptions` | `diskCacheSize(int kiloBytes)` 设置栅格图层的默认磁盘缓存大小，默认值20MB。
    `java.lang.String` | `getDiskCacheDir()` 返回栅格图层的磁盘缓存目录。
    `boolean` | `getDiskCacheEnabled()` 获取栅格图层磁盘缓存的开启状态。
    `int` | `getDiskCacheSize()` 返回栅格图层的磁盘缓存大小。
    `int` | `getMemCacheSize()` 返回用于栅格图层的内存缓存大小。
    `boolean` | `getMemoryCacheEnabled()` 获取栅格图层的内存缓存开启状态。
    `TileProvider` | `getTileProvider()` 返回栅格图层的提供者。
    `float` | `getZIndex()` 返回Z轴数值。
    `boolean` | `isVisible()` 返回栅格图层是否可见。
    `TileOverlayOptions` | `memCacheSize(int kiloBytes)` 设置用于瓦片图层的内存缓存大小，默认值5MB。
    `TileOverlayOptions` | `memoryCacheEnabled(boolean enabled)` 设置是否开启内存缓存。
    `TileOverlayOptions` | `tileProvider(TileProvider tileProvider)` 设置瓦片图层的提供者。
    `TileOverlayOptions` | `visible(boolean visible)` 设置瓦片图层的可见属性，默认为可见。
    `void` | `writeToParcel(Parcel out, int flags)`
    `TileOverlayOptions` | `zIndex(float zIndex)` 设置瓦片图层的Z轴值，默认为0。

    - ### 从类继承的方法 java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### TileOverlayOptions

          public TileOverlayOptions()

      构造一个TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

  - ### 方法详细资料

    - #### describeContents

          public int describeContents()

    - #### writeToParcel

          public void writeToParcel(Parcel out,
                                    int flags)

    - #### tileProvider

          public TileOverlayOptions tileProvider(TileProvider tileProvider)

      设置瓦片图层的提供者。
      参数:
        `tileProvider` - 瓦片图层的提供者。
      返回:
        一个设置完瓦片图提供者的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### zIndex

          public TileOverlayOptions zIndex(float zIndex)

      设置瓦片图层的Z轴值，默认为0。Z轴是控制不同瓦片图层重复区域的绘制顺序的值。Z轴较大的瓦片图层会在绘制在Z轴较小的瓦片图层上面。如果两个瓦片图层的Z轴数值相同，则覆盖情况将随机出现。
      参数:
        `zIndex` - Z轴数值。
      返回:
        一个设置了瓦片图层Z轴值的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### visible

          public TileOverlayOptions visible(boolean visible)

      设置瓦片图层的可见属性，默认为可见。
      参数:
        `visible` - true为可见；false为不可见。
      返回:
        一个设置了可见属性的TileOverlayOptions 对象。
      从以下版本开始:
        V2.2.0

    - #### memCacheSize

          public TileOverlayOptions memCacheSize(int kiloBytes)

      设置用于瓦片图层的内存缓存大小，默认值5MB。
      参数:
        `kiloBytes` - 缓存大小，单位KB。
      返回:
        一个设置了用于瓦片图层内存缓存大小的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### diskCacheSize

          public TileOverlayOptions diskCacheSize(int kiloBytes)

      设置栅格图层的默认磁盘缓存大小，默认值20MB。
      参数:
        `kiloBytes` - 缓存大小，单位KB。
      返回:
        一个设置了栅格图层默认磁盘缓存大小的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### diskCacheDir

          public TileOverlayOptions diskCacheDir(java.lang.String path)

      设置栅格图层的磁盘缓存目录。如果外部（SD卡）缓存可用则为外部缓存，否则为内部（手机空间）缓存。默认外部缓存目录为“/sdcard/Android/data/package_name/cache”；默认内部缓存目录为“/data/data/package_name/cache”。
      参数:
        `path` - 磁盘缓存目录的绝对路径。
      返回:
        一个设置了栅格图层的磁盘缓存目录的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### memoryCacheEnabled

          public TileOverlayOptions memoryCacheEnabled(boolean enabled)

      设置是否开启内存缓存。
      参数:
        `enabled` - true为开启内存缓存；false为关闭。
      返回:
        一个设置是否开启内存缓存的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### diskCacheEnabled

          public TileOverlayOptions diskCacheEnabled(boolean enabled)

      设置是否开启磁盘缓存。
      参数:
        `enabled` - true为开启磁盘缓存；false为关闭。
      返回:
        一个设置是否开启磁盘缓存的TileOverlayOptions对象。
      从以下版本开始:
        V2.2.0

    - #### getTileProvider

          public TileProvider getTileProvider()

      返回栅格图层的提供者。
      返回:
        栅格图层的提供者。
      从以下版本开始:
        V2.2.0

    - #### getZIndex

          public float getZIndex()

      返回Z轴数值。
      返回:
        Z轴数值。
      从以下版本开始:
        V2.2.0

    - #### isVisible

          public boolean isVisible()

      返回栅格图层是否可见。
      返回:
        true为可见；false为不可见。
      从以下版本开始:
        V2.2.0

    - #### getMemCacheSize

          public int getMemCacheSize()

      返回用于栅格图层的内存缓存大小。
      返回:
        用于栅格图层的内存缓存大小，单位KB
      从以下版本开始:
        V2.2.0

    - #### getDiskCacheSize

          public int getDiskCacheSize()

      返回栅格图层的磁盘缓存大小。
      返回:
        栅格图层的磁盘缓存大小，单位KB。
      从以下版本开始:
        V2.2.0

    - #### getDiskCacheDir

          public java.lang.String getDiskCacheDir()

      返回栅格图层的磁盘缓存目录。
      返回:
        栅格图层的磁盘缓存目录。
      从以下版本开始:
        V2.2.0

    - #### getMemoryCacheEnabled

          public boolean getMemoryCacheEnabled()

      获取栅格图层的内存缓存开启状态。
      返回:
        true为开启内存缓存；false为关闭。
      从以下版本开始:
        V2.2.0

    - #### getDiskCacheEnabled

          public boolean getDiskCacheEnabled()

      获取栅格图层磁盘缓存的开启状态。
      返回:
        true为开启磁盘缓存；false为关闭。
      从以下版本开始:
        V2.2.0