Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

PolylineOptions

extends Object

java.lang.Object
↳	com.tencent.tencentmap.mapsdk.maps.model.PolylineOptions

Class Overview

设置折线相关选项

Summary

Nested Classes
enum	PolylineOptions.ColorType	路线颜色类型
class	PolylineOptions.Colors	可用的颜色
class	PolylineOptions.LineType
enum	PolylineOptions.PolylineCollision
class	PolylineOptions.SegmentText	分段展示的文字对象
class	PolylineOptions.Text	polyline 上展示的文字对象
enum	PolylineOptions.TextPriority	文字优先级，目前只有两级，当两条带文字的 polyline 的交点处需要展示文字时，只展示高优先级的 polyline 上的文字。用户保证只有一条 polyline 上的文字是 `HIGH`, 否则不能保证得到的展示效果。

Public Constructors
	PolylineOptions()

Public Methods
PolylineOptions	aboveMaskLayer(boolean above) This method is deprecated. 请使用z轴层级来设置蒙层和路线的相对位置设置是否显示在蒙层之上
PolylineOptions	abovePillar(boolean isAbove) This method is deprecated. Polyline是否显示在楼块上方已经废弃，建议使用`level(int)`，精确设置显示层级关系
PolylineOptions	add(LatLng latlng, LatLng... args) 添加顶点
PolylineOptions	add(LatLng[] latLngs) 添加顶点
PolylineOptions	addAll(Iterable<LatLng> latLngs) 添加顶点
PolylineOptions	alpha(float a) 设置透明度
PolylineOptions	animation(Animation a) 执行一个动画
PolylineOptions	arrow(boolean flag) 导航用接口,开发都不要用
PolylineOptions	arrowSpacing(int arrowSpacing) 设置方向箭头的间距，单位（px),默认是100px
PolylineOptions	arrowTexture(BitmapDescriptor arrowTexture) 设置方向箭头的自定义纹理
PolylineOptions	borderColor(int borderColor) 设置线ARGB的描边颜色：当线是纯色线的时候，设置border的颜色可用此接口
PolylineOptions	borderColors(int[] borderColors) 设置ARGB线的描边颜色，borderColors的数量应该与 `colors(int[], int[])`接口中的colors的长度保持一致。
PolylineOptions	borderWidth(float borderWidth) 设置ARGB线描边的宽度
PolylineOptions	clickable(boolean clickable) 是否可以点击
PolylineOptions	collisionBy(PolylineCollision... collisions) 设置碰撞关系目前只对道路线有效
PolylineOptions	color(int i) 设置线的颜色
PolylineOptions	colorTexture(BitmapDescriptor bitmapDescriptor) 注意： 1、当调用此接口，且LineType不为LINE_TYPE_DOTTEDLINE时，color和colors接口指定的值代表用此接口设置纹理的第几像素行，以绘制纹理线 2、当调用此接口，且LineType设置为LINE_TYPE_DOTTEDLINE时，绘制线时会连续绘制此接口设置的纹理。 3、提供的纹理图片最大高度不能超过16px。
PolylineOptions	colorType(PolylineOptions.ColorType type) 设置颜色类型
PolylineOptions	colors(int[] colors, int[] indexes) 设置线的分段颜色
PolylineOptions	eraseColor(int eraseColor) 设置ARGB类型线的擦除色，默认为`GRAY`
float	getAlpha() 获取透明得
Animation	getAnimation() 获取设置的动画
int	getArrowSpacing() 获取箭头的间距，单位（px)，默认100px
BitmapDescriptor	getArrowTexture() 获取Polyline自定义箭头的纹理
int[]	getBorderColors() 获取ARGB线 border颜色数组如果是纯色线的`borderColor(int)`,则返回长度为1的颜色数组
float	getBorderWidth() 获取ARGB线描边宽度，(单位px)
PolylineCollision[]	getCollisions()
int	getColor() 返回PolylineOptions对象的32-bit ARGB颜色
BitmapDescriptor	getColorTexture() 获取纹理
PolylineOptions.ColorType	getColorType() 获取设置的颜色类型
int[][]	getColors() 返回PolylineOptions对象的分段颜色
int	getEraseColor() 获取ARGB类型线的擦除色，默认为`GRAY`
IndoorInfo	getIndoorInfo() 获取绑定的室内图信息
int	getLevel() 获取PolylineOptions的显示level
boolean	getLineCap() 获取路线是否显示半圆端点
int	getLineType() 获取线类型
List<Integer>	getPattern()
List<LatLng>	getPoints() 返回PolylineOptions对象的顶点坐标列表
PolylineOptions.Text	getText() 获取沿 polyline 展示的文字
String	getTextureName() 获取纹理图片名称已过时，使用 `getColorTexture()` 代替此方法
float	getWidth() 返回PolylineOptions对象的宽度，单位（px)
int	getZIndex() 返回PolylineOptions对象的堆叠顺序
static String	getsDefaultArrowTexture() 获取默认的方向箭头图片名称，后续不再提供这个方法
PolylineOptions	gradient(boolean enable) 渐变色开关只有 `getLineType()` == `LINE_TYPE_MULTICOLORLINE` 且 `isRoad()` == true 才生效
PolylineOptions	indoorInfo(IndoorInfo indoorInfo) 为Polyline添加室内图信息（buildingId，floorName）当添加室内图信息后，Marker将会随着绑定的室内图状态改变而展示和隐藏
boolean	isAboveMaskLayer() This method is deprecated. 请使用z轴层级来设置蒙层和路线的相对位置判断是否显示在蒙层之上
boolean	isAbovePillar() 如果不设置Polyline的zIndex时，是否显示在3D楼块上方，默认在显示在楼块下方
boolean	isArrow() 导航用接口,开发都不要用
boolean	isClickable() 是否可点击
boolean	isGradientEnable() 是否开启渐变色
boolean	isRoad() 判断线是否为路线
boolean	isVisible() 返回PolylineOptions对象的可见性
PolylineOptions	latLngs(List<LatLng> listLatlngs) 设置折线坐标
PolylineOptions	level(int level) 设置Polyline的显示Level，level用于控制Polyline与楼块，道路，POI的显示层级关系。默认为`OverlayLevelAboveRoads`道路之上楼块之下相同Level内的显示层级关系通过`zIndex(int)`来控制，zIndex越大越靠上显示。 Level优先级高于zIndex
PolylineOptions	lineCap(boolean cap) 设置路线是否显示半圆端点
PolylineOptions	lineType(int lineType) 设置线的类型，必须`LineType里面的一种`
PolylineOptions	pattern(List<Integer> pattern) 设置ARGB虚线的样式
PolylineOptions	road(boolean isRoad) 设置线是否为路线
PolylineOptions	setColorTexture(String strTextureName) 设置自定义纹理，自定义的纹理文件必须放在项目的asset目录下已过时，使用 `colorTexture(BitmapDescriptor)` 代替此方法注意： 1、当调用此接口，且LineType不为LINE_TYPE_DOTTEDLINE时，color和colors接口指定的值代表用此接口设置纹理的第几像素行，以绘制纹理线 2、当调用此接口，且LineType设置为LINE_TYPE_DOTTEDLINE时，绘制线时会连续绘制此接口设置的纹理。 3、提供的纹理图片最大高度不能超过16px。
void	setColors(int[] colors, int[] indexes)
static void	setDefaultArrowTexture(String textureName) 设置默认的方向箭头图片名称，后续不再提供这个方法
void	setLatLngs(List<LatLng> listLatlngs) 设置折线坐标
PolylineOptions	setLineType(int lineType) 设置线的类型，必须`LineType里面的一种` 已废弃，使用 `lineType(int)` 代替此方法
PolylineOptions	text(PolylineOptions.Text text) 设置沿 polyline 展示的文字只要调用 `addPolyline(PolylineOptions)` 构造出 `PolylineOptions.Text` 就不可以再调用 `setPoints(List)` 修改展示的路径，只能创建新的 `Polyline`
PolylineOptions	updatePoints(Iterable<LatLng> latLngs) 添加顶点,该方法会清空原来顶点集合
PolylineOptions	visible(boolean visible) 设置折线可见性
PolylineOptions	width(float width) 设置线宽度
void	writeToParcel(Parcel out, int flags) 序列化
PolylineOptions	zIndex(int zIndex) 设置相同显示Level `level(int)` 的折线堆叠顺序，相同显示level，zIndex越大越靠上显示 level优先级大于zIndex

[Expand]

Inherited Methods

From class java.lang.Object

Public Constructors

public PolylineOptions ()

Public Methods

public PolylineOptions aboveMaskLayer (boolean above)

This method is deprecated.
请使用z轴层级来设置蒙层和路线的相对位置设置是否显示在蒙层之上

Parameters

above	是否显示在蒙层智商

Returns

设置后的线属性

public PolylineOptions abovePillar (boolean isAbove)

This method is deprecated.
Polyline是否显示在楼块上方已经废弃，建议使用level(int)，精确设置显示层级关系

@return

public PolylineOptions add (LatLng latlng, LatLng... args)

添加顶点

Parameters

latlng	将指定坐标点添加到折线顶点集合末尾

Returns

添加顶点后的PolylineOptions对象

public PolylineOptions add (LatLng[] latLngs)

添加顶点

Parameters

latLngs	将指定坐标集合添加到折线顶点集合末尾

Returns

添加顶点后的PolylineOptions对象

public PolylineOptions addAll (Iterable<LatLng> latLngs)

添加顶点

Parameters

latLngs	将指定坐标集合添加到折线顶点集合末尾

Returns

添加顶点后的PolylineOptions对象

public PolylineOptions alpha (float a)

设置透明度

Parameters

a	透明度

Returns

设置透明度后的线属性

public PolylineOptions animation (Animation a)

执行一个动画

Parameters

a	动画

Returns

添加动画后的线属性

public PolylineOptions arrow (boolean flag)

导航用接口,开发都不要用

public PolylineOptions arrowSpacing (int arrowSpacing)

设置方向箭头的间距，单位（px),默认是100px

Parameters

arrowSpacing	箭头之间的间距（如果设置了自定义的箭头图片，建议arrowSpacing的值大于自定义箭头图片的宽度）

public PolylineOptions arrowTexture (BitmapDescriptor arrowTexture)

设置方向箭头的自定义纹理

Parameters

arrowTexture	纹理图片包装类

public PolylineOptions borderColor (int borderColor)

设置线ARGB的描边颜色：当线是纯色线的时候，设置border的颜色可用此接口

Parameters

borderColor	ARGB格式颜色

public PolylineOptions borderColors (int[] borderColors)

设置ARGB线的描边颜色，borderColors的数量应该与 colors(int[], int[])接口中的colors的长度保持一致。

Parameters

borderColors	ARGB格式颜色数组

public PolylineOptions borderWidth (float borderWidth)

设置ARGB线描边的宽度

public PolylineOptions clickable (boolean clickable)

是否可以点击

public PolylineOptions collisionBy (PolylineCollision... collisions)

设置碰撞关系目前只对道路线有效

public PolylineOptions color (int i)

设置线的颜色

Parameters

i	注意： 1、当使用ARGB线时为ARGB色值 2、当使用`colorTexture(BitmapDescriptor)`设置自定义纹理，使用纹理线时，指定使用纹理的第几像素行来绘制线

Returns

设置颜色后的PolylineOptions对象

public PolylineOptions colorTexture (BitmapDescriptor bitmapDescriptor)

注意：
1、当调用此接口，且LineType不为LINE_TYPE_DOTTEDLINE时，color和colors接口指定的值代表用此接口设置纹理的第几像素行，以绘制纹理线
2、当调用此接口，且LineType设置为LINE_TYPE_DOTTEDLINE时，绘制线时会连续绘制此接口设置的纹理。
3、提供的纹理图片最大高度不能超过16px。

public PolylineOptions colorType (PolylineOptions.ColorType type)

设置颜色类型

Parameters

type	颜色类型 `PolylineOptions.ColorType`

Returns

设置颜色类型后的PolylineOptions对象

public PolylineOptions colors (int[] colors, int[] indexes)

设置线的分段颜色

Parameters

colors	颜色数组注： 1、当使用ARGB线时为ARGB色值 2、当使用`colorTexture(BitmapDescriptor)`设置自定义纹理，使用纹理线时，指定使用纹理的第几像素行来绘制线
indexes	颜色数组对应的顶点索引数组

public PolylineOptions eraseColor (int eraseColor)

设置ARGB类型线的擦除色，默认为GRAY

public float getAlpha ()

获取透明得

Returns

透明度

public Animation getAnimation ()

获取设置的动画

Returns

动画

public int getArrowSpacing ()

获取箭头的间距，单位（px)，默认100px

public BitmapDescriptor getArrowTexture ()

获取Polyline自定义箭头的纹理

public int[] getBorderColors ()

获取ARGB线 border颜色数组如果是纯色线的borderColor(int),则返回长度为1的颜色数组

public float getBorderWidth ()

获取ARGB线描边宽度，(单位px)

public PolylineCollision[] getCollisions ()

public int getColor ()

返回PolylineOptions对象的32-bit ARGB颜色

Returns

折线的32-bit ARGB颜色

public BitmapDescriptor getColorTexture ()

获取纹理

Returns

纹理图片名称

public PolylineOptions.ColorType getColorType ()

获取设置的颜色类型

Returns

颜色类型 PolylineOptions.ColorType

public int[][] getColors ()

返回PolylineOptions对象的分段颜色

Returns

int[0]为颜色数组;int[1]为颜色对应顶点的索引值

public int getEraseColor ()

获取ARGB类型线的擦除色，默认为GRAY

public IndoorInfo getIndoorInfo ()

获取绑定的室内图信息

public int getLevel ()

获取PolylineOptions的显示level

public boolean getLineCap ()

获取路线是否显示半圆端点

Returns

是否显示半圆端点

public int getLineType ()

获取线类型

Returns

线类型

public List<Integer> getPattern ()

public List<LatLng> getPoints ()

返回PolylineOptions对象的顶点坐标列表

Returns

折线的顶点坐标列表

public PolylineOptions.Text getText ()

获取沿 polyline 展示的文字

public String getTextureName ()

获取纹理图片名称已过时，使用 getColorTexture() 代替此方法

Returns

纹理图片名称

public float getWidth ()

返回PolylineOptions对象的宽度，单位（px)

Returns

折线的宽度

public int getZIndex ()

返回PolylineOptions对象的堆叠顺序

Returns

折线的堆叠顺序

public static String getsDefaultArrowTexture ()

获取默认的方向箭头图片名称，后续不再提供这个方法

Returns

图片名称如未设置则返回null

public PolylineOptions gradient (boolean enable)

渐变色开关只有 getLineType() == LINE_TYPE_MULTICOLORLINE 且 isRoad() == true 才生效

Parameters

enable	true-启动，false-未启动

public PolylineOptions indoorInfo (IndoorInfo indoorInfo)

为Polyline添加室内图信息（buildingId，floorName）当添加室内图信息后，Marker将会随着绑定的室内图状态改变而展示和隐藏

public boolean isAboveMaskLayer ()

This method is deprecated.
请使用z轴层级来设置蒙层和路线的相对位置判断是否显示在蒙层之上

Returns

是否显示在蒙层之上

public boolean isAbovePillar ()

如果不设置Polyline的zIndex时，是否显示在3D楼块上方，默认在显示在楼块下方

public boolean isArrow ()

导航用接口,开发都不要用

public boolean isClickable ()

是否可点击

public boolean isGradientEnable ()

是否开启渐变色

Returns

true-启动，false-未启动

public boolean isRoad ()

判断线是否为路线

Returns

是否为路线

public boolean isVisible ()

返回PolylineOptions对象的可见性

Returns

true 可见 false 隐藏

public PolylineOptions latLngs (List<LatLng> listLatlngs)

设置折线坐标

Parameters

listLatlngs	将折线的顶点设置为指定列表

public PolylineOptions level (int level)

设置Polyline的显示Level，level用于控制Polyline与楼块，道路，POI的显示层级关系。默认为OverlayLevelAboveRoads道路之上楼块之下相同Level内的显示层级关系通过zIndex(int)来控制，zIndex越大越靠上显示。 Level优先级高于zIndex

Parameters

level

必须为如下值之一，否则不生效

OverlayLevelAboveRoads

OverlayLevelAboveBuildings

OverlayLevelAboveLabels

public PolylineOptions lineCap (boolean cap)

设置路线是否显示半圆端点

Parameters

cap	是否显示半圆端点

Returns

设置后的线属性

public PolylineOptions lineType (int lineType)

设置线的类型，必须LineType里面的一种

Parameters

lineType	线类型

public PolylineOptions pattern (List<Integer> pattern)

设置ARGB虚线的样式

Parameters

pattern	pattern的元素数量必须是偶数个，每对元素分别表示虚线中实线区域的长度，以及空白区域的长度（单位px)

public PolylineOptions road (boolean isRoad)

设置线是否为路线

Parameters

isRoad	是否为路线

Returns

设置后的线属性

public PolylineOptions setColorTexture (String strTextureName)

设置自定义纹理，自定义的纹理文件必须放在项目的asset目录下
已过时，使用 colorTexture(BitmapDescriptor) 代替此方法
注意：
1、当调用此接口，且LineType不为LINE_TYPE_DOTTEDLINE时，color和colors接口指定的值代表用此接口设置纹理的第几像素行，以绘制纹理线
2、当调用此接口，且LineType设置为LINE_TYPE_DOTTEDLINE时，绘制线时会连续绘制此接口设置的纹理。
3、提供的纹理图片最大高度不能超过16px。

Parameters

strTextureName	自定义纹理文件名，不含asset, 如文件在 /asset/texture.png,则传入texture.png

public void setColors (int[] colors, int[] indexes)

public static void setDefaultArrowTexture (String textureName)

设置默认的方向箭头图片名称，后续不再提供这个方法

Parameters

textureName	图片名称

public void setLatLngs (List<LatLng> listLatlngs)

设置折线坐标

Parameters

listLatlngs	将折线的顶点设置为指定列表

public PolylineOptions setLineType (int lineType)

设置线的类型，必须LineType里面的一种
已废弃，使用 lineType(int) 代替此方法

Parameters

lineType	线类型

public PolylineOptions text (PolylineOptions.Text text)

设置沿 polyline 展示的文字
只要调用 addPolyline(PolylineOptions) 构造出 PolylineOptions.Text 就不可以再调用 setPoints(List) 修改展示的路径，只能创建新的 Polyline

public PolylineOptions updatePoints (Iterable<LatLng> latLngs)

添加顶点,该方法会清空原来顶点集合

Parameters

latLngs	将指定坐标集合更新折线顶点集合

Returns

添加顶点后的PolylineOptions对象

public PolylineOptions visible (boolean visible)

设置折线可见性

Parameters

visible	设置折线的可见性 true 可见 false 隐藏

Returns

设置可见性后的PolylineOptions对象

public PolylineOptions width (float width)

设置线宽度

Parameters

width	指定线宽度，单位：px，目前限制最大宽度 128

Returns

设置宽度后的PolylineOptions对象

public void writeToParcel (Parcel out, int flags)

序列化

public PolylineOptions zIndex (int zIndex)

设置相同显示Level level(int) 的折线堆叠顺序，相同显示level，zIndex越大越靠上显示 level优先级大于zIndex

Parameters

zIndex	指定折线的堆叠顺序

Returns

指定堆叠顺序后的PolylineOptions对象

Interfaces

Classes

Annotations

Enums

PolylineOptions

Class Overview

Summary

Public Constructors

public PolylineOptions ()

Public Methods

public PolylineOptions aboveMaskLayer (boolean above)

Parameters

Returns

public PolylineOptions abovePillar (boolean isAbove)

public PolylineOptions add (LatLng latlng, LatLng... args)

Parameters

Returns

public PolylineOptions add (LatLng[] latLngs)

Parameters

Returns

public PolylineOptions addAll (Iterable<LatLng> latLngs)

Parameters

Returns

public PolylineOptions alpha (float a)

Parameters

Returns

public PolylineOptions animation (Animation a)

Parameters

Returns

public PolylineOptions arrow (boolean flag)

public PolylineOptions arrowSpacing (int arrowSpacing)

Parameters

public PolylineOptions arrowTexture (BitmapDescriptor arrowTexture)

Parameters

public PolylineOptions borderColor (int borderColor)

Parameters

public PolylineOptions borderColors (int[] borderColors)

Parameters

public PolylineOptions borderWidth (float borderWidth)

public PolylineOptions clickable (boolean clickable)

public PolylineOptions collisionBy (PolylineCollision... collisions)

public PolylineOptions color (int i)

Parameters

Returns

public PolylineOptions colorTexture (BitmapDescriptor bitmapDescriptor)

public PolylineOptions colorType (PolylineOptions.ColorType type)

Parameters

Returns

public PolylineOptions colors (int[] colors, int[] indexes)

Parameters

public PolylineOptions eraseColor (int eraseColor)

public float getAlpha ()

Returns

public Animation getAnimation ()

Returns

public int getArrowSpacing ()

public BitmapDescriptor getArrowTexture ()

public int[] getBorderColors ()

public float getBorderWidth ()

public PolylineCollision[] getCollisions ()

public int getColor ()

Returns

public BitmapDescriptor getColorTexture ()

Returns

public PolylineOptions.ColorType getColorType ()

Returns

public int[][] getColors ()

Returns

public int getEraseColor ()

public IndoorInfo getIndoorInfo ()

public int getLevel ()

public boolean getLineCap ()

Returns

public int getLineType ()

Returns

public List<Integer> getPattern ()

public List<LatLng> getPoints ()

Returns

public PolylineOptions.Text getText ()

public String getTextureName ()