Skip to content

@shbernal/pptxgenjs


@shbernal/pptxgenjs / index / ShapeLineProps

Interface: ShapeLineProps

Defined in: core-interfaces.ts:373

Line (stroke) options.

A stroke is painted like a fill: in addition to a solid color, it accepts the inherited gradient/pattern/image fill options (DrawingML allows the same fill group inside <a:ln>). Setting gradient (or type: 'gradient') paints a gradient stroke, e.g. line: { width: 1, gradient: { kind: 'linear', angle: 0, stops: [{ position: 0, color: 'accent3' }, { position: 100, color: 'accent4' }] } }.

Extends

Properties

alpha?

optional alpha?: number

Defined in: core-interfaces.ts:356

Transparency (percent)

Deprecated

v3.3.0 - use transparency

Inherited from

ShapeFillProps.alpha


beginArrowType?

optional beginArrowType?: "none" | "triangle" | "arrow" | "diamond" | "oval" | "stealth"

Defined in: core-interfaces.ts:393

Begin arrow type

Since

v3.3.0


cap?

optional cap?: LineCap

Defined in: core-interfaces.ts:388

Line end cap style

Default

ts
'flat'

color?

optional color?: string

Defined in: core-interfaces.ts:322

Fill color

  • HexColor or ThemeColor

Examples

ts
'FF0000' // hex color (red)
ts
pptx.SchemeColor.text1 // Theme color (Text1)

Inherited from

ShapeFillProps.color


dashType?

optional dashType?: "dash" | "solid" | "dashDot" | "lgDash" | "lgDashDot" | "lgDashDotDot" | "sysDash" | "sysDot"

Defined in: core-interfaces.ts:383

Dash type

Default

ts
'solid'

endArrowType?

optional endArrowType?: "none" | "triangle" | "arrow" | "diamond" | "oval" | "stealth"

Defined in: core-interfaces.ts:398

End arrow type

Since

v3.3.0


gradient?

optional gradient?: GradientFillProps

Defined in: core-interfaces.ts:339

Native PPTX gradient fill options.

Inherited from

ShapeFillProps.gradient


image?

optional image?: ImageFillProps

Defined in: core-interfaces.ts:350

Native PPTX picture fill options. Setting this (or type: 'image') fills the shape interior with a stretched bitmap instead of a color.

Inherited from

ShapeFillProps.image


lineDash?

optional lineDash?: "dash" | "solid" | "dashDot" | "lgDash" | "lgDashDot" | "lgDashDotDot" | "sysDash" | "sysDot"

Defined in: core-interfaces.ts:406

Dash type

Deprecated

v3.3.0 - use dashType


lineHead?

optional lineHead?: "none" | "triangle" | "arrow" | "diamond" | "oval" | "stealth"

Defined in: core-interfaces.ts:410

Deprecated

v3.3.0 - use beginArrowType


lineTail?

optional lineTail?: "none" | "triangle" | "arrow" | "diamond" | "oval" | "stealth"

Defined in: core-interfaces.ts:414

Deprecated

v3.3.0 - use endArrowType


pattern?

optional pattern?: PatternFillProps

Defined in: core-interfaces.ts:344

Native PPTX pattern fill options.

Inherited from

ShapeFillProps.pattern


pt?

optional pt?: number

Defined in: core-interfaces.ts:419

Line width (pt)

Deprecated

v3.3.0 - use width


size?

optional size?: number

Defined in: core-interfaces.ts:424

Line size (pt)

Deprecated

v3.3.0 - use width


transparency?

optional transparency?: number

Defined in: core-interfaces.ts:329

Transparency (percent)

  • MS-PPT > Format Shape > Fill & Line > Fill > Transparency
  • range: 0-100

Default

ts
0

Inherited from

ShapeFillProps.transparency


type?

optional type?: "none" | "image" | "pattern" | "solid" | "gradient"

Defined in: core-interfaces.ts:334

Fill type

Default

ts
'solid'

Inherited from

ShapeFillProps.type


width?

optional width?: number

Defined in: core-interfaces.ts:378

Line width (pt)

Default

ts
1