PolylineOptions

java.lang.Object
- com.amap.api.maps.model.BaseOptions
- - com.amap.api.maps.model.PolylineOptions

所有已实现的接口:: android.os.Parcelable

public final class PolylineOptions
extends BaseOptions
implements android.os.Parcelable

线段的选项类

从以下版本开始:: 2.0

嵌套类概要

嵌套类
限定符和类型类和说明

static class PolylineOptions.LineCapType
Polyline尾部形状

static class PolylineOptions.LineJoinType
Polyline连接处形状
- 从接口继承的嵌套类/接口 android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

嵌套类
限定符和类型	类和说明
`static class`	`PolylineOptions.LineCapType` Polyline尾部形状
`static class`	`PolylineOptions.LineJoinType` Polyline连接处形状

字段概要

字段
限定符和类型	字段和说明
`static PolylineOptionsCreator`	`CREATOR`
`static int`	`DOTTEDLINE_TYPE_CIRCLE` 虚线类型：圆形，值为1；
`static int`	`DOTTEDLINE_TYPE_SQUARE` 虚线类型：方形，值为0；

从接口继承的字段 android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

构造器概要

构造器
构造器和说明

PolylineOptions()
构造一个新的PolylineOptions对象。

构造器
构造器和说明
`PolylineOptions()` 构造一个新的PolylineOptions对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`PolylineOptions`	`add(LatLng... points)` 追加一批顶点到线段的坐标集合。
`PolylineOptions`	`add(LatLng point)` 追加一个顶点到线段的坐标集合。
`PolylineOptions`	`addAll(java.lang.Iterable<LatLng> points)` 追加一批顶点到线段的坐标集合。
`PolylineOptions`	`color(int color)` 设置线段的颜色，需要传入32位的ARGB格式。
`PolylineOptions`	`colorValues(java.util.List<java.lang.Integer> colors)` 设置线段的颜色
`PolylineOptions`	`geodesic(boolean isGeodesic)` 设置线段是否为大地曲线，默认false，不画大地曲线。
`int`	`getColor()` 获取线段的颜色ARGB格式。
`java.util.List<java.lang.Integer>`	`getColorValues()` 获取线段的颜色列表
`BitmapDescriptor`	`getCustomTexture()` 获取线段的纹理图。
`java.util.List<java.lang.Integer>`	`getCustomTextureIndex()` 获取线段纹理index列表
`java.util.List<BitmapDescriptor>`	`getCustomTextureList()` 获取线段纹理列表
`int`	`getDottedLineType()` 获取虚线形状。
`PolylineOptions.LineCapType`	`getLineCapType()` 返回Polyline尾部形状
`PolylineOptions.LineJoinType`	`getLineJoinType()` 返回Polyline连接处形状
`java.util.List<LatLng>`	`getPoints()` 获取线段的点坐标列表。
`float`	`getTransparency()` 获取线的透明度
`float`	`getWidth()` 获取线段的宽度。
`float`	`getZIndex()` 获取线段的Z轴值
`boolean`	`isDottedLine()` 获取线段是否画虚线，默认为false，画实线。
`boolean`	`isGeodesic()` 获取线段是否为大地曲线，默认false，不画大地曲线。
`boolean`	`isUseGradient()` 获取线段是否使用渐变色
`boolean`	`isUseTexture()` 获取线段是否使用纹理贴图。
`boolean`	`isVisible()` 获取线段的可见属性
`PolylineOptions`	`lineCapType(PolylineOptions.LineCapType lineCapType)` 设置Polyline尾部形状
`PolylineOptions`	`lineJoinType(PolylineOptions.LineJoinType lineJoinType)` 设置Polyline连接处形状
`PolylineOptions`	`setCustomTexture(BitmapDescriptor customTexture)` 设置线段的纹理图，图片为2的n次方。
`PolylineOptions`	`setCustomTextureIndex(java.util.List<java.lang.Integer> custemTextureIndexs)` 设置线段纹理index数组
`PolylineOptions`	`setCustomTextureList(java.util.List<BitmapDescriptor> customTextureList)` 设置线段纹理list
`PolylineOptions`	`setDottedLine(boolean isDottedLine)` 设置是否画虚线，默认为false，画实线。
`PolylineOptions`	`setDottedLineType(int type)` 设置虚线形状。
`PolylineOptions`	`setEraseColor(boolean eraseVisible, int eraseColor)` 设置线段擦除（显示范围外）颜色，需要传入32位的ARGB格式，针对颜色线段生效。
`void`	`setPoints(java.util.List<LatLng> points)` 设置线段的点坐标集合,如果以前已经存在点,则会清空以前的点。
`PolylineOptions`	`setUseTexture(boolean useTexture)` 设置是否使用纹理贴图画线。
`PolylineOptions`	`transparency(float transparency)` 设置线段的透明度0~1，默认是1,1表示不透明
`PolylineOptions`	`useGradient(boolean useGradient)` 设置线段是否使用渐变色
`PolylineOptions`	`visible(boolean isVisible)` 设置线段的可见性。
`PolylineOptions`	`width(float width)` 设置线段的宽度，默认为10。
`PolylineOptions`	`zIndex(float zIndex)` 设置线段Z轴的值。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 android.os.Parcelable
describeContents, writeToParcel

- 字段详细资料
  - CREATOR
```
public static final PolylineOptionsCreator CREATOR
```
  - DOTTEDLINE_TYPE_SQUARE
```
public static final int DOTTEDLINE_TYPE_SQUARE
```
    虚线类型：方形，值为0；
    
    从以下版本开始:
    
    5.5.0
    
    另请参阅:
    
    常量字段值
  - DOTTEDLINE_TYPE_CIRCLE
```
public static final int DOTTEDLINE_TYPE_CIRCLE
```
    虚线类型：圆形，值为1；
    
    从以下版本开始:
    
    5.5.0
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - PolylineOptions
```
public PolylineOptions()
```
    构造一个新的PolylineOptions对象。
    
    从以下版本开始:
    
    2.0
- 方法详细资料
  - setUseTexture
```
public PolylineOptions setUseTexture(boolean useTexture)
```
    设置是否使用纹理贴图画线。
    
    参数:
    
    useTexture - true，使用纹理贴图；false，不使用。默认为使用纹理贴图画线。
    
    返回:
    
    返回PolylineOptions对象。
    
    从以下版本开始:
    
    2.0
  - setCustomTexture
```
public PolylineOptions setCustomTexture(BitmapDescriptor customTexture)
```
    设置线段的纹理图，图片为2的n次方。如果不是，会自动放大至2的n次方。图片最好不大于128*128。
    
    参数:
    
    customTexture - 用户设置线段的纹理。
    
    返回:
    
    PolylineOptions 对象。
    
    从以下版本开始:
    
    2.2.0
  - getCustomTexture
```
public BitmapDescriptor getCustomTexture()
```
    获取线段的纹理图。
    
    返回:
    
    线段的纹理图。
    
    从以下版本开始:
    
    2.2.0
  - setCustomTextureList
```
public PolylineOptions setCustomTextureList(java.util.List<BitmapDescriptor> customTextureList)
```
    设置线段纹理list
    
    参数:
    
    customTextureList - 纹理列表
    
    返回:
    
    PolylineOptions 对象。
    
    从以下版本开始:
    
    3.2.0
  - getCustomTextureList
```
public java.util.List<BitmapDescriptor> getCustomTextureList()
```
    获取线段纹理列表
    
    返回:
    
    纹理列表。
    
    从以下版本开始:
    
    3.2.0
  - setCustomTextureIndex
```
public PolylineOptions setCustomTextureIndex(java.util.List<java.lang.Integer> custemTextureIndexs)
```
    设置线段纹理index数组
    
    参数:
    
    custemTextureIndexs - 每一段对应的纹理，用纹理列表的index来对应
    
    返回:
    
    PolylineOptions 对象。
    
    从以下版本开始:
    
    3.2.0
  - getCustomTextureIndex
```
public java.util.List<java.lang.Integer> getCustomTextureIndex()
```
    获取线段纹理index列表
    
    返回:
    
    分段纹理index列表
    
    从以下版本开始:
    
    3.2.0
  - colorValues
```
public PolylineOptions colorValues(java.util.List<java.lang.Integer> colors)
```
    设置线段的颜色
    
    参数:
    
    colors - 颜色列表
    
    返回:
    
    PolylineOptions 对象。
    
    从以下版本开始:
    
    3.2.0
  - getColorValues
```
public java.util.List<java.lang.Integer> getColorValues()
```
    获取线段的颜色列表
    
    返回:
    
    颜色列表。
    
    从以下版本开始:
    
    3.2.0
  - useGradient
```
public PolylineOptions useGradient(boolean useGradient)
```
    设置线段是否使用渐变色
    
    参数:
    
    useGradient - 是否使用渐变色，true：使用，false不使用，默认为false；
    
    返回:
    
    PolylineOptions 对象。
    
    从以下版本开始:
    
    3.2.0
  - isUseGradient
```
public boolean isUseGradient()
```
    获取线段是否使用渐变色
    
    返回:
    
    是否使用渐变色，true：使用，false不使用
    
    从以下版本开始:
    
    3.2.0
  - isUseTexture
```
public boolean isUseTexture()
```
    获取线段是否使用纹理贴图。
    
    返回:
    
    true：使用纹理贴图；false：未使用。
    
    从以下版本开始:
    
    2.2.0
  - isGeodesic
```
public boolean isGeodesic()
```
    获取线段是否为大地曲线，默认false，不画大地曲线。
    
    返回:
    
    true 为大地曲线；false 不为大地曲线。
    
    从以下版本开始:
    
    2.1.3
  - add
```
public PolylineOptions add(LatLng point)
```
    追加一个顶点到线段的坐标集合。
    
    参数:
    
    point - 要添加的顶点。
    
    返回:
    
    追加一个顶点到线段终点的PolylineOptions对象
    
    从以下版本开始:
    
    2.0
  - add
```
public PolylineOptions add(LatLng... points)
```
    追加一批顶点到线段的坐标集合。
    
    参数:
    
    points - 要添加的顶点集合。
    
    返回:
    
    追加一批顶点到线段终点的PolylineOptions对象。
    
    从以下版本开始:
    
    2.0
  - addAll
```
public PolylineOptions addAll(java.lang.Iterable<LatLng> points)
```
    追加一批顶点到线段的坐标集合。
    
    参数:
    
    points - 要添加的顶点集合。
    
    返回:
    
    追加一批顶点到线段终点的PolylineOptions对象
    
    从以下版本开始:
    
    2.0
  - width
```
public PolylineOptions width(float width)
```
    设置线段的宽度，默认为10。
    
    参数:
    
    width - 宽度单位：像素。
    
    返回:
    
    设置线段新宽度的PolylineOptions对象。
    
    从以下版本开始:
    
    2.0
  - color
```
public PolylineOptions color(int color)
```
    设置线段的颜色，需要传入32位的ARGB格式。默认为黑色( 0xff000000)。
    
    参数:
    
    color - 颜色。
    
    返回:
    
    设置线段颜色的PolylineOptions对象
    
    从以下版本开始:
    
    2.0
  - zIndex
```
public PolylineOptions zIndex(float zIndex)
```
    设置线段Z轴的值。
    
    参数:
    
    zIndex - 要设置的Z轴的值。
    
    返回:
    
    设置线段新Z轴值的PolylineOptions对象。
    
    从以下版本开始:
    
    2.0
  - visible
```
public PolylineOptions visible(boolean isVisible)
```
    设置线段的可见性。默认为可見
    
    参数:
    
    isVisible - 一个表示线段是否可见的布尔值，true表示可见，false表示不可见。
    
    返回:
    
    设置新可见属性的PolylineOptions对象
    
    从以下版本开始:
    
    2.0
  - geodesic
```
public PolylineOptions geodesic(boolean isGeodesic)
```
    设置线段是否为大地曲线，默认false，不画大地曲线。
    
    参数:
    
    isGeodesic - 一个表示线段是否为大地曲线的布尔值，true表示是大地曲线，false表示不是大地曲线。
    
    返回:
    
    设置线段是否为大地曲线的PolylineOptions对象。
    
    从以下版本开始:
    
    2.1.3
  - setDottedLine
```
public PolylineOptions setDottedLine(boolean isDottedLine)
```
    设置是否画虚线，默认为false，画实线。
    
    参数:
    
    isDottedLine - true，画虚线；false，画实线。
    
    返回:
    
    设置线段是否为虚线的PolylineOptions对象。
    
    从以下版本开始:
    
    2.1.4
  - isDottedLine
```
public boolean isDottedLine()
```
    获取线段是否画虚线，默认为false，画实线。
    
    返回:
    
    true，画虚线；false，画实线。
    
    从以下版本开始:
    
    2.1.4
  - setDottedLineType
```
public PolylineOptions setDottedLineType(int type)
```
    设置虚线形状。
    
    参数:
    
    type - 形状：
    PolylineOptions.DOTTEDLINE_TYPE_SQUARE:方形；
    PolylineOptions.DOTTEDLINE_TYPE_CIRCLE：圆形；
    
    返回:
    
    设置虚线形状的PolylineOptions对象。
    
    从以下版本开始:
    
    5.5.0
  - lineCapType
```
public PolylineOptions lineCapType(PolylineOptions.LineCapType lineCapType)
```
    设置Polyline尾部形状
    
    参数:
    
    lineCapType - 形状
    
    返回:
    
    从以下版本开始:
    
    6.3.0
  - lineJoinType
```
public PolylineOptions lineJoinType(PolylineOptions.LineJoinType lineJoinType)
```
    设置Polyline连接处形状
    
    参数:
    
    lineJoinType - 形状
    
    返回:
    
    从以下版本开始:
    
    6.3.0
  - getLineCapType
```
public PolylineOptions.LineCapType getLineCapType()
```
    返回Polyline尾部形状
    
    返回:
    
    形状
    
    从以下版本开始:
    
    6.3.0
  - getLineJoinType
```
public PolylineOptions.LineJoinType getLineJoinType()
```
    返回Polyline连接处形状
    
    返回:
    
    形状
    
    从以下版本开始:
    
    6.3.0
  - getDottedLineType
```
public int getDottedLineType()
```
    获取虚线形状。
    
    返回:
    
    形状： DOTTEDLINE_TYPE_SQUARE：方形，值为0；
    DOTTEDLINE_TYPE_CIRCLE：圆形，值为1；
    。
    
    从以下版本开始:
    
    5.5.0
  - getPoints
```
public java.util.List<LatLng> getPoints()
```
    获取线段的点坐标列表。
    
    返回:
    
    线段的顶点坐标列表。
    
    从以下版本开始:
    
    2.0
  - getWidth
```
public float getWidth()
```
    获取线段的宽度。
    
    返回:
    
    宽度
    
    从以下版本开始:
    
    2.0
  - getColor
```
public int getColor()
```
    获取线段的颜色ARGB格式。
    
    返回:
    
    线段的颜色ARGB格式。
    
    从以下版本开始:
    
    2.0
  - getZIndex
```
public float getZIndex()
```
    获取线段的Z轴值
    
    返回:
    
    Z轴值
    
    从以下版本开始:
    
    2.0
  - isVisible
```
public boolean isVisible()
```
    获取线段的可见属性
    
    返回:
    
    true：为可见; false：不可见。
    
    从以下版本开始:
    
    2.0
  - transparency
```
public PolylineOptions transparency(float transparency)
```
    设置线段的透明度0~1，默认是1,1表示不透明
    
    参数:
    
    transparency - 透明度
    
    返回:
    
    设置线段带透明度的PolylineOptions对象。
    
    从以下版本开始:
    
    4.0.0
  - getTransparency
```
public float getTransparency()
```
    获取线的透明度
    
    返回:
    
    透明度0~1 默认是1不透明
    
    从以下版本开始:
    
    4.0.0
  - setPoints
```
public void setPoints(java.util.List<LatLng> points)
```
    设置线段的点坐标集合,如果以前已经存在点,则会清空以前的点。
    
    参数:
    
    points - 要设置的顶点集合
    
    从以下版本开始:
    
    4.0.0
  - setEraseColor
```
public PolylineOptions setEraseColor(boolean eraseVisible,
                                     int eraseColor)
```
    设置线段擦除（显示范围外）颜色，需要传入32位的ARGB格式，针对颜色线段生效。默认为黑色( 0xff000000)，此函数需要PolylineOptions.setShownRange(float rangeBegin, float rangeEnd)使用后生效
    
    参数:
    
    eraseVisible - 擦除线段（线段显示范围外）可见性，默认不可见。
    
    eraseColor - 擦除线段（线段显示范围外）颜色
    
    返回:
    
    设置线段范围外颜色的PolylineOptions对象
    
    从以下版本开始:
    
    7.5.0

类 PolylineOptions

嵌套类概要

从接口继承的嵌套类/接口 android.os.Parcelable

字段概要

从接口继承的字段 android.os.Parcelable

构造器概要

方法概要

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

从接口继承的方法 android.os.Parcelable

字段详细资料

CREATOR

DOTTEDLINE_TYPE_SQUARE

DOTTEDLINE_TYPE_CIRCLE

构造器详细资料

PolylineOptions

方法详细资料

setUseTexture

setCustomTexture

getCustomTexture

setCustomTextureList

getCustomTextureList

setCustomTextureIndex

getCustomTextureIndex

colorValues

getColorValues

useGradient

isUseGradient

isUseTexture

isGeodesic

add

add

addAll

width

color

zIndex

visible

geodesic

setDottedLine

isDottedLine

setDottedLineType

lineCapType

lineJoinType

getLineCapType

getLineJoinType

getDottedLineType

getPoints

getWidth

getColor

getZIndex

isVisible

transparency

getTransparency

setPoints

setEraseColor