Interface LineStyle

Base interface for line styles.

For implementations with more detailed documentation, see:

Hierarchy

LineStyle

Implemented by

SolidLine

Index

Properties

Methods

getFillStyle getThickness setFillStyle setThickness

Properties

`Readonly` lineType

lineType: "empty" | "solid"

`Readonly` type

type: "linestyle"

Methods

getFillStyle

getFillStyle(): FillStyle
Get fill style of the LineStyle.

Returns
FillStyle object

Returns FillStyle

getThickness

getThickness(): number
Get thickness of the LineStyle

Returns
Thickness as pixels

Returns number

setFillStyle

setFillStyle(value: FillStyle | ImmutableMutator<FillStyle, FillStyle>): LineStyle
Construct a new LineStyle object based on this one, but with modified fill style.

Example (SolidFill):
```
// specify new fillstyle
solidLineStyle.setFillStyle( new SolidFill({
 color: ColorHex('#F00')
}) )
// change fillstyle properties
solidLineStyle.setFillStyle(
 solidfill => solidfill.setA( 80 )
)
```
Returns
New LineStyle object
Parameters
- value: FillStyle | ImmutableMutator<FillStyle, FillStyle>
  
  Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Returns LineStyle

setThickness

setThickness(thickness: number): LineStyle
Construct a new LineStyle object based on this one, but with modified thickness.

-1 can be used to signify smallest available thickness. With most features, this will result in slightly better GPU performance, but less detailed line.
Parameters
- thickness: number
  
  Thickness as pixels.
Returns LineStyle