# Line

class `Markup.Shapes.``Line`()

  This class represents a single line consisting of two points. P1 is considered the start and P2 is considered the end of the line. Each Point may have its endcap settings adjusted independently.

  ## Index

  Constructors

  - `constructor`

  Methods

  - `getEndcapsInverted`
  - `getEndEndcapColor`
  - `getEndEndcapSize`
  - `getEndEndcapType`
  - `getP1`
  - `getP2`
  - `getStartEndcapColor`
  - `getStartEndcapSize`
  - `getStartEndcapType`
  - `getStrokeColor`
  - `getStrokeWidth`
  - `set`
  - `setEndcapsInverted`
  - `setEndcapType`
  - `setEndEndcapColor`
  - `setEndEndcapSize`
  - `setEndEndcapType`
  - `setP1`
  - `setP2`
  - `setStartEndcapColor`
  - `setStartEndcapSize`
  - `setStartEndcapType`
  - `setStrokeColor`
  - `setStrokeWidth`

## Constructors

`Markup.Shapes.Line.``constructor`()
  Line(p1: `Point2`, p2: `Point2`): `Line`

  Creates a new Line Shape

  Parameters

  > p1: `Point2`

  > > Optional first point on the line. If omitted, default value of (0,0) is used.

  > p2: `Point2`

  > > Optional second point on the line. If omitted, default value of (0,0) is used.

  Returns: `Line`

  > new Line object.

## Methods

`Markup.Shapes.Line.``getEndcapsInverted`()

  inherited

  getEndcapsInverted(): boolean

  Gets whether endcaps are inverted for this shape. The default value is false.

  Returns: boolean

  > value indicating whether endcaps are inverted

`Markup.Shapes.Line.``getEndEndcapColor`()

  inherited

  getEndEndcapColor(): `Color`

  Gets the color of the end endcap. Default value is black.

  Returns: `Color`

  > color for the end endcap.

`Markup.Shapes.Line.``getEndEndcapSize`()

  inherited

  getEndEndcapSize(): number

  Gets the size of the end endcap in pixels. Default value is 9.

  Returns: number

  > size of the end endcap.

`Markup.Shapes.Line.``getEndEndcapType`()

  inherited

  getEndEndcapType(): `EndcapType`

  Gets the end endcap type for this shape. The default value is none.

  Returns: `EndcapType`

  > the end endcap type

`Markup.Shapes.Line.``getP1`()
  getP1(): `Point2`

  Gets the first point of the line segment

  Returns: `Point2`

  > the first point of the line segment

`Markup.Shapes.Line.``getP2`()
  getP2(): `Point2`

  Gets the second point of the line segment

  Returns: `Point2`

  > the second point of the line segment

`Markup.Shapes.Line.``getStartEndcapColor`()

  inherited

  getStartEndcapColor(): `Color`

  Gets the color of the start endcap. Default value is black.

  Returns: `Color`

  > color for the start endcap.

`Markup.Shapes.Line.``getStartEndcapSize`()

  inherited

  getStartEndcapSize(): number

  Gets the size of the start endcap in pixels. Default value is 9.

  Returns: number

  > size of the start endcap.

`Markup.Shapes.Line.``getStartEndcapType`()

  inherited

  getStartEndcapType(): `EndcapType`

  Gets the start endcap type for this shape. The default Value is none.

  Returns: `EndcapType`

  > the start endcap type

`Markup.Shapes.Line.``getStrokeColor`()

  inherited

  getStrokeColor(): `Color`

  Gets the stroke color for this shape

  Returns: `Color`

  > the stroke color

`Markup.Shapes.Line.``getStrokeWidth`()

  inherited

  getStrokeWidth(): number

  Gets the stroke width for this shape in pixels

  Returns: number

  > the stroke width in pixels

`Markup.Shapes.Line.``set`()
  set(p1: `Point2`, p2: `Point2`): void

  Sets the points that define the line segment

  Parameters

  > p1: `Point2`

  > > first point of the line segment

  > p2: `Point2`

  > > second point of the line segment

  Returns: void

`Markup.Shapes.Line.``setEndcapsInverted`()

  inherited

  setEndcapsInverted(inverted: boolean): void

  Sets whether endcapsare inverted for this shape.

  Parameters

  > inverted: boolean

  > > value indicated whether endcaps should be inverted

  Returns: void

`Markup.Shapes.Line.``setEndcapType`()

  inherited

  setEndcapType(endcapType: `EndcapType`): void

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

  Parameters

  > endcapType: `EndcapType`

  > > the new endcap type

  Returns: void

`Markup.Shapes.Line.``setEndEndcapColor`()

  inherited

  setEndEndcapColor(color: `Color`): void

  Sets the color for the end endcap.

  Parameters

  > color: `Color`

  > > the end endcap color value.

  Returns: void

`Markup.Shapes.Line.``setEndEndcapSize`()

  inherited

  setEndEndcapSize(size: number): void

  Sets the size of the end endcap in pixels.

  Parameters

  > size: number

  > > the end endcap.

  Returns: void

`Markup.Shapes.Line.``setEndEndcapType`()

  inherited

  setEndEndcapType(endcapType: `EndcapType`): void

  Sets the end endcap type for this shape

  Parameters

  > endcapType: `EndcapType`

  > > the new endcap type

  Returns: void

`Markup.Shapes.Line.``setP1`()
  setP1(p1: `Point2`): void

  Sets the first point of the line segment

  Parameters

  > p1: `Point2`

  > > first point of the line segment

  Returns: void

`Markup.Shapes.Line.``setP2`()
  setP2(p2: `Point2`): void

  sets the first point of the line segment

  Parameters

  > p2: `Point2`

  > > second point of the line segment

  Returns: void

`Markup.Shapes.Line.``setStartEndcapColor`()

  inherited

  setStartEndcapColor(color: `Color`): void

  Sets the color for the start endcap.

  Parameters

  > color: `Color`

  > > the start endcap color value.

  Returns: void

`Markup.Shapes.Line.``setStartEndcapSize`()

  inherited

  setStartEndcapSize(size: number): void

  Sets the size of the start endcap in pixels.

  Parameters

  > size: number

  > > the start endcap.

  Returns: void

`Markup.Shapes.Line.``setStartEndcapType`()

  inherited

  setStartEndcapType(endcapType: `EndcapType`): void

  Sets the start endcap type for this shape

  Parameters

  > endcapType: `EndcapType`

  > > the new endcap type

  Returns: void

`Markup.Shapes.Line.``setStrokeColor`()

  inherited

  setStrokeColor(color: `Color`): void

  Sets the stroke color for this shape

  Parameters

  > color: `Color`

  > > the stroke color

  Returns: void

`Markup.Shapes.Line.``setStrokeWidth`()

  inherited

  setStrokeWidth(strokeWidth: number): void

  Sets the stroke width for this shape in pixels

  Parameters

  > strokeWidth: number

  > > the stroke width in pixels

  Returns: void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...