The below list is a generic list of all members and methods in various classes..To know how to use it, clickhere
-
angle(angle)
-
get/set angle in degrees
Parameters:
Returns:
- Type
- Number
Example
// get angle
var angle = arc.angle();
// set angle
arc.angle(20);
-
blue(blue)
-
get/set filter blue value
Parameters:
blue |
Integer |
value between 0 and 255 |
Returns:
- Type
- Integer
-
blurRadius(radius)
-
get/set blur radius
Parameters:
Returns:
- Type
- Integer
-
cache(config)
-
cache node to improve drawing performance, apply filters, or create more accurate hit regions
Parameters:
config |
Object |
Properties
x |
Number |
<optional> |
|
y |
Number |
<optional> |
|
width |
Number |
<optional> |
|
height |
Number |
<optional> |
|
drawBorder |
Boolean |
<optional> |
when set to true, a red border will be drawn around the cached region for debugging purposes |
|
Returns:
- Type
- Kinetic.Node
Example
// cache a shape with the x,y position of the bounding box at the center and
// the width and height of the bounding box equal to the width and height of
// the shape obtained from shape.width() and shape.height()
image.cache();
// cache a node and define the bounding box position and size
node.cache({
x: -30,
y: -30,
width: 100,
height: 200
});
// cache a node and draw a red border around the bounding box
// for debugging purposes
node.cache({
x: -30,
y: -30,
width: 100,
height: 200,
drawBorder: true
});
-
clearCache()
-
clear cached canvas
Returns:
- Type
- Kinetic.Node
Example
node.clearCache();
-
clockwise(clockwise)
-
get/set clockwise flag
Parameters:
Returns:
- Type
- Boolean
Example
// get clockwise flag
var clockwise = arc.clockwise();
// draw arc counter-clockwise
arc.clockwise(false);
// draw arc clockwise
arc.clockwise(true);
-
clone(attrs)
-
clone node. Returns a new Node instance with identical attributes. You can also override the node properties with an object literal, enabling you to use an existing node as a template for another node
Parameters:
attrs |
Object |
override attrs |
Returns:
- Type
- Kinetic.Node
Example
// simple clone
var clone = node.clone();
// clone a node and override the x position
var clone = rect.clone({
x: 5
});
-
dash(dash)
-
get/set dash array for stroke.
Parameters:
Returns:
- Type
- Array
Example
// apply dashed stroke that is 10px long and 5 pixels apart
line.dash([10, 5]);
// apply dashed stroke that is made up of alternating dashed
// lines that are 10px long and 20px apart, and dots that have
// a radius of 5px and are 20px apart
line.dash([10, 20, 0.001, 20]);
-
dashEnabled(enabled)
-
get/set dash enabled flag
Parameters:
Returns:
- Type
- Boolean
Example
// get dash enabled flag
var dashEnabled = shape.dashEnabled();
// disable dash
shape.dashEnabled(false);
// enable dash
shape.dashEnabled(true);
-
destroy()
-
remove and destroy self
Example
node.destroy();
-
dragBoundFunc(dragBoundFunc)
-
get/set drag bound function. This is used to override the default drag and drop position
Parameters:
Returns:
- Type
- function
Example
// get drag bound function
var dragBoundFunc = node.dragBoundFunc();
// create vertical drag and drop
node.dragBoundFunc(function(){
return {
x: this.getAbsolutePosition().x,
y: pos.y
};
});
-
draggable(draggable)
-
get/set draggable flag
Parameters:
Returns:
- Type
- Boolean
Example
// get draggable flag
var draggable = node.draggable();
// enable drag and drop
node.draggable(true);
// disable drag and drop
node.draggable(false);
-
draw()
-
draw both scene and hit graphs. If the node being drawn is the stage, all of the layers will be cleared and redrawn
Returns:
- Type
- Kinetic.Node
-
drawHitFromCache(alphaThreshold)
-
draw hit graph using the cached scene canvas
Parameters:
alphaThreshold |
Integer |
alpha channel threshold that determines whether or not a pixel should be drawn onto the hit graph. Must be a value between 0 and 255. The default is 0 |
Returns:
- Type
- Kinetic.Shape
Example
shape.cache();
shape.drawHitFromCache();
-
embossBlend(embossBlend)
-
get/set emboss blend
Parameters:
Returns:
- Type
- Boolean
-
embossDirection(embossDirection)
-
get/set emboss direction
Parameters:
embossDirection |
String |
can be top-left, top, top-right, right, bottom-right, bottom, bottom-left or left The default is top-left |
Returns:
- Type
- String
-
embossStrength(level)
-
get/set emboss strength
Parameters:
level |
Number |
between 0 and 1. Default is 0.5 |
Returns:
- Type
- Number
-
embossWhiteLevel(embossWhiteLevel)
-
get/set emboss white level
Parameters:
embossWhiteLevel |
Number |
between 0 and 1. Default is 0.5 |
Returns:
- Type
- Number
-
enhance(amount)
-
get/set enhance
Parameters:
Returns:
- Type
- Float
-
fill(color)
-
get/set fill color
Parameters:
Returns:
- Type
- String
Example
// get fill color
var fill = shape.fill();
// set fill color with color string
shape.fill('green');
// set fill color with hex
shape.fill('#00ff00');
// set fill color with rgb
shape.fill('rgb(0,255,0)');
// set fill color with rgba and make it 50% opaque
shape.fill('rgba(0,255,0,0.5');
-
fillAlpha(alpha)
-
get/set fill alpha component. Alpha is a real number between 0 and 1. The default is 1.
Parameters:
Returns:
- Type
- Number
Example
// get fill alpha component
var fillAlpha = shape.fillAlpha();
// set fill alpha component
shape.fillAlpha(0.5);
-
fillBlue(blue)
-
get/set fill blue component
Parameters:
Returns:
- Type
- Integer
Example
// get fill blue component
var fillBlue = shape.fillBlue();
// set fill blue component
shape.fillBlue(0);
-
fillEnabled(enabled)
-
get/set fill enabled flag
Parameters:
Returns:
- Type
- Boolean
Example
// get fill enabled flag
var fillEnabled = shape.fillEnabled();
// disable fill
shape.fillEnabled(false);
// enable fill
shape.fillEnabled(true);
-
fillGreen(green)
-
get/set fill green component
Parameters:
Returns:
- Type
- Integer
Example
// get fill green component
var fillGreen = shape.fillGreen();
// set fill green component
shape.fillGreen(255);
-
fillLinearGradientColorStops(colorStops)
-
get/set fill linear gradient color stops
Parameters:
Returns:
colorStops
- Type
- Array
Example
// get fill linear gradient color stops
var colorStops = shape.fillLinearGradientColorStops();
// create a linear gradient that starts with red, changes to blue
// halfway through, and then changes to green
shape.fillLinearGradientColorStops(0, 'red', 0.5, 'blue', 1, 'green');
-
fillLinearGradientEndPoint(endPoint)
-
get/set fill linear gradient end point
Parameters:
endPoint |
Object |
Properties
|
Returns:
- Type
- Object
Example
// get fill linear gradient end point
var endPoint = shape.fillLinearGradientEndPoint();
// set fill linear gradient end point
shape.fillLinearGradientEndPoint({
x: 20
y: 10
});
-
fillLinearGradientEndPointX(x)
-
get/set fill linear gradient end point x
Parameters:
Returns:
- Type
- Number
Example
// get fill linear gradient end point x
var endPointX = shape.fillLinearGradientEndPointX();
// set fill linear gradient end point x
shape.fillLinearGradientEndPointX(20);
-
fillLinearGradientEndPointY(y)
-
get/set fill linear gradient end point y
Parameters:
Returns:
- Type
- Number
Example
// get fill linear gradient end point y
var endPointY = shape.fillLinearGradientEndPointY();
// set fill linear gradient end point y
shape.fillLinearGradientEndPointY(20);
-
fillLinearGradientStartPoint(startPoint)
-
get/set fill linear gradient start point
Parameters:
startPoint |
Object |
Properties
|
Returns:
- Type
- Object
Example
// get fill linear gradient start point
var startPoint = shape.fillLinearGradientStartPoint();
// set fill linear gradient start point
shape.fillLinearGradientStartPoint({
x: 20
y: 10
});
-
fillLinearGradientStartPointX(x)
-
get/set fill linear gradient start point x
Parameters:
Returns:
- Type
- Number
Example
// get fill linear gradient start point x
var startPointX = shape.fillLinearGradientStartPointX();
// set fill linear gradient start point x
shape.fillLinearGradientStartPointX(20);
-
fillLinearGradientStartPointY(y)
-
get/set fill linear gradient start point y
Parameters:
Returns:
- Type
- Number
Example
// get fill linear gradient start point y
var startPointY = shape.fillLinearGradientStartPointY();
// set fill linear gradient start point y
shape.fillLinearGradientStartPointY(20);
-
fillPatternImage(image)
-
get/set fill pattern image
Parameters:
Returns:
- Type
- Image
Example
// get fill pattern image
var fillPatternImage = shape.fillPatternImage();
// set fill pattern image
var imageObj = new Image();
imageObj.onload = function() {
shape.fillPatternImage(imageObj);
};
imageObj.src = 'path/to/image/jpg';
-
fillPatternOffset(offset)
-
get/set fill pattern offset
Parameters:
Returns:
- Type
- Object
Example
// get fill pattern offset
var patternOffset = shape.fillPatternOffset();
// set fill pattern offset
shape.fillPatternOffset({
x: 20
y: 10
});
-
fillPatternOffsetX(x)
-
get/set fill pattern offset x
Parameters:
Returns:
- Type
- Number
Example
// get fill pattern offset x
var patternOffsetX = shape.fillPatternOffsetX();
// set fill pattern offset x
shape.fillPatternOffsetX(20);
-
fillPatternOffsetY(y)
-
get/set fill pattern offset y
Parameters:
Returns:
- Type
- Number
Example
// get fill pattern offset y
var patternOffsetY = shape.fillPatternOffsetY();
// set fill pattern offset y
shape.fillPatternOffsetY(10);
-
fillPatternRepeat(repeat)
-
get/set fill pattern repeat. Can be ‘repeat’, ‘repeat-x’, ‘repeat-y’, or ‘no-repeat’. The default is ‘repeat’
Parameters:
Returns:
- Type
- String
Example
// get fill pattern repeat
var repeat = shape.fillPatternRepeat();
// repeat pattern in x direction only
shape.fillPatternRepeat('repeat-x');
// do not repeat the pattern
shape.fillPatternRepeat('no repeat');
-
fillPatternRotation(rotation)
-
get/set fill pattern rotation in degrees
Parameters:
Returns:
- Type
- Kinetic.Shape
Example
// get fill pattern rotation
var patternRotation = shape.fillPatternRotation();
// set fill pattern rotation
shape.fillPatternRotation(20);
-
fillPatternScale(scale)
-
get/set fill pattern scale
Parameters:
Returns:
- Type
- Object
Example
// get fill pattern scale
var patternScale = shape.fillPatternScale();
// set fill pattern scale
shape.fillPatternScale({
x: 2
y: 2
});
-
fillPatternScaleX(x)
-
get/set fill pattern scale x
Parameters:
Returns:
- Type
- Number
Example
// get fill pattern scale x
var patternScaleX = shape.fillPatternScaleX();
// set fill pattern scale x
shape.fillPatternScaleX(2);
-
fillPatternScaleY(y)
-
get/set fill pattern scale y
Parameters:
Returns:
- Type
- Number
Example
// get fill pattern scale y
var patternScaleY = shape.fillPatternScaleY();
// set fill pattern scale y
shape.fillPatternScaleY(2);
-
fillPatternX(x)
-
get/set fill pattern x
Parameters:
Returns:
- Type
- Number
Example
// get fill pattern x
var fillPatternX = shape.fillPatternX();
// set fill pattern x
shape.fillPatternX(20);
-
fillPatternY(y)
-
get/set fill pattern y
Parameters:
Returns:
- Type
- Number
Example
// get fill pattern y
var fillPatternY = shape.fillPatternY();
// set fill pattern y
shape.fillPatternY(20);
-
fillPriority(priority)
-
get/set fill priority. can be color, pattern, linear-gradient, or radial-gradient. The default is color. This is handy if you want to toggle between different fill types.
Parameters:
Returns:
- Type
- String
Example
// get fill priority
var fillPriority = shape.fillPriority();
// set fill priority
shape.fillPriority('linear-gradient');
-
fillRadialGradientColorStops(colorStops)
-
get/set fill radial gradient color stops
Parameters:
Returns:
- Type
- Array
Example
// get fill radial gradient color stops
var colorStops = shape.fillRadialGradientColorStops();
// create a radial gradient that starts with red, changes to blue
// halfway through, and then changes to green
shape.fillRadialGradientColorStops(0, 'red', 0.5, 'blue', 1, 'green');
-
fillRadialGradientEndPoint(endPoint)
-
get/set fill radial gradient end point
Parameters:
endPoint |
Object |
Properties
|
Returns:
- Type
- Object
Example
// get fill radial gradient end point
var endPoint = shape.fillRadialGradientEndPoint();
// set fill radial gradient end point
shape.fillRadialGradientEndPoint({
x: 20
y: 10
});
-
fillRadialGradientEndPointX(x)
-
get/set fill radial gradient end point x
Parameters:
Returns:
- Type
- Number
Example
// get fill radial gradient end point x
var endPointX = shape.fillRadialGradientEndPointX();
// set fill radial gradient end point x
shape.fillRadialGradientEndPointX(20);
-
fillRadialGradientEndPointY(y)
-
get/set fill radial gradient end point y
Parameters:
Returns:
- Type
- Number
Example
// get fill radial gradient end point y
var endPointY = shape.fillRadialGradientEndPointY();
// set fill radial gradient end point y
shape.fillRadialGradientEndPointY(20);
-
fillRadialGradientEndRadius(radius)
-
get/set fill radial gradient end radius
Parameters:
Returns:
- Type
- Number
Example
// get radial gradient end radius
var endRadius = shape.fillRadialGradientEndRadius();
// set radial gradient end radius
shape.fillRadialGradientEndRadius(100);
-
fillRadialGradientStartPoint(startPoint)
-
get/set fill radial gradient start point
Parameters:
startPoint |
Object |
Properties
|
Returns:
- Type
- Object
Example
// get fill radial gradient start point
var startPoint = shape.fillRadialGradientStartPoint();
// set fill radial gradient start point
shape.fillRadialGradientStartPoint({
x: 20
y: 10
});
-
fillRadialGradientStartPointX(x)
-
get/set fill radial gradient start point x
Parameters:
Returns:
- Type
- Number
Example
// get fill radial gradient start point x
var startPointX = shape.fillRadialGradientStartPointX();
// set fill radial gradient start point x
shape.fillRadialGradientStartPointX(20);
-
fillRadialGradientStartPointY(y)
-
get/set fill radial gradient start point y
Parameters:
Returns:
- Type
- Number
Example
// get fill radial gradient start point y
var startPointY = shape.fillRadialGradientStartPointY();
// set fill radial gradient start point y
shape.fillRadialGradientStartPointY(20);
-
fillRadialGradientStartRadius(radius)
-
get/set fill radial gradient start radius
Parameters:
Returns:
- Type
- Number
Example
// get radial gradient start radius
var startRadius = shape.fillRadialGradientStartRadius();
// set radial gradient start radius
shape.fillRadialGradientStartRadius(0);
-
fillRed(red)
-
get/set fill red component
Parameters:
Returns:
- Type
- Integer
Example
// get fill red component
var fillRed = shape.fillRed();
// set fill red component
shape.fillRed(0);
-
filters(filters)
-
get/set filters. Filters are applied to cached canvases
Parameters:
filters |
Array |
array of filters |
Returns:
- Type
- Array
Example
// get filters
var filters = node.filters();
// set a single filter
node.cache();
node.filters([Kinetic.Filters.Blur]);
// set multiple filters
node.cache();
node.filters([
Kinetic.Filters.Blur,
Kinetic.Filters.Sepia,
Kinetic.Filters.Invert
]);
-
fire(eventType, evt, bubble)
-
fire event
Parameters:
eventType |
String |
|
event type. can be a regular event, like click, mouseover, or mouseout, or it can be a custom event, like myCustomEvent |
evt |
EventObject |
<optional> |
event object |
bubble |
Boolean |
<optional> |
setting the value to false, or leaving it undefined, will result in the event not bubbling. Setting the value to true will result in the event bubbling. |
Returns:
- Type
- Kinetic.Node
Example
// manually fire click event
node.fire('click');
// fire custom event
node.fire('foo');
// fire custom event with custom event object
node.fire('foo', {
bar: 10
});
// fire click event that bubbles
node.fire('click', null, true);
-
getAbsoluteOpacity()
-
get absolute opacity
Returns:
- Type
- Number
-
getAbsolutePosition()
-
get absolute position relative to the top left corner of the stage container div
Returns:
- Type
- Object
-
-
get absolute transform of the node which takes into account its ancestor transforms
Returns:
- Type
- Kinetic.Transform
-
getAbsoluteZIndex()
-
get absolute z-index which takes into account sibling and ancestor indices
Returns:
- Type
- Integer
-
getAncestors()
-
get ancestors
Returns:
- Type
- Kinetic.Collection
Example
shape.getAncestors().each(function(node) {
console.log(node.getId());
})
-
getAttr(attr)
-
get attr
Parameters:
Returns:
- Type
- Integer | String | Object | Array
Example
var x = node.getAttr('x');
-
getAttrs()
-
get attrs object literal
Returns:
- Type
- Object
-
getCanvas()
-
get canvas renderer tied to the layer. Note that this returns a canvas renderer, not a canvas element
Returns:
- Type
- Kinetic.Canvas
-
getClassName()
-
get class name, which may return Stage, Layer, Group, or shape class names like Rect, Circle, Text, etc.
Returns:
- Type
- String
-
getContext()
-
get canvas context tied to the layer
Returns:
- Type
- Kinetic.Context
-
getDepth()
-
get node depth in node tree. Returns an integer. e.g. Stage depth will always be 0. Layers will always be 1. Groups and Shapes will always be >= 2
Returns:
- Type
- Integer
-
getHeight()
-
get height
Returns:
- Type
- Integer
-
getLayer()
-
get layer ancestor
Returns:
- Type
- Kinetic.Layer
-
getParent()
-
get parent container
Returns:
- Type
- Kinetic.Node
-
getStage()
-
get stage ancestor
Returns:
- Type
- Kinetic.Stage
-
-
get transform of the node
Returns:
- Type
- Kinetic.Transform
-
getType()
-
get the node type, which may return Stage, Layer, Group, or Node
Returns:
- Type
- String
-
getWidth()
-
get width
Returns:
- Type
- Integer
-
getZIndex()
-
get zIndex relative to the node’s siblings who share the same parent
Returns:
- Type
- Integer
-
green(green)
-
get/set filter green value
Parameters:
green |
Integer |
value between 0 and 255 |
Returns:
- Type
- Integer
-
hasFill()
-
returns whether or not the shape will be filled
Returns:
- Type
- Boolean
-
hasShadow()
-
returns whether or not a shadow will be rendered
Returns:
- Type
- Boolean
-
hasStroke()
-
returns whether or not the shape will be stroked
Returns:
- Type
- Boolean
-
height(height)
-
get/set height
Parameters:
Returns:
- Type
- Number
Example
// get height
var height = node.height();
// set height
node.height(100);
-
hide()
-
hide node. Hidden nodes are no longer detectable
Returns:
- Type
- Kinetic.Node
-
hitFunc(drawFunc)
-
get/set hit draw function
Parameters:
drawFunc |
function |
drawing function |
Returns:
- Type
- function
Example
// get hit draw function
var hitFunc = shape.hitFunc();
// set hit draw function
shape.hitFunc(function(context) {
context.beginPath();
context.rect(0, 0, this.width(), this.height());
context.closePath();
context.fillStrokeShape(this);
});
-
hue(hue)
-
get/set hsv hue in degrees
Parameters:
hue |
Number |
value between 0 and 359 |
Returns:
- Type
- Number
-
hue(hue)
-
get/set hsv hue in degrees
Parameters:
hue |
Number |
value between 0 and 359 |
Returns:
- Type
- Number
-
id(id)
-
get/set id
Parameters:
Returns:
- Type
- String
Example
// get id
var name = node.id();
// set id
node.id('foo');
-
innerRadius(innerRadius)
-
get/set innerRadius
Parameters:
Returns:
- Type
- Number
Example
// get inner radius
var innerRadius = arc.innerRadius();
// set inner radius
arc.innerRadius(20);
-
intersects(point)
-
determines if point is in the shape, regardless if other shapes are on top of it. Note: because this method clears a temporary canvas and then redraws the shape, it performs very poorly if executed many times consecutively. Please use the
Kinetic.Stage#getIntersection method if at all possible because it performs much better
Parameters:
Returns:
- Type
- Boolean
-
isDragging()
-
determine if node is currently in drag and drop mode
-
isListening()
-
determine if node is listening for events by taking into account ancestors. Parent | Self | isListening listening | listening | ———-+———–+———— T | T | T T | F | F F | T | T F | F | F ———-+———–+———— T | I | T F | I | F I | I | T
Returns:
- Type
- Boolean
-
isVisible()
-
determine if node is visible by taking into account ancestors. Parent | Self | isVisible visible | visible | ———-+———–+———— T | T | T T | F | F F | T | T F | F | F ———-+———–+———— T | I | T F | I | F I | I | T
Returns:
- Type
- Boolean
-
kaleidoscopeAngle(degrees)
-
get/set kaleidoscope angle
Parameters:
Returns:
- Type
- Integer
-
kaleidoscopePower(power)
-
get/set kaleidoscope power
Parameters:
power |
Integer |
of kaleidoscope |
Returns:
- Type
- Integer
-
levels(level)
-
get/set levels. Must be a number between 0 and 1
Parameters:
level |
Number |
between 0 and 1 |
Returns:
- Type
- Number
-
lineCap(lineCap)
-
get/set line cap. Can be butt, round, or square
Parameters:
Returns:
- Type
- String
Example
// get line cap
var lineCap = shape.lineCap();
// set line cap
shape.lineCap('round');
-
lineJoin(lineJoin)
-
get/set line join. Can be miter, round, or bevel. The default is miter
Parameters:
Returns:
- Type
- String
Example
// get line join
var lineJoin = shape.lineJoin();
// set line join
shape.lineJoin('round');
-
listening(listening)
-
get/set listenig attr. If you need to determine if a node is listening or not by taking into account its parents, use the isListening() method
Parameters:
listening |
Boolean | String |
Can be “inherit”, true, or false. The default is “inherit”. |
Returns:
- Type
- Boolean | String
Example
// get listening attr
var listening = node.listening();
// stop listening for events
node.listening(false);
// listen for events
node.listening(true);
// listen to events according to the parent
node.listening('inherit');
-
move(change)
-
move node by an amount relative to its current position
Parameters:
Returns:
- Type
- Kinetic.Node
Example
// move node in x direction by 1px and y direction by 2px
node.move({
x: 1,
y: 2)
});
-
moveDown()
-
move node down
Returns:
- Type
- Boolean
-
moveTo(newContainer)
-
move node to another container
Parameters:
Returns:
- Type
- Kinetic.Node
Example
// move node from current layer into layer2
node.moveTo(layer2);
-
moveToBottom()
-
move node to the bottom of its siblings
Returns:
- Type
- Boolean
-
moveToTop()
-
move node to the top of its siblings
Returns:
- Type
- Boolean
-
moveUp()
-
move node up
Returns:
- Type
- Boolean
-
name(name)
-
get/set name
Parameters:
Returns:
- Type
- String
Example
// get name
var name = node.name();
// set name
node.name('foo');
-
noise(noise)
-
get/set noise amount. Must be a value between 0 and 1
Parameters:
Returns:
- Type
- Number
-
off(evtStr)
-
remove event bindings from the node. Pass in a string of event types delimmited by a space to remove multiple event bindings at once such as ‘mousedown mouseup mousemove’. include a namespace to remove an event binding by name such as ‘click.foobar’. If you only give a name like ‘.foobar’, all events in that namespace will be removed.
Parameters:
evtStr |
String |
e.g. ‘click’, ‘mousedown touchstart’, ‘.foobar’ |
Returns:
- Type
- Kinetic.Node
Example
// remove listener
node.off('click');
// remove multiple listeners
node.off('click touchstart');
// remove listener by name
node.off('click.foo');
-
offsetY(y)
-
get/set offset y
Parameters:
Returns:
- Type
- Number
Example
// get offset y
var offsetY = node.offsetY();
// set offset y
node.offsetY(3);
-
on(evtStr, handler)
-
bind events to the node. KineticJS supports mouseover, mousemove, mouseout, mouseenter, mouseleave, mousedown, mouseup, click, dblclick, touchstart, touchmove, touchend, tap, dbltap, dragstart, dragmove, and dragend events. The Kinetic Stage supports contentMouseover, contentMousemove, contentMouseout, contentMousedown, contentMouseup, contentClick, contentDblclick, contentTouchstart, contentTouchmove, contentTouchend, contentTap, and contentDblTap. Pass in a string of events delimmited by a space to bind multiple events at once such as ‘mousedown mouseup mousemove’. Include a namespace to bind an event by name such as ‘click.foobar’.
Parameters:
evtStr |
String |
e.g. ‘click’, ‘mousedown touchstart’, ‘mousedown.foo touchstart.foo’ |
handler |
function |
The handler function is passed an event object |
Returns:
- Type
- Kinetic.Node
Example
// add click listener
node.on('click', function() {
console.log('you clicked me!');
});
// get the target node
node.on('click', function(evt) {
console.log(evt.target);
});
// stop event propagation
node.on('click', function(evt) {
evt.cancelBubble = true;
});
// bind multiple listeners
node.on('click touchstart', function() {
console.log('you clicked/touched me!');
});
// namespace listener
node.on('click.foo', function() {
console.log('you clicked/touched me!');
});
// get the event type
node.on('click tap', function(evt) {
var eventType = evt.type;
});
// get native event object
node.on('click tap', function(evt) {
var nativeEvent = evt.evt;
});
// for change events, get the old and new val
node.on('xChange', function(evt) {
var oldVal = evt.oldVal;
var newVal = evt.newVal;
});
-
opacity(opacity)
-
get/set opacity. Opacity values range from 0 to 1. A node with an opacity of 0 is fully transparent, and a node with an opacity of 1 is fully opaque
Parameters:
Returns:
- Type
- Number
Example
// get opacity
var opacity = node.opacity();
// set opacity
node.opacity(0.5);
-
outerRadius(outerRadius)
-
get/set outerRadius
Parameters:
Returns:
- Type
- Number
Example
// get outer radius
var outerRadius = arc.outerRadius();
// set outer radius
arc.outerRadius(20);
-
pixelSize(pixelSize)
-
get/set pixel size
Parameters:
Returns:
- Type
- Integer
-
position(pos)
-
get/set node position relative to parent
Parameters:
Returns:
- Type
- Object
Example
// get position
var position = node.position();
// set position
node.position({
x: 5
y: 10
});
-
red(red)
-
get/set filter red value
Parameters:
red |
Integer |
value between 0 and 255 |
Returns:
- Type
- Integer
-
remove()
-
remove self from parent, but don’t destroy
Returns:
- Type
- Kinetic.Node
Example
node.remove();
-
rotate(theta)
-
rotate node by an amount in degrees relative to its current rotation
Parameters:
Returns:
- Type
- Kinetic.Node
-
rotation(rotation)
-
get/set rotation in degrees
Parameters:
Returns:
- Type
- Number
Example
// get rotation in degrees
var rotation = node.rotation();
// set rotation in degrees
node.rotation(45);
-
saturation(saturation)
-
get/set hsv saturation
Parameters:
saturation |
Number |
0 is no change, -1.0 halves the saturation, 1.0 doubles, etc.. |
Returns:
- Type
- Number
-
saturation(saturation)
-
get/set hsv saturation
Parameters:
saturation |
Number |
0 is no change, -1.0 halves the saturation, 1.0 doubles, etc.. |
Returns:
- Type
- Number
-
scale(scale)
-
get/set scale
Parameters:
Returns:
- Type
- Object
Example
// get scale
var scale = node.scale();
// set scale
shape.scale({
x: 2
y: 3
});
-
scaleX(x)
-
get/set scale x
Parameters:
Returns:
- Type
- Number
Example
// get scale x
var scaleX = node.scaleX();
// set scale x
node.scaleX(2);
-
scaleY(y)
-
get/set scale y
Parameters:
Returns:
- Type
- Number
Example
// get scale y
var scaleY = node.scaleY();
// set scale y
node.scaleY(2);
-
sceneFunc(drawFunc)
-
get/set scene draw function
Parameters:
drawFunc |
function |
drawing function |
Returns:
- Type
- function
Example
// get scene draw function
var sceneFunc = shape.sceneFunc();
// set scene draw function
shape.sceneFunc(function(context) {
context.beginPath();
context.rect(0, 0, this.width(), this.height());
context.closePath();
context.fillStrokeShape(this);
});
-
setAbsolutePosition(pos)
-
set absolute position
Parameters:
Returns:
- Type
- Kinetic.Node
-
setAttr(attr, val)
-
set attr
Parameters:
Returns:
- Type
- Kinetic.Node
Example
node.setAttr('x', 5);
-
setAttrs(config)
-
set multiple attrs at once using an object literal
Parameters:
config |
Object |
object containing key value pairs |
Returns:
- Type
- Kinetic.Node
Example
node.setAttrs({
x: 5,
fill: 'red'
});
-
setId(id)
-
set id
Parameters:
Returns:
- Type
- Kinetic.Node
-
setZIndex(zIndex)
-
set zIndex relative to siblings
Parameters:
Returns:
- Type
- Kinetic.Node
-
shadowAlpha(alpha)
-
get/set shadow alpha component. Alpha is a real number between 0 and 1. The default is 1.
Parameters:
Returns:
- Type
- Number
Example
// get shadow alpha component
var shadowAlpha = shape.shadowAlpha();
// set shadow alpha component
shape.shadowAlpha(0.5);
-
shadowBlue(blue)
-
get/set shadow blue component
Parameters:
Returns:
- Type
- Integer
Example
// get shadow blue component
var shadowBlue = shape.shadowBlue();
// set shadow blue component
shape.shadowBlue(0);
-
shadowBlur(blur)
-
get/set shadow blur
Parameters:
Returns:
- Type
- Number
Example
// get shadow blur
var shadowBlur = shape.shadowBlur();
// set shadow blur
shape.shadowBlur(10);
-
shadowColor(color)
-
get/set shadow color
Parameters:
Returns:
- Type
- String
Example
// get shadow color
var shadow = shape.shadowColor();
// set shadow color with color string
shape.shadowColor('green');
// set shadow color with hex
shape.shadowColor('#00ff00');
// set shadow color with rgb
shape.shadowColor('rgb(0,255,0)');
// set shadow color with rgba and make it 50% opaque
shape.shadowColor('rgba(0,255,0,0.5');
-
shadowEnabled(enabled)
-
get/set shadow enabled flag
Parameters:
Returns:
- Type
- Boolean
Example
// get shadow enabled flag
var shadowEnabled = shape.shadowEnabled();
// disable shadow
shape.shadowEnabled(false);
// enable shadow
shape.shadowEnabled(true);
-
shadowGreen(green)
-
get/set shadow green component
Parameters:
Returns:
- Type
- Integer
Example
// get shadow green component
var shadowGreen = shape.shadowGreen();
// set shadow green component
shape.shadowGreen(255);
-
shadowOffset(offset)
-
get/set shadow offset
Parameters:
Returns:
- Type
- Object
Example
// get shadow offset
var shadowOffset = shape.shadowOffset();
// set shadow offset
shape.shadowOffset({
x: 20
y: 10
});
-
shadowOffsetX(x)
-
get/set shadow offset x
Parameters:
Returns:
- Type
- Number
Example
// get shadow offset x
var shadowOffsetX = shape.shadowOffsetX();
// set shadow offset x
shape.shadowOffsetX(5);
-
shadowOffsetY(y)
-
get/set shadow offset y
Parameters:
Returns:
- Type
- Number
Example
// get shadow offset y
var shadowOffsetY = shape.shadowOffsetY();
// set shadow offset y
shape.shadowOffsetY(5);
-
shadowOpacity(opacity)
-
get/set shadow opacity. must be a value between 0 and 1
Parameters:
Returns:
- Type
- Number
Example
// get shadow opacity
var shadowOpacity = shape.shadowOpacity();
// set shadow opacity
shape.shadowOpacity(0.5);
-
shadowRed(red)
-
get/set shadow red component
Parameters:
Returns:
- Type
- Integer
Example
// get shadow red component
var shadowRed = shape.shadowRed();
// set shadow red component
shape.shadowRed(0);
-
shouldDrawHit()
-
determine if listening is enabled by taking into account descendants. If self or any children have _isListeningEnabled set to true, then self also has listening enabled.
Returns:
- Type
- Boolean
-
show()
-
show node
Returns:
- Type
- Kinetic.Node
-
size(size)
-
get/set node size
Parameters:
size |
Object |
Properties
width |
Number |
|
height |
Number |
|
|
Returns:
- Type
- Object
Example
// get node size
var size = node.size();
var x = size.x;
var y = size.y;
// set size
node.size({
width: 100,
height: 200
});
-
skew(skew)
-
get/set skew
Parameters:
Returns:
- Type
- Object
Example
// get skew
var skew = node.skew();
// set skew
node.skew({
x: 20
y: 10
});
-
skewX(x)
-
get/set skew x
Parameters:
Returns:
- Type
- Number
Example
// get skew x
var skewX = node.skewX();
// set skew x
node.skewX(3);
-
skewY(y)
-
get/set skew y
Parameters:
Returns:
- Type
- Number
Example
// get skew y
var skewY = node.skewY();
// set skew y
node.skewY(3);
-
startDrag()
-
initiate drag and drop
-
stopDrag()
-
stop drag and drop
-
stroke(color)
-
get/set stroke color
Parameters:
Returns:
- Type
- String
Example
// get stroke color
var stroke = shape.stroke();
// set stroke color with color string
shape.stroke('green');
// set stroke color with hex
shape.stroke('#00ff00');
// set stroke color with rgb
shape.stroke('rgb(0,255,0)');
// set stroke color with rgba and make it 50% opaque
shape.stroke('rgba(0,255,0,0.5');
-
strokeAlpha(alpha)
-
get/set stroke alpha component. Alpha is a real number between 0 and 1. The default is 1.
Parameters:
Returns:
- Type
- Number
Example
// get stroke alpha component
var strokeAlpha = shape.strokeAlpha();
// set stroke alpha component
shape.strokeAlpha(0.5);
-
strokeBlue(blue)
-
get/set stroke blue component
Parameters:
Returns:
- Type
- Integer
Example
// get stroke blue component
var strokeBlue = shape.strokeBlue();
// set stroke blue component
shape.strokeBlue(0);
-
strokeEnabled(enabled)
-
get/set stroke enabled flag
Parameters:
Returns:
- Type
- Boolean
Example
// get stroke enabled flag
var strokeEnabled = shape.strokeEnabled();
// disable stroke
shape.strokeEnabled(false);
// enable stroke
shape.strokeEnabled(true);
-
strokeGreen(green)
-
get/set stroke green component
Parameters:
Returns:
- Type
- Integer
Example
// get stroke green component
var strokeGreen = shape.strokeGreen();
// set stroke green component
shape.strokeGreen(255);
-
strokeRed(red)
-
get/set stroke red component
Parameters:
Returns:
- Type
- Integer
Example
// get stroke red component
var strokeRed = shape.strokeRed();
// set stroke red component
shape.strokeRed(0);
-
strokeScaleEnabled(enabled)
-
get/set strokeScale enabled flag
Parameters:
Returns:
- Type
- Boolean
Example
// get stroke scale enabled flag
var strokeScaleEnabled = shape.strokeScaleEnabled();
// disable stroke scale
shape.strokeScaleEnabled(false);
// enable stroke scale
shape.strokeScaleEnabled(true);
-
strokeWidth(strokeWidth)
-
get/set stroke width
Parameters:
Returns:
- Type
- Number
Example
// get stroke width
var strokeWidth = shape.strokeWidth();
// set stroke width
shape.strokeWidth();
-
threshold(threshold)
-
get/set threshold. Must be a value between 0 and 1
Parameters:
Returns:
- Type
- Number
-
toDataURL(config)
-
Creates a composite data URL. If MIME type is not specified, then “image/png” will result. For “image/jpeg”, specify a quality level as quality (range 0.0 – 1.0)
Parameters:
config |
Object |
Properties
mimeType |
String |
<optional> |
can be “image/png” or “image/jpeg”. “image/png” is the default |
x |
Number |
<optional> |
x position of canvas section |
y |
Number |
<optional> |
y position of canvas section |
width |
Number |
<optional> |
width of canvas section |
height |
Number |
<optional> |
height of canvas section |
quality |
Number |
<optional> |
jpeg quality. If using an “image/jpeg” mimeType, you can specify the quality from 0 to 1, where 0 is very poor quality and 1 is very high quality |
|
Returns:
- Type
- String
-
toImage(config)
-
converts node into an image. Since the toImage method is asynchronous, a callback is required. toImage is most commonly used to cache complex drawings as an image so that they don’t have to constantly be redrawn
Parameters:
config |
Object |
Properties
callback |
function |
|
function executed when the composite has completed |
mimeType |
String |
<optional> |
can be “image/png” or “image/jpeg”. “image/png” is the default |
x |
Number |
<optional> |
x position of canvas section |
y |
Number |
<optional> |
y position of canvas section |
width |
Number |
<optional> |
width of canvas section |
height |
Number |
<optional> |
height of canvas section |
quality |
Number |
<optional> |
jpeg quality. If using an “image/jpeg” mimeType, you can specify the quality from 0 to 1, where 0 is very poor quality and 1 is very high quality |
|
Example
var image = node.toImage({
callback: function(img) {
// do stuff with img
}
});
-
toJSON()
-
convert Node into a JSON string. Returns a JSON string.
Returns:
}
- Type
- String
-
toObject()
-
convert Node into an object for serialization. Returns an object.
Returns:
- Type
- Object
-
-
get/set transforms that are enabled. Can be “all”, “none”, or “position”. The default is “all”
Parameters:
Returns:
- Type
- String
Example
// enable position transform only to improve draw performance
node.transformsEnabled('position');
// enable all transforms
node.transformsEnabled('all');
-
value(value)
-
get/set hsv value
Parameters:
value |
Number |
0 is no change, -1.0 halves the value, 1.0 doubles, etc.. |
Returns:
- Type
- Number
-
value(value)
-
get/set hsl luminance
Parameters:
value |
Number |
0 is no change, -1.0 halves the value, 1.0 doubles, etc.. |
Returns:
- Type
- Number
-
visible(visible)
-
get/set visible attr. Can be “inherit”, true, or false. The default is “inherit”. If you need to determine if a node is visible or not by taking into account its parents, use the isVisible() method
Parameters:
Returns:
- Type
- Boolean | String
Example
// get visible attr
var visible = node.visible();
// make invisible
node.visible(false);
// make visible
node.visible(true);
// make visible according to the parent
node.visible('inherit');
-
width(width)
-
get/set width
Parameters:
Returns:
- Type
- Number
Example
// get width
var width = node.width();
// set width
node.width(100);
-
x(x)
-
get/set x position
Parameters:
Returns:
- Type
- Object
Example
// get x
var x = node.x();
// set x
node.x(5);
-
y(y)
-
get/set y position
Parameters:
Returns:
- Type
- Integer
Example
// get y
var y = node.y();
// set y
node.y(5);