Class PolylineOptions

线段的选项类

Since

1.0.0

Hierarchy (view full)

Constructors

constructor

Properties

aboveMaskLayer color colorValues customIndexes customTexture? customTextureList customTextures dashArrayCircle dashArrayDefault dottedLine dottedLineType eraseColor eraseTexture? eraseVisible footPrintGap footPrintTexture? geodesic gradient id jsonMap lineCapType lineGradient lineJoinType points pointsArray showPolylineRangeBegin showPolylineRangeEnable showPolylineRangeEnd showRangeBegin showRangeEnd showRatio transparency type updateFlags useEngine useTexture visible width zIndex TAG

Methods

add addAll addIfPresent clone describeContents getAboveMaskLayer getColor getColorValues getCustomTexture getCustomTextureIndex getCustomTextureList getDottedLine getDottedLineType getEraseColor getEraseTexture getEraseVisible getFootPrintGap getFootPrintTexture getGeodesic getLineCap getLineCapType getLineGradient getLineJoin getLineJoinType getPoints getPolylineShowRangeBegin getPolylineShowRangeEnd getShowPolylineRangeEnable getShowRangeBegin getShowRangeEnd getShowRatio getTransparency getUpdateFlags getUseEngine getUseGradient getUseTexture getVisible getWidth getZIndex resetUpdateFlags setAboveMaskLayer setColor setColorValues setCustomTexture setCustomTextureIndex setCustomTextureList setDottedLine setDottedLineType setEraseColor setEraseTexture setFootPrintGap setFootPrintTexture setGeodesic setGradient setLineCapType setLineJoinType setPoints setPolylineShowRange setShowPolylineRangeEnabled setShowRatio setShownRange setTransparency setUseEngine setUseTexture setVisible setWidth setZIndex toJson

Constructors

constructor

Properties

Private aboveMaskLayer

aboveMaskLayer: boolean = false

Private color

color: number = 0xff000000

Private colorValues

colorValues: Int32Array = ...

Private customIndexes

customIndexes: Int32Array = ...

Private Optional customTexture

customTexture?: BitmapDescriptor

Private customTextureList

customTextureList: ArrayList<BitmapDescriptor> = ...

Private customTextures

customTextures: BitmapDescriptor[] = []

Protected dashArrayCircle

dashArrayCircle: ArrayList<number> = ...

Protected dashArrayDefault

dashArrayDefault: ArrayList<number> = ...

Private dottedLine

dottedLine: boolean = false

Private dottedLineType

dottedLineType: DottedLineType = DottedLineType.DOTTEDLINE_TYPE_SQUARE

Private eraseColor

eraseColor: number = 0xff0000

Private Optional eraseTexture

eraseTexture?: BitmapDescriptor

Private eraseVisible

eraseVisible: boolean = false

Private footPrintGap

footPrintGap: number = 100

Private Optional footPrintTexture

footPrintTexture?: BitmapDescriptor

Private geodesic

geodesic: boolean = false

Private gradient

gradient: boolean = false

Protected id

id: string = ''

Protected jsonMap

jsonMap: HashMap<string, object> = ...

Private lineCapType

lineCapType: LineCapType = LineCapType.LineCapRound

Private lineGradient

lineGradient: JsObjString = ...

Private lineJoinType

lineJoinType: LineJoinType = LineJoinType.LineJoinBevel

Private points

points: LatLng[] = []

Private pointsArray

pointsArray: ArrayList<LatLng> = ...

Private showPolylineRangeBegin

showPolylineRangeBegin: number = 0

Private showPolylineRangeEnable

showPolylineRangeEnable: boolean = false

Private showPolylineRangeEnd

showPolylineRangeEnd: number = 0

Private showRangeBegin

showRangeBegin: number = -1

Private showRangeEnd

showRangeEnd: number = -1

Private showRatio

showRatio: number = -1

Private transparency

transparency: number = 1

Protected type

type: string = ''

Exclude

javadoc中不显示

Private updateFlags

updateFlags: PolylineUpdateFlags = ...

Private useEngine

useEngine: boolean = false

Private useTexture

useTexture: boolean = true

Private visible

visible: boolean = true

Private width

width: number = 10.0

Private zIndex

zIndex: number = 50.0

Static Readonly TAG

TAG: string = 'PolylineOptions'

Methods

add

  • add(...points): PolylineOptions

  • 追加一个顶点到线段的坐标集合。

    Parameters

    Returns PolylineOptions

    追加一个顶点到线段终点的PolylineOptions对象

    Since

    1.0.0

addAll

  • addAll(points): PolylineOptions

  • 追加一批顶点到线段的坐标集合。

    Parameters

    • points: ArrayList<LatLng>

      要添加的顶点集合。

    Returns PolylineOptions

    追加一批顶点到线段终点的PolylineOptions对象

    Since

    1.0.0

Protected addIfPresent

  • addIfPresent(fieldName, value, forceUpdate?): void

  • 添加属性，会带有对比

    Parameters

    • fieldName: string

      属性名称

    • value: object

      内容

    • forceUpdate: boolean = false

      如果为true 则不会和上一次的value对比直接添加

    Returns void

clone

describeContents

  • describeContents(): number

  • Returns number

    Exclude

    javadoc中不显示

getAboveMaskLayer

  • getAboveMaskLayer(): boolean

  • 获取线段是否在蒙层上面 蒙层详见 com.amap.api.maps.AMap#setMaskLayerParams(int, int, int, int, int, long)

    Returns boolean

    true:表示在蒙层上面,false:表示在蒙层下面

    Exclude

    javadoc中不显示 滴滴使用

    Since

    V2.0.0

getColor

  • getColor(): number

  • 获取线段的颜色ARGB格式。

    Returns number

    线段的颜色ARGB格式。

    Since

    1.0.0

getColorValues

  • getColorValues(): Int32Array

  • 获取线段的颜色列表

    Returns Int32Array

    颜色列表。

    Since

    1.0.0

getCustomTexture

  • getCustomTexture(): undefined | BitmapDescriptor

  • 获取线段的纹理图。

    Returns undefined | BitmapDescriptor

    线段的纹理图。

    Since

    V2.0.0

getCustomTextureIndex

  • getCustomTextureIndex(): Int32Array

  • 获取线段纹理index列表

    Returns Int32Array

    分段纹理index列表

    Since

    2.0.0

getCustomTextureList

  • getCustomTextureList(): ArrayList<BitmapDescriptor>

  • 获取线段纹理列表

    Returns ArrayList<BitmapDescriptor>

    纹理列表。

    Since

    2.0.0

getDottedLine

  • getDottedLine(): boolean

  • 获取线段是否画虚线，默认为false，画实线。

    Returns boolean

    true，画虚线；false，画实线。

    Since

    1.0.0

getDottedLineType

  • getDottedLineType(): number

  • Returns number

getEraseColor

  • getEraseColor(): number

  • 获取擦除线段（显示范围外）的颜色。

    Returns number

    线段显示范围外颜色。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

getEraseTexture

  • getEraseTexture(): undefined | BitmapDescriptor

  • 获取擦除线段（显示范围外）的纹理。

    Returns undefined | BitmapDescriptor

    线段显示范围外纹理图。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

getEraseVisible

  • getEraseVisible(): boolean

  • 获取擦除线段（显示范围外）的可见性。

    Returns boolean

    擦除线段（线段显示范围外）可见性。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

getFootPrintGap

  • getFootPrintGap(): number

  • 获取线段的脚印纹理间隔。

    Returns number

    返回线段的脚印纹理间隔，单位像素

    Since

    V2.0.0

    Exclude

    javadoc中不显示

getFootPrintTexture

  • getFootPrintTexture(): undefined | BitmapDescriptor

  • 获取线段的脚印纹理图。

    Returns undefined | BitmapDescriptor

    线段的脚印纹理图。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

getGeodesic

  • getGeodesic(): boolean

  • Returns boolean

Private getLineCap

  • getLineCap(): string

  • Returns string

getLineCapType

  • getLineCapType(): LineCapType

  • 返回Polyline尾部形状

    Returns LineCapType

    形状

    Since

    1.0.0

Private getLineGradient

  • getLineGradient(transparency): JsObjString

  • Parameters

    • transparency: number

    Returns JsObjString

Private getLineJoin

  • getLineJoin(): string

  • Returns string

getLineJoinType

  • getLineJoinType(): LineJoinType

  • 返回Polyline连接处形状

    Returns LineJoinType

    形状

    Since

    1.0.0

getPoints

  • getPoints(): ArrayList<LatLng>

  • 获取线段的点坐标列表。

    Returns ArrayList<LatLng>

    线段的顶点坐标列表。

    Since

    1.0.0

getPolylineShowRangeBegin

  • getPolylineShowRangeBegin(): number

  • 线段显示范围开始点,polyline2.0接口

    Returns number

    用户设置显示范围线段起始点

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ,导航SDK使用

getPolylineShowRangeEnd

  • getPolylineShowRangeEnd(): number

  • 线段显示范围结束点,polyline2.0接口

    Returns number

    用户设置显示范围线段终止点

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ,导航SDK使用

getShowPolylineRangeEnable

  • getShowPolylineRangeEnable(): boolean

  • 获取PolylineRangeEnable值，polyline2.0接口

    Returns boolean

    Exclude

    javadoc中不显示

    Since

    V2.0.0

getShowRangeBegin

  • getShowRangeBegin(): number

  • 线段显示范围开始点

    Returns number

    小于0无效，范围0到点的个数总数减1,默认值-1

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ，,导航SDK使用

getShowRangeEnd

  • getShowRangeEnd(): number

  • 线段显示范围结束点

    Returns number

    小于0无效，范围0到点的个数总数减1,默认值-1

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ,导航SDK使用

getShowRatio

  • getShowRatio(): number

  • 线段显示比例

    Returns number

    小于0无效，范围0到点的个数总数减1,默认值-1

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ，暂时隐藏，后续native层实现后再开放

getTransparency

  • getTransparency(): number

  • 获取线的透明度

    Returns number

    透明度0~1 默认是1不透明

    Since

    1.0.0

getUpdateFlags

  • getUpdateFlags(): PolylineUpdateFlags

  • 用于Native判断当前有哪些数据有更新

    Returns PolylineUpdateFlags

    Exclude

    javadoc中不显示。

getUseEngine

  • getUseEngine(): boolean

  • Returns boolean

getUseGradient

  • getUseGradient(): boolean

  • 获取线段是否使用渐变色

    Returns boolean

    是否使用渐变色，true：使用，false不使用

    Since

    2.0.0

getUseTexture

  • getUseTexture(): boolean

  • 获取线段是否使用纹理贴图。

    Returns boolean

    true：使用纹理贴图；false：未使用。

    Since

    V2.0.0

getVisible

  • getVisible(): boolean

  • 获取线段的可见属性

    Returns boolean

    true：为可见; false：不可见。

    Since

    1.0.0

getWidth

  • getWidth(): number

  • 获取线段的宽度。

    Returns number

    宽度

    Since

    1.0.0

getZIndex

  • getZIndex(): number

  • 获取线段的Z轴值

    Returns number

    Z轴值

    Since

    1.0.0

resetUpdateFlags

  • resetUpdateFlags(): void

  • 用于Native判断当前有哪些数据有更新

    Returns void

    Exclude

    javadoc中不显示。

setAboveMaskLayer

  • setAboveMaskLayer(isAboveMaskLayer): PolylineOptions

  • 设置线段在蒙层上面绘制 蒙层详见 com.amap.api.maps.AMap#setMaskLayerParams(int, int, int, int, int, long)

    Parameters

    • isAboveMaskLayer: boolean

      true 表示在蒙层上面 默认为false

    Returns PolylineOptions

    设置线段蒙层属性的PolylineOptions对象。

    Exclude

    javadoc中不显示 滴滴使用

    Since

    V2.0.0

setColor

  • setColor(color): PolylineOptions

  • 设置线段的颜色，需要传入32位的ARGB格式。默认为黑色( 0xff000000)。

    Parameters

    • color: number

      颜色。

    Returns PolylineOptions

    设置线段颜色的PolylineOptions对象

    Since

    1.0.0

setColorValues

  • setColorValues(colors): PolylineOptions

  • 设置线段的颜色

    Parameters

    • colors: Int32Array

      颜色列表∂

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    1.0.0

setCustomTexture

  • setCustomTexture(customTexture): PolylineOptions

  • 设置线段的纹理图，图片为2的n次方。如果不是，会自动放大至2的n次方。图片最好不大于128*128。

    Parameters

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    V2.0.0

setCustomTextureIndex

  • setCustomTextureIndex(custemTextureIndexs): PolylineOptions

  • 设置线段纹理index数组

    Parameters

    • custemTextureIndexs: Int32Array

      每一段对应的纹理，用纹理列表的index来对应

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    2.0.0

setCustomTextureList

  • setCustomTextureList(customTextureList): PolylineOptions

  • 设置线段纹理list

    Parameters

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    2.0.0

setDottedLine

  • setDottedLine(isDottedLine): PolylineOptions

  • 设置是否画虚线，默认为false，画实线。

    Parameters

    • isDottedLine: boolean

      true，画虚线；false，画实线。

    Returns PolylineOptions

    设置线段是否为虚线的PolylineOptions对象。

    Since

    1.0.0

setDottedLineType

  • setDottedLineType(type): PolylineOptions

  • 设置虚线形状。

    Parameters

    • type: number

      形状：
      #DOTTEDLINE_TYPE_SQUARE:方形；
      #DOTTEDLINE_TYPE_CIRCLE：圆形；

    Returns PolylineOptions

    设置虚线形状的PolylineOptions对象。

    Since

    V2.0.0

setEraseColor

  • setEraseColor(eraseVisible, eraseColor): PolylineOptions

  • 设置线段擦除（显示范围外）颜色，需要传入32位的ARGB格式，针对颜色线段生效。默认为黑色( 0xff000000)，此函数需要com.amap.api.maps.model.PolylineOptions#setShownRange(float rangeBegin, float rangeEnd)使用后生效

    Parameters

    • eraseVisible: boolean

      擦除线段（线段显示范围外）可见性，默认不可见。

    • eraseColor: number

      擦除线段（线段显示范围外）颜色

    Returns PolylineOptions

    设置线段范围外颜色的PolylineOptions对象

    Since

    V2.0.0

setEraseTexture

  • setEraseTexture(eraseVisible, eraseTexture): PolylineOptions

  • 设置擦除线段（显示范围外）的纹理,针对纹理线段生效。此函数需要com.amap.api.maps.model.PolylineOptions#setShownRange(float rangeBegin, float rangeEnd)使用后生效

    Parameters

    • eraseVisible: boolean

      擦除线段（线段显示范围外）可见性，默认不可见。

    • eraseTexture: BitmapDescriptor

      擦除线段（线段显示范围外）纹理

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

setFootPrintGap

  • setFootPrintGap(footPrintGap): PolylineOptions

  • 设置线段的脚印纹理间隔。

    Parameters

    • footPrintGap: number

      用户设置线段的脚印纹理间隔,单位：像素

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

setFootPrintTexture

  • setFootPrintTexture(footPrintTexture): PolylineOptions

  • 设置线段的脚印纹理图，图片为2的n次方。如果不是，会自动放大至2的n次方。图片最好不大于128*128。

    Parameters

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    V2.0.0

    Exclude

    javadoc中不显示

setGeodesic

  • setGeodesic(isGeodesic): PolylineOptions

  • 设置线段是否为大地曲线，默认false，不画大地曲线。

    Parameters

    • isGeodesic: boolean

      一个表示线段是否为大地曲线的布尔值，true表示是大地曲线，false表示不是大地曲线。

    Returns PolylineOptions

    设置线段是否为大地曲线的PolylineOptions对象。

    Since

    1.0.0

setGradient

  • setGradient(useGradient): PolylineOptions

  • 设置线段是否使用渐变色

    Parameters

    • useGradient: boolean

      是否使用渐变色，true：使用，false不使用，默认为false；

    Returns PolylineOptions

    PolylineOptions 对象。

    Since

    2.0.0

setLineCapType

setLineJoinType

setPoints

  • setPoints(points): void

  • 设置线段的点坐标集合,如果以前已经存在点,则会清空以前的点。

    Parameters

    • points: ArrayList<LatLng>

      要设置的顶点集合

    Returns void

    Since

    1.0.0

setPolylineShowRange

  • setPolylineShowRange(rangeBegin, rangeEnd): PolylineOptions

  • 设置线段显示范围,polyline2.0接口 如果线段中有(A,B),设置范围为[0.1, 0.8]，则之后显示(A',B'),其中A' = A + 0.1*(B-A), B'= A + 0.9*(B-A) 如果线段中有多个点如，(A,B,C,D),设置范围为[1.5, 2.5], 则之后显示（B',C,C'）,其中B'= B + (1.5-1)*(C-B), C'=C + (2.5-2)(D-C)

    Parameters

    • rangeBegin: number

      范围0到rangEnd

    • rangeEnd: number

      范围rangeBegin到点的个数总数减1

    Returns PolylineOptions

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ，暂时隐藏，后续native层实现后再开放

setShowPolylineRangeEnabled

  • setShowPolylineRangeEnabled(showRangeEnable): PolylineOptions

  • 是否启用显示范围，true启用，默认false。不启用时展示全路径，polyline2.0接口

    Parameters

    • showRangeEnable: boolean

      是否开启showRange功能

    Returns PolylineOptions

    Exclude

    javadoc中不显示

    Since

    V2.0.0

setShowRatio

  • setShowRatio(ratio): PolylineOptions

  • 设置线段显示比例 如果线段中有(A,B),设置比例为0.5，则之后显示(A,A')显示一半,其中A' = A + 0.5*(B-A) 如果线段中有多个点如，(A,B,C,D),则需要关注点的个数减一 ratio = 1 显示(A,B),ratio = 2 显示(A,B,C),ratio = 3 显示(A,B,C,D)

    Parameters

    • ratio: number

      小于0无效，范围0到点的个数总数减1,默认值-1

    Returns PolylineOptions

    Since

    V2.0.0

    Exclude

    javadoc中不显示 ，暂时隐藏，后续native层实现后再开放

    Deprecated

    请使用setShownRange方法

setShownRange

  • setShownRange(rangeBegin, rangeEnd): PolylineOptions

  • 设置线段显示范围 如果线段中有(A,B),设置范围为[0.1, 0.8]，则之后显示(A',B'),其中A' = A + 0.1*(B-A), B'= A + 0.9*(B-A) 如果线段中有多个点如，(A,B,C,D),设置范围为[1.5, 2.5], 则之后显示（B',C,C'）,其中B'= B + (1.5-1)*(C-B), C'=C + (2.5-2)(D-C)

    Parameters

    • rangeBegin: number

      小于0无效，范围0到rangEnd

    • rangeEnd: number

      小于0无效，范围rangeBegin到点的个数总数减1

    Returns PolylineOptions

    Since

    2.0.0

    Exclude

    javadoc中不显示 ，暂时隐藏，后续native层实现后再开放

setTransparency

  • setTransparency(transparency): PolylineOptions

  • 设置线段的透明度0~1，默认是1,1表示不透明

    Parameters

    • transparency: number

      透明度

    Returns PolylineOptions

    设置线段带透明度的PolylineOptions对象。

    Since

    1.0.0

setUseEngine

  • setUseEngine(useEngine): void

  • Parameters

    • useEngine: boolean

    Returns void

setUseTexture

  • setUseTexture(useTexture): PolylineOptions

  • 设置是否使用纹理贴图画线。

    Parameters

    • useTexture: boolean

      true，使用纹理贴图；false，不使用。默认为使用纹理贴图画线。

    Returns PolylineOptions

    返回PolylineOptions对象。

    Since

    V2.0

setVisible

  • setVisible(visible): PolylineOptions

  • 设置线段的可见性。默认为可見

    Parameters

    • visible: boolean

      一个表示线段是否可见的布尔值，true表示可见，false表示不可见。

    Returns PolylineOptions

    设置新可见属性的PolylineOptions对象

    Since

    1.0.0

setWidth

  • setWidth(width): PolylineOptions

  • 设置线段的宽度，默认为10。

    Parameters

    • width: number

      宽度 单位：像素。

    Returns PolylineOptions

    设置线段新宽度的PolylineOptions对象。

    Since

    1.0.0

setZIndex

  • setZIndex(zIndex): PolylineOptions

  • 设置线段Z轴的值。

    Parameters

    • zIndex: number

      要设置的Z轴的值。

    Returns PolylineOptions

    设置线段新Z轴值的PolylineOptions对象。

    Since

    1.0.0

toJson

  • toJson(): string

  • 获取屏幕坐标

    Returns string

    Exclude

    javadoc中不显示

Settings

Member Visibility

Theme

On This Page

constructoraboveMaskLayercolorcolorValuescustomIndexescustomTexturecustomTextureListcustomTexturesdashArrayCircledashArrayDefaultdottedLinedottedLineTypeeraseColoreraseTextureeraseVisiblefootPrintGapfootPrintTexturegeodesicgradientidjsonMaplineCapTypelineGradientlineJoinTypepointspointsArrayshowPolylineRangeBeginshowPolylineRangeEnableshowPolylineRangeEndshowRangeBeginshowRangeEndshowRatiotransparencytypeupdateFlagsuseEngineuseTexturevisiblewidthzIndexTAGaddaddAlladdIfPresentclonedescribeContentsgetAboveMaskLayergetColorgetColorValuesgetCustomTexturegetCustomTextureIndexgetCustomTextureListgetDottedLinegetDottedLineTypegetEraseColorgetEraseTexturegetEraseVisiblegetFootPrintGapgetFootPrintTexturegetGeodesicgetLineCapgetLineCapTypegetLineGradientgetLineJoingetLineJoinTypegetPointsgetPolylineShowRangeBegingetPolylineShowRangeEndgetShowPolylineRangeEnablegetShowRangeBegingetShowRangeEndgetShowRatiogetTransparencygetUpdateFlagsgetUseEnginegetUseGradientgetUseTexturegetVisiblegetWidthgetZIndexresetUpdateFlagssetAboveMaskLayersetColorsetColorValuessetCustomTexturesetCustomTextureIndexsetCustomTextureListsetDottedLinesetDottedLineTypesetEraseColorsetEraseTexturesetFootPrintGapsetFootPrintTexturesetGeodesicsetGradientsetLineCapTypesetLineJoinTypesetPointssetPolylineShowRangesetShowPolylineRangeEnabledsetShowRatiosetShownRangesetTransparencysetUseEnginesetUseTexturesetVisiblesetWidthsetZIndextoJson

Generated using TypeDoc