Polyline (shell-vector-api API)

All Superinterfaces:: IOverlay

public interface Polyline
extends IOverlay

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DARK_BLUE` Deprecated.
`static int`	`DASHED` Deprecated.
`static int`	`GREEN` Deprecated.
`static int`	`GREY` Deprecated.
`static int`	`LIGHT_BLUE` Deprecated.
`static int`	`RED` Deprecated.
`static int`	`WHITE_BLUE` Deprecated.
`static int`	`YELLOW` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addTurnArrow(int index, int length)` 添加一个转弯箭头
`void`	`cleanTurnArrow()` 清除当前显示的路线转弯箭头
`void`	`eraseTo(int index, LatLng point)` 设置路线擦除的索引，要使此接口生效必须调用 `setEraseable(boolean)`
`int`	`getColor()` 获取当前颜色的索引值
`int[][]`	`getColors()` 获取每段折线颜色及顶点位置
`java.lang.String`	`getId()` 获取折线id
`int`	`getLevel()` 获取Polyline显示层级，详见 `OverlayLevel`
`java.util.List<java.lang.Integer>`	`getPattern()` 获取 ARGB虚线的样式 pattern的元素数量必须是偶数个，每对元素分别表示虚线中实线区域的长度，以及空白区域的长度（单位px)
`java.util.List<LatLng>`	`getPoints()` 返回折线的顶点坐标列表
`PolylineOptions`	`getPolylineOptions()` 获取线属性
`java.lang.Object`	`getTag()` 获取tag
`PolylineOptions.Text`	`getText()` 获取沿 polyline 展示的文字
`Rect`	`getVisibleRect()` 得到可见路线的bound
`float`	`getWidth()` 获取线的宽度（单位 px）
`int`	`getZIndex()` 获取折线堆叠顺序
`boolean`	`isAboveMaskLayer()` Deprecated. 请使用z轴层级来设置蒙层和路线的相对位置判断是否显示在蒙层之上
`boolean`	`isClickable()`
`boolean`	`isVisible()` 获取折线可见性
`void`	`pattern(java.util.List<java.lang.Integer> pattern)` 设置ARGB虚线的样式
`void`	`remove()` 从地图移除折线
`void`	`setAboveMaskLayer(boolean above)` Deprecated. 请使用z轴层级来设置蒙层和路线的相对位置设置是否显示在蒙层之上
`void`	`setArrow(boolean boEnable)` 导航用的API，开发者不要使用
`void`	`setClickable(boolean clickable)`
`void`	`setColor(int color)` 设置路线的颜色
`void`	`setColors(int[] colors, int[] indexs)` 设置线的分段颜色
`void`	`setColorTexture(BitmapDescriptor bitmapDescriptor)` 设置定制义的纹理，每个纹理的为8x64的图片
`void`	`setColorTexture(java.lang.String strTextureName)` Deprecated. 建议使用 `setColorTexture(BitmapDescriptor)`
`void`	`setEraseable(boolean eraseable)` 设置路线是否可以擦除
`void`	`setLevel(int level)` 修改Polyline的显示Level，level用于控制Polyline与楼块，道路，POI的显示层级关系。相同Level内的显示层级关系通过`setZIndex(int)`来控制，zIndex越大越靠上显示。默认为`OverlayLevel.OverlayLevelAboveRoads`道路之上楼块之下 Level优先级高于zIndex
`void`	`setPoints(java.util.List<LatLng> list)` 设置折线顶点
`void`	`setPolylineOptions(PolylineOptions options)` 设置一组线的属性
`void`	`setTag(java.lang.Object tag)` 设置tag
`void`	`setText(PolylineOptions.Text text)` 设置沿 polyline 展示的文字
`void`	`setVisible(boolean visible)` 设置折线可见性
`void`	`setWidth(float width)` 设置折线的宽度
`void`	`setZIndex(int zIndex)` 设置相同显示Level下的 `setLevel(int)` 的折线堆叠顺序。相同显示level，zIndex越大越靠上显示 level优先级大于zIndex
`void`	`startAnimation(Animation animation)` 开始播放动画，目前只有AlphaAnimation和EmergeAnimation支持。

- Field Detail
  - GREEN
```
@Deprecated
static final int GREEN
```
    Deprecated.
    
    绿色, 已废弃
    
    See Also:
    
    PolylineOptions.Colors.GREEN, Constant Field Values
  - YELLOW
```
@Deprecated
static final int YELLOW
```
    Deprecated.
    
    黄色，已废弃
    
    See Also:
    
    PolylineOptions.Colors.YELLOW, Constant Field Values
  - RED
```
@Deprecated
static final int RED
```
    Deprecated.
    
    红色，已废弃
    
    See Also:
    
    PolylineOptions.Colors.RED, Constant Field Values
  - LIGHT_BLUE
```
@Deprecated
static final int LIGHT_BLUE
```
    Deprecated.
    
    淡蓝，已废弃
    
    See Also:
    
    PolylineOptions.Colors.LIGHT_BLUE, Constant Field Values
  - DARK_BLUE
```
@Deprecated
static final int DARK_BLUE
```
    Deprecated.
    
    深蓝，已废弃
    
    See Also:
    
    PolylineOptions.Colors.DARK_BLUE, Constant Field Values
  - GREY
```
@Deprecated
static final int GREY
```
    Deprecated.
    
    灰色，已废弃
    
    See Also:
    
    PolylineOptions.Colors.GREY, Constant Field Values
  - DASHED
```
@Deprecated
static final int DASHED
```
    Deprecated.
    
    虚线，已废弃
    
    See Also:
    
    PolylineOptions.Colors.DASHED, Constant Field Values
  - WHITE_BLUE
```
@Deprecated
static final int WHITE_BLUE
```
    Deprecated.
    
    白蓝色，已废弃
    
    See Also:
    
    PolylineOptions.Colors.WHITE_BLUE, Constant Field Values
- Method Detail
  - setPolylineOptions
```
void setPolylineOptions(PolylineOptions options)
```
    设置一组线的属性
    
    Parameters:
    
    options - 线属性
  - getPolylineOptions
```
PolylineOptions getPolylineOptions()
```
    获取线属性
    
    Returns:
    
    线属性
  - remove
```
void remove()
```
    从地图移除折线
  - getId
```
java.lang.String getId()
```
    获取折线id
  - setPoints
```
void setPoints(java.util.List<LatLng> list)
```
    设置折线顶点
    
    Parameters:
    
    list - 将折线顶点设置为指定list
  - addTurnArrow
```
void addTurnArrow(int index,
                  int length)
```
    添加一个转弯箭头
    
    Parameters:
    
    index, - 路段index
    
    length - 转弯箭头长度
  - cleanTurnArrow
```
void cleanTurnArrow()
```
    清除当前显示的路线转弯箭头
  - getPoints
```
java.util.List<LatLng> getPoints()
```
    返回折线的顶点坐标列表
    
    Returns:
    
    折线的顶点坐标列表
  - setWidth
```
void setWidth(float width)
```
    设置折线的宽度
    
    Parameters:
    
    width - 折线宽度，单位：px，目前限制最大宽度 128
  - getWidth
```
float getWidth()
```
    获取线的宽度（单位 px）
    
    Returns:
    
    线宽度
  - setColor
```
void setColor(int color)
```
    设置路线的颜色
    
    Parameters:
    
    color - 当使用ARGB线时为ARGB色值
  - setColors
```
void setColors(int[] colors,
               int[] indexs)
```
    设置线的分段颜色
    
    Parameters:
    
    colors - 颜色数组
    
    indexs - 颜色数组对应的顶点索引数组
  - getColors
```
int[][] getColors()
```
    获取每段折线颜色及顶点位置
    
    Returns:
    
    int[0]折线颜色 int[1]折线顶点位置
  - setArrow
```
void setArrow(boolean boEnable)
```
    导航用的API，开发者不要使用
  - setColorTexture
```
void setColorTexture(java.lang.String strTextureName)
```
    Deprecated. 建议使用 setColorTexture(BitmapDescriptor)
    
    设置定制义的纹理，每个纹理的为8x64的图片
    
    Parameters:
    
    strTextureName - 线纹理的文件名。要放在assets目录下
  - setColorTexture
```
void setColorTexture(BitmapDescriptor bitmapDescriptor)
```
    设置定制义的纹理，每个纹理的为8x64的图片
    
    Parameters:
    
    bitmapDescriptor - 线颜色纹理
  - getColor
```
int getColor()
```
    获取当前颜色的索引值
    
    Returns:
    
    颜色索引值
  - setZIndex
```
void setZIndex(int zIndex)
```
    设置相同显示Level下的 setLevel(int) 的折线堆叠顺序。相同显示level，zIndex越大越靠上显示 level优先级大于zIndex
    
    Parameters:
    
    zIndex - 指定折线的堆叠顺序
  - getZIndex
```
int getZIndex()
```
    获取折线堆叠顺序
    
    Returns:
    
    zIndex 指定折线的堆叠顺序
  - setVisible
```
void setVisible(boolean visible)
```
    设置折线可见性
    
    Parameters:
    
    visible - 折线可见性 true 可见 false 隐藏
  - isVisible
```
boolean isVisible()
```
    获取折线可见性
    
    Returns:
    
    true 可见 false 隐藏
  - setAboveMaskLayer
```
void setAboveMaskLayer(boolean above)
```
    Deprecated. 请使用z轴层级来设置蒙层和路线的相对位置设置是否显示在蒙层之上
    
    Parameters:
    
    above - 是否显示在蒙层之上
  - isAboveMaskLayer
```
boolean isAboveMaskLayer()
```
    Deprecated. 请使用z轴层级来设置蒙层和路线的相对位置判断是否显示在蒙层之上
    
    Returns:
    
    是否显示在蒙层之上
  - getPattern
```
java.util.List<java.lang.Integer> getPattern()
```
    获取 ARGB虚线的样式 pattern的元素数量必须是偶数个，每对元素分别表示虚线中实线区域的长度，以及空白区域的长度（单位px)
    
    Returns:
  - pattern
```
void pattern(java.util.List<java.lang.Integer> pattern)
```
    设置ARGB虚线的样式
    
    Parameters:
    
    pattern - pattern的元素数量必须是偶数个，每对元素分别表示虚线中实线区域的长度，以及空白区域的长度（单位px)
    
    pattern -
  - eraseTo
```
void eraseTo(int index,
             LatLng point)
```
    设置路线擦除的索引，要使此接口生效必须调用 setEraseable(boolean)
    
    Parameters:
    
    index - 擦除点相对于路线所有点集的索引
    
    point - 擦除点坐标，如果此坐标在 [points[index], points[index + 1]] 之外，擦除点为 points[index]；如果此坐标在 [points[index], points[index + 1]] 之间，设置的这个点即为擦除点。
  - setEraseable
```
void setEraseable(boolean eraseable)
```
    设置路线是否可以擦除
    
    Parameters:
    
    eraseable - 默认为false不擦除
  - getVisibleRect
```
Rect getVisibleRect()
```
    得到可见路线的bound
  - startAnimation
```
void startAnimation(Animation animation)
```
    开始播放动画，目前只有AlphaAnimation和EmergeAnimation支持。
    
    Parameters:
    
    animation - 动画
  - setClickable
```
void setClickable(boolean clickable)
```
  - isClickable
```
boolean isClickable()
```
  - setTag
```
void setTag(java.lang.Object tag)
```
    设置tag
    
    Parameters:
    
    tag -
  - getTag
```
java.lang.Object getTag()
```
    获取tag
    
    Returns:
  - getLevel
```
int getLevel()
```
    获取Polyline显示层级，详见 OverlayLevel
    
    Returns:
  - setLevel
```
void setLevel(int level)
```
    修改Polyline的显示Level，level用于控制Polyline与楼块，道路，POI的显示层级关系。相同Level内的显示层级关系通过setZIndex(int)来控制，zIndex越大越靠上显示。默认为OverlayLevel.OverlayLevelAboveRoads道路之上楼块之下 Level优先级高于zIndex
    
    Parameters:
    
    level - 必须为如下值之一，否则不生效
    OverlayLevel.OverlayLevelAboveRoads
    
    OverlayLevel.OverlayLevelAboveBuildings
    
    OverlayLevel.OverlayLevelAboveLabels
  - getText
```
PolylineOptions.Text getText()
```
    获取沿 polyline 展示的文字
    
    Returns:
  - setText
```
void setText(PolylineOptions.Text text)
```
    设置沿 polyline 展示的文字
    
    Parameters:
    
    text -

Interface Polyline

Field Summary

Method Summary

Field Detail

GREEN

YELLOW

RED

LIGHT_BLUE

DARK_BLUE

GREY

DASHED

WHITE_BLUE

Method Detail

setPolylineOptions

getPolylineOptions

remove

getId

setPoints

addTurnArrow

cleanTurnArrow

getPoints

setWidth

getWidth

setColor

setColors

getColors

setArrow

setColorTexture

setColorTexture

getColor

setZIndex

getZIndex

setVisible

isVisible

setAboveMaskLayer

isAboveMaskLayer

getPattern

pattern

eraseTo

setEraseable

getVisibleRect

startAnimation

setClickable

isClickable

setTag

getTag

getLevel

setLevel

getText

setText