目录

PolylineOptions

Class Info

public class PolylineOptions

实现了Parcelable，定义了折线的有关选项。

Public Constructor Summary

Constructor Name

PolylineOptions()

PolylineOptions类的默认构造方法。

Public Method Summary

Qualifier and Type

Method Name and Description

PolylineOptions

add(LatLng… points)

添加数个顶点到折线。

PolylineOptions

add(LatLng point)

添加单个顶点到折线。

PolylineOptions

addAll(Iterable<LatLng> points)

添加一组顶点到折线。

PolylineOptions

clickable(boolean clickable)

设置折线的可点击性。

PolylineOptions

color(int color)

设置折线的颜色。

PolylineOptions

colorValues(List<Integer> colors)

设置折线的多段颜色。

PolylineOptions

endCap(Cap endCap)

设置折线的末尾端点。

PolylineOptions

geodesic(boolean geodesic)

设置是否将折线的每个线段绘制为大地线。

Cap

getEndCap()

获取折线的末尾端点。

List<PatternItem>

getPattern()

获取折线的样式。

Cap

getStartCap()

获取折线的起始端点。

PolylineOptions

jointType(int jointType)

设置折线除起始和结束顶点之外的所有顶点的节点类型，有关允许的值，请参见JointType。

PolylineOptions

pattern(List<PatternItem> pattern)

设置折线的样式。

PolylineOptions

startCap(Cap startCap)

设置折线的起始端点。

PolylineOptions

visible(boolean visible)

设置折线的可见性。

PolylineOptions

width(float width)

设置折线的宽度。

PolylineOptions

zIndex(float zIndex)

设置折线的z指数。

PolylineOptions

gradient(boolean on)

设置折线的渐变属性。

Public Methods

[h2]add(LatLng… points)

Method

public PolylineOptions add(LatLng… points)

您调用此API可以添加数个顶点到折线。

Parameters

Name

Description

points

若干点的位置信息。

Returns

Type

Description

PolylineOptions

包含指定的一些顶点的PolylineOptions对象。

[h2]add(LatLng point)

Method

public PolylineOptions add(LatLng point)

您调用此API可以添加单个顶点到折线。

Parameters

Name

Description

point

点的位置信息。

Returns

Type

Description

PolylineOptions

设置新的顶点后的PolylineOptions对象。

[h2]addAll

Method

public PolylineOptions addAll(Iterable<LatLng> points)

您调用此API可以添加一组顶点到折线。

Parameters

Name

Description

points

一组顶点。

Returns

Type

Description

PolylineOptions

包含一组顶点的PolylineOptions对象。

[h2]clickable

Method

public PolylineOptions clickable(boolean clickable)

您调用此API可以设置折线的可点击性。

Parameters

Name

Description

clickable

可点击性。

  • true：可点击
  • false：不可点击

默认值为false。

Returns

Type

Description

PolylineOptions

设置新的可点击性后的PolylineOptions对象。

[h2]color

Method

public PolylineOptions color(int color)

您调用此API可以设置折线的颜色。

Parameters

Name

Description

color

ARGB格式颜色值，默认值为黑色（0xff000000）。

Returns

Type

Description

PolylineOptions

设置新的折线颜色后的PolylineOptions对象。

[h2]colorValues

Method

public PolylineOptions colorValues(List<Integer> colors)

设置折线的多段颜色。

Parameters

Name

Description

colors

多段颜色，ARGB格式颜色值。

Returns

Type

Description

PolylineOptions

设置折线的多段颜色后的PolylineOptions对象。

[h2]endCap

Method

public PolylineOptions endCap(Cap endCap)

您调用此API可以设置折线的末尾端点。

Parameters

Name

Description

endCap

末尾端点，默认为ButtCap。

Returns

Type

Description

PolylineOptions

设置新的末尾端点后的PolylineOptions对象。

[h2]geodesic

Method

public PolylineOptions geodesic(boolean geodesic)

您调用此API可以设置是否将折线的每个线段绘制为大地线，如果未设置，将返回默认值false。

Parameters

Name

Description

geodesic
  • true：每段绘制为大地线。
  • false：不是大地线。

Returns

Type

Description

PolylineOptions

设置新的geodesic属性后的PolylineOptions对象。

[h2]getEndCap

Method

public Cap getEndCap()

您调用此API可以获取折线的末尾端点。

Returns

Type

Description

Cap

折线的末尾端点。如果未设置端点样式，则返回默认值ButtCap。

[h2]getPattern

Method

public List<PatternItem> getPattern()

您调用此API可以获取折线的样式。

Returns

Type

Description

List<PatternItem>

折线的样式。

[h2]getStartCap

Method

public Cap getStartCap()

您调用此API可以获取折线的起始端点。

Returns

Type

Description

Cap

折线的起始端点。如果未设置端点样式，则返回默认值ButtCap。

[h2]jointType

Method

public PolylineOptions jointType(int jointType)

设置折线除起始和结束顶点之外的所有顶点的节点类型，有关允许的值，请参见JointType。如果节点类型未定义或不是允许值之一，则将使用默认值DEFAULT。

Parameters

Name

Description

jointType

节点类型，默认值为DEFAULT。

Returns

Type

Description

PolylineOptions

设置新的节点类型后的PolylineOptions对象。

[h2]pattern

Method

public PolylineOptions pattern(List<PatternItem> pattern)

您调用此API可以设置折线的样式。

Parameters

Name

Description

pattern

PatternItem对象的集合。默认的样式为实心，用null表示。

Returns

Type

Description

PolylineOptions

设置新的样式后的PolylineOptions对象。

[h2]startCap

Method

public PolylineOptions startCap(Cap startCap)

您调用此API可以设置折线的起始端点。

Parameters

Name

Description

startCap

起始端点，默认为ButtCap。

Returns

Type

Description

PolylineOptions

设置新的起始端点后的PolylineOptions对象。

[h2]visible

Method

public PolylineOptions visible(boolean visible)

您调用此API可以设置折线的可见性，如果折线不可见，则不会绘制，其他所有状态均保留。

Parameters

Name

Description

visible

折线的可见性。

  • true：可见
  • false：不可见

默认值为true。

Returns

Type

Description

PolylineOptions

设置新的可见性后的PolylineOptions对象。

[h2]width

Method

public PolylineOptions width(float width)

您调用此API可以设置折线的宽度。

Parameters

Name

Description

width

折线的宽度，单位：像素，默认为10像素。

说明：

为兼容性考虑，此接口设置的折线实际宽度为设置值width的三倍。

Returns

Type

Description

PolylineOptions

设置新的折线宽度后的PolylineOptions对象。

Throws

Name

Description

IllegalArgumentException

当传入的宽度width是负数时。

[h2]zIndex

Method

public PolylineOptions zIndex(float zIndex)

用于设置折线的z指数。z指数指的是折线的叠加顺序，具有较大z指数的折线会绘制在具有较小z指数的折线上，具有相同z指数的叠加顺序为元素添加的先后顺序。

Parameters

Name

Description

zIndex

z指数，即折线的叠加顺序。默认的z指数是0。

Returns

Type

Description

PolylineOptions

设置新的z指数后的PolylineOptions对象。

[h2]gradient

Method

public PolylineOptions gradient(boolean on)

用于设置折线的渐变属性。

Parameters

Name

Description

on

是否开启折线的渐变属性，默认false。

  • true：开启
  • false：不开启

Returns

Type

Description

PolylineOptions

设置折线的渐变属性后的PolylineOptions对象。