Path

new Konva.Path(config)

Path constructor.

Parameters

Name	Type	Description
config	Object
data	String	SVG data string
fill (optional)	String	fill color
fillPatternImage (optional)	Image	fill pattern image
fillPatternX (optional)	Number
fillPatternY (optional)	Number
fillPatternOffset (optional)	Object	object with x and y component
fillPatternOffsetX (optional)	Number
fillPatternOffsetY (optional)	Number
fillPatternScale (optional)	Object	object with x and y component
fillPatternScaleX (optional)	Number
fillPatternScaleY (optional)	Number
fillPatternRotation (optional)	Number
fillPatternRepeat (optional)	String	can be "repeat", "repeat-x", "repeat-y", or "no-repeat". The default is "repeat"
fillLinearGradientStartPoint (optional)	Object	object with x and y component
fillLinearGradientStartPointX (optional)	Number
fillLinearGradientStartPointY (optional)	Number
fillLinearGradientEndPoint (optional)	Object	object with x and y component
fillLinearGradientEndPointX (optional)	Number
fillLinearGradientEndPointY (optional)	Number
fillLinearGradientColorStops (optional)	Array	array of color stops
fillRadialGradientStartPoint (optional)	Object	object with x and y component
fillRadialGradientStartPointX (optional)	Number
fillRadialGradientStartPointY (optional)	Number
fillRadialGradientEndPoint (optional)	Object	object with x and y component
fillRadialGradientEndPointX (optional)	Number
fillRadialGradientEndPointY (optional)	Number
fillRadialGradientStartRadius (optional)	Number
fillRadialGradientEndRadius (optional)	Number
fillRadialGradientColorStops (optional)	Array	array of color stops
fillEnabled (optional)	Boolean	flag which enables or disables the fill. The default value is true
fillPriority (optional)	String	can be color, linear-gradient, radial-gradient, or pattern. The default value is color. The fillPriority property makes it really easy to toggle between different fill types. For example, if you want to toggle between a fill color style and a fill pattern style, simply set the fill property and the fillPattern properties, and then use setFillPriority('color') to render the shape with a color fill, or use setFillPriority('pattern') to render the shape with the pattern fill configuration
stroke (optional)	String	stroke color
strokeWidth (optional)	Number	stroke width
fillAfterStrokeEnabled (optional)	Boolean	Should we draw fill AFTER stroke? Default is false.
hitStrokeWidth (optional)	Number|String	size of the stroke on hit canvas. The default is "auto" - equals to strokeWidth
strokeHitEnabled (optional)	Boolean	deprecated; use hitStrokeWidth instead. Enables or disables the stroke hit region. The default is true
perfectDrawEnabled (optional)	Boolean	flag which enables or disables using buffer canvas. The default is true
shadowForStrokeEnabled (optional)	Boolean	flag which enables or disables shadow for stroke. The default is true
strokeScaleEnabled (optional)	Boolean	flag which enables or disables stroke scale. The default is true
strokeEnabled (optional)	Boolean	flag which enables or disables the stroke. The default value is true
lineJoin (optional)	String	can be miter, round, or bevel. The default is miter
lineCap (optional)	String	can be butt, round, or square. The default is butt
shadowColor (optional)	String
shadowBlur (optional)	Number
shadowOffset (optional)	Object	object with x and y component
shadowOffsetX (optional)	Number
shadowOffsetY (optional)	Number
shadowOpacity (optional)	Number	shadow opacity. Can be any real number between 0 and 1
shadowEnabled (optional)	Boolean	flag which enables or disables the shadow. The default value is true
dash (optional)	Array
dashEnabled (optional)	Boolean	flag which enables or disables the dashArray. The default value is true
x (optional)	Number
y (optional)	Number
width (optional)	Number
height (optional)	Number
visible (optional)	Boolean
listening (optional)	Boolean	whether or not the node is listening for events
id (optional)	String	unique id
name (optional)	String	non-unique name
opacity (optional)	Number	determines node opacity. Can be any number between 0 and 1
scale (optional)	Object	set scale
scaleX (optional)	Number	set scale x
scaleY (optional)	Number	set scale y
rotation (optional)	Number	rotation in degrees
offset (optional)	Object	offset from center point and rotation point
offsetX (optional)	Number	set offset x
offsetY (optional)	Number	set offset y
draggable (optional)	Boolean	makes the node draggable. When stages are draggable, you can drag and drop the entire stage by dragging any portion of the stage
dragDistance (optional)	Number
dragBoundFunc (optional)	function

Inherited from: Konva.Shape

Own Methods

getLength()

Return length of the path.

Returns: Number length

Example:

var length = path.getLength();

getPointAtLength(length)

Get point on path at specific length of the path

Parameters:

• length (Number): length

Returns: Object point {x,y} point

Example:

var point = path.getPointAtLength(10);

_walkArc()

Walks an arc in one degree steps, accumulating its length. Returns the angle length along the arc, or its end angle and total length when length is past the end.

data(data)

get/set SVG path data string. This method also automatically parses the data string into a data array. Currently supported SVG data: M, m, L, l, H, h, V, v, Q, q, T, t, C, c, S, s, A, a, Z, z

Parameters:

• data (String): svg path string

Returns: String

Example:

// get data
var data = path.data();

// set data
path.data('M200,100h100v50z');

width()

get width of the path. It is computed from the path data and cannot be set

Returns: Number

Example:

var width = path.width();

height()

get height of the path. It is computed from the path data and cannot be set

Returns: Number

Example:

var height = path.height();

Inherited Methods

Konva.Path also has all methods of its parent classes. Each link below opens the full documentation of the method on the class that defines it.

From Konva.Shape

• getContext()
• getCanvas()
• hasShadow()
• hasFill()
• hasStroke()
• intersects(point)
• getSelfRect()
• drawHitFromCache(alphaThreshold)
• stroke(color)
• strokeWidth(strokeWidth)
• fillAfterStrokeEnabled(fillAfterStrokeEnabled)
• hitStrokeWidth(hitStrokeWidth)
• strokeHitEnabled(strokeHitEnabled)
• perfectDrawEnabled(perfectDrawEnabled)
• shadowForStrokeEnabled(shadowForStrokeEnabled)
• lineJoin(lineJoin)
• lineCap(lineCap)
• miterLimit(miterLimit)
• sceneFunc(drawFunc)
• hitFunc(drawFunc)
• selfRectFunc(selfRectFunc)
• dash(dash)
• shadowColor(color)
• shadowBlur(blur)
• shadowOpacity(opacity)
• shadowOffset(offset)
• shadowOffsetX(x)
• shadowOffsetY(y)
• fillPatternImage(image)
• fill(color)
• fillPatternX(x)
• fillPatternY(y)
• fillLinearGradientColorStops(colorStops)
• strokeLinearGradientColorStops(colorStops)
• fillRadialGradientStartRadius(radius)
• fillRadialGradientEndRadius(radius)
• fillRadialGradientColorStops(colorStops)
• fillPatternRepeat(repeat)
• fillEnabled(enabled)
• strokeEnabled(enabled)
• shadowEnabled(enabled)
• dashEnabled(enabled)
• strokeScaleEnabled(enabled)
• fillPriority(priority)
• fillPatternOffset(offset)
• fillPatternOffsetX(x)
• fillPatternOffsetY(y)
• fillPatternScale(scale)
• fillPatternScaleX(x)
• fillPatternScaleY(y)
• fillLinearGradientStartPoint(startPoint)
• strokeLinearGradientStartPoint(startPoint)
• fillLinearGradientStartPointX(x)
• strokeLinearGradientStartPointX(x)
• fillLinearGradientStartPointY(y)
• strokeLinearGradientStartPointY(y)
• fillLinearGradientEndPoint(endPoint)
• strokeLinearGradientEndPoint(endPoint)
• fillLinearGradientEndPointX(x)
• strokeLinearGradientEndPointX(x)
• fillLinearGradientEndPointY(y)
• strokeLinearGradientEndPointY(y)
• fillRadialGradientStartPoint(startPoint)
• fillRadialGradientStartPointX(x)
• fillRadialGradientStartPointY(y)
• fillRadialGradientEndPoint(endPoint)
• fillRadialGradientEndPointX(x)
• fillRadialGradientEndPointY(y)
• fillPatternRotation(rotation)
• fillRule(rotation)

From Konva.Node

• clearCache()
• cache(config)
• isCached()
• getClientRect(config)
• on(evtStr, handler)
• off(evtStr)
• remove()
• destroy()
• getAttr(attr)
• getAncestors()
• getAttrs()
• setAttrs(config)
• isListening()
• isVisible()
• show()
• hide()
• getAbsoluteZIndex()
• getDepth()
• getRelativePointerPosition()
• getAbsolutePosition(top)
• move(change)
• rotate(theta)
• moveToTop()
• moveUp()
• moveDown()
• moveToBottom()
• getAbsoluteOpacity()
• moveTo(newContainer)
• toObject()
• toJSON()
• getParent()
• findAncestors(selector, includeSelf, stopNode)
• findAncestor(selector, includeSelf, stopNode)
• getLayer()
• getStage()
• fire(eventType, evt, bubble)
• getAbsoluteTransform()
• getAbsoluteScale()
• getAbsoluteRotation()
• getTransform()
• clone(obj)
• toCanvas(config)
• toDataURL(config)
• toImage(config)
• toBlob(config)
• getClassName()
• getType()
• addName(name)
• hasName(name)
• removeName(name)
• setAttr(attr, val)
• draw()
• startDrag()
• stopDrag()
• isDragging()
• isClientRectOnScreen(margin)
• zIndex(index)
• absolutePosition(pos)
• position(pos)
• x(x)
• y(y)
• globalCompositeOperation(type)
• opacity(opacity)
• name(name)
• id(id)
• rotation(rotation)
• scale(scale)
• scaleX(x)
• scaleY(y)
• skew(skew)
• skewX(x)
• skewY(y)
• offsetX(x)
• offsetY(y)
• dragDistance(distance)
• listening(listening)
• preventDefault(preventDefault)
• filters(filters)
• visible(visible)
• transformsEnabled(enabled)
• size(size)
• dragBoundFunc(dragBoundFunc)
• draggable(draggable)
• to(params)
• blurRadius(radius)
• brightness(brightness)
• contrast(contrast)
• embossStrength(level)
• embossWhiteLevel(embossWhiteLevel)
• embossDirection(embossDirection)
• embossBlend(embossBlend)
• enhance(amount)
• hue(hue)
• saturation(saturation)
• luminance(value)
• value(value)
• kaleidoscopePower(power)
• kaleidoscopeAngle(degrees)
• noise(noise)
• pixelSize(pixelSize)
• levels(level)
• red(red)
• green(green)
• blue(blue)
• alpha(alpha)
• threshold(threshold)