Communicator.Markup.Shape.Polyline

 Polyline

This class reprsents a line defined by a list of points.

Methods

clearPoints

  • clearPoints(): void
  • Removes all points from this polyline

    Returns void

getEndEndcapColor

  • getEndEndcapColor(): Color

getEndEndcapSize

getEndEndcapType

getEndcapsInverted

  • getEndcapsInverted(): boolean
  • Gets whether endcaps are inverted for this shape. The default value is false.

    Returns boolean

    value indicating whether endcaps are inverted

getPoints

  • getPoints(): Point2[]
  • Gets the points in this polyline

    Returns Point2[]

    the points in this polyline

getStartEndcapColor

  • getStartEndcapColor(): Color

getStartEndcapSize

  • getStartEndcapSize(): Pixels

getStartEndcapType

getStrokeColor

  • getStrokeColor(): Color

getStrokeWidth

pushPoint

  • pushPoint(point: Point2): void
  • Adds a point to the polyline

    Parameters

    • point: Point2

      the point to add to the line

    Returns void

setEndEndcapColor

  • setEndEndcapColor(color: Color): void

setEndEndcapSize

  • setEndEndcapSize(size: Pixels): void

setEndEndcapType

setEndcapType

  • Convenience for setting the start and eend endcap type for this shape

    Parameters

    Returns void

setEndcapsInverted

  • setEndcapsInverted(inverted: boolean): void
  • Sets whether endcapsare inverted for this shape.

    Parameters

    • inverted: boolean

      value indicated whether endcaps should be inverted

    Returns void

setStartEndcapColor

  • setStartEndcapColor(color: Color): void

setStartEndcapSize

  • setStartEndcapSize(size: Pixels): void

setStartEndcapType

  • setStartEndcapType(endcapType: EndcapType): void

setStrokeColor

  • setStrokeColor(color: Color): void

setStrokeWidth

  • setStrokeWidth(strokeWidth: Pixels): void
  • Sets the stroke width for this shape in pixels

    Parameters

    • strokeWidth: Pixels

      the stroke width in pixels

    Returns void