Version 3.17.2

APIs

  • Begin typing in the search box above to see results.
Show:

Path Class

Uses
Extends Shape
Module: graphics

The Path class creates a shape through the use of drawing methods. The Path class has the following drawing methods available:

Like other shapes, Path elements are created using the addShape method of the Graphic class. The method's cfg argument contains a type attribute. Assigning "path" or Y.Path to this attribute will create a Path instance. After instantiation, a series of drawing operations must be performed in order to render a shape. The below code instantiates a path element by defining the type attribute as "path":

 var myPath = myGraphic.addShape({
 type: "path",
 fill: {
 color: "#9aa"
 },
 stroke: {
 weight: 1,
 color: "#000"
 }
 });

Below a Path element with the same properties is instantiated by defining the type attribute with a class reference:

 var myPath = myGraphic.addShape({
 type: Y.Path,
 fill: {
 color: "#9aa"
 },
 stroke: {
 weight: 1,
 color: "#000"
 }
 });

After instantiation, a shape or segment needs to be drawn for an element to render. After all draw operations are performed, the end method will render the shape. The code below will draw a triangle:

 myPath.moveTo(35, 5);
 myPath.lineTo(65, 65);
 myPath.lineTo(5, 65);
 myPath.lineTo(35, 5);
 myPath.end();

Path has the following implementations based on browser capability.

It is not necessary to interact with these classes directly. Path will point to the appropriate implemention.

Constructor

Path

()

Methods

addClass

(
  • className
)

Add a class name to each node.

Parameters:

  • className String

    the class name to add to the node's class attribute

clear

() chainable

Clears the path.

closePath

() chainable

Ends a fill and stroke

compareTo

(
  • refNode
)
Boolean

Compares nodes to determine if they match. Node instances can be compared to each other and/or HTMLElements.

Parameters:

Returns:

Boolean :

True if the nodes match, false if they do not.

contains

(
  • needle
)

Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.

Parameters:

Returns:

Boolean Whether or not this shape is the needle or its ancestor.

curveTo

(
  • cp1x
  • cp1y
  • cp2x
  • cp2y
  • x
  • y
)
chainable

Draws a bezier curve.

Parameters:

  • cp1x Number

    x-coordinate for the first control point.

  • cp1y Number

    y-coordinate for the first control point.

  • cp2x Number

    x-coordinate for the second control point.

  • cp2y Number

    y-coordinate for the second control point.

  • x Number

    x-coordinate for the end point.

  • y Number

    y-coordinate for the end point.

destroy

()

Destroys the instance.

drawCircle

(
  • x
  • y
  • r
)
protected chainable

Draws a circle.

Parameters:

drawDiamond

(
  • x
  • y
  • width
  • height
)
protected chainable

Draws a diamond.

Parameters:

drawEllipse

(
  • x
  • y
  • w
  • h
)
protected chainable

Draws an ellipse.

Parameters:

drawRect

(
  • x
  • y
  • w
  • h
)
chainable

Draws a rectangle.

Parameters:

drawRoundRect

(
  • x
  • y
  • w
  • h
  • ew
  • eh
)
chainable

Draws a rectangle with rounded corners.

Parameters:

  • x Number

    x-coordinate

  • y Number

    y-coordinate

  • w Number

    width

  • h Number

    height

  • ew Number

    width of the ellipse used to draw the rounded corners

  • eh Number

    height of the ellipse used to draw the rounded corners

drawWedge

(
  • x
  • y
  • startAngle
  • arc
  • radius
  • yRadius
)
private chainable

Draws a wedge.

Parameters:

  • x Number

    x-coordinate of the wedge's center point

  • y Number

    y-coordinate of the wedge's center point

  • startAngle Number

    starting angle in degrees

  • arc Number

    sweep of the wedge. Negative values draw clockwise.

  • radius Number

    radius of wedge. If [optional] yRadius is defined, then radius is the x radius.

  • yRadius Number

    [optional] y radius for wedge.

end

() chainable

Completes a drawing operation.

getBounds

()

Returns the bounds for a shape.

Calculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix. The calculated bounding box is used by the graphic instance to calculate its viewBox.

Returns:

Object

getXY

()

Gets the current position of the node in page coordinates.

Returns:

Array The XY position of the shape.

init

() protected

Init method, invoked during construction. Calls initializer method.

initializer

() private

Initializes the shape

lineTo

(
  • point1
  • point2
)
chainable

Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.

Parameters:

  • point1 Number

    x-coordinate for the end point.

  • point2 Number

    y-coordinate for the end point.

moveTo

(
  • x
  • y
)
chainable

Moves the current drawing position to specified x and y coordinates.

Parameters:

  • x Number

    x-coordinate for the end point.

  • y Number

    y-coordinate for the end point.

quadraticCurveTo

(
  • cpx
  • cpy
  • x
  • y
)
chainable

Draws a quadratic bezier curve.

Parameters:

  • cpx Number

    x-coordinate for the control point.

  • cpy Number

    y-coordinate for the control point.

  • x Number

    x-coordinate for the end point.

  • y Number

    y-coordinate for the end point.

relativeLineTo

(
  • point1
  • point2
)
chainable

Draws a line segment using the current line style from the current drawing position to the relative x and y coordinates.

Parameters:

  • point1 Number

    x-coordinate for the end point.

  • point2 Number

    y-coordinate for the end point.

relativeMoveTo

(
  • x
  • y
)
chainable

Moves the current drawing position relative to specified x and y coordinates.

Parameters:

  • x Number

    x-coordinate for the end point.

  • y Number

    y-coordinate for the end point.

removeClass

(
  • className
)

Removes a class name from each node.

Parameters:

  • className String

    the class name to remove from the node's class attribute

rotate

(
  • deg
)

Rotates the shape clockwise around it transformOrigin.

Parameters:

  • deg Number

    The degree of the rotation.

scale

(
  • val
)

Specifies a 2d scaling operation.

Parameters:

set

(
  • name
  • value
)

Sets the value of an attribute.

Parameters:

  • name String | Object

    The name of the attribute. Alternatively, an object of key value pairs can be passed in to set multiple attributes at once.

  • value Any

    The value to set the attribute to. This value is ignored if an object is received as the name param.

setXY

(
  • Contains
)

Set the position of the shape in page coordinates, regardless of how the node is positioned.

Parameters:

  • Contains Array

    x & y values for new position (coordinates are page-based)

skew

(
  • x
  • y
)

Skews the shape around the x-axis and y-axis.

Parameters:

  • x Number

    The value to skew on the x-axis.

  • y Number

    The value to skew on the y-axis.

skewX

(
  • x
)

Skews the shape around the x-axis.

Parameters:

skewY

(
  • y
)

Skews the shape around the y-axis.

Parameters:

test

(
  • selector
)

Test if the supplied node matches the supplied selector.

Parameters:

  • selector String

    The CSS selector to test against.

Returns:

Boolean Wheter or not the shape matches the selector.

translate

(
  • x
  • y
)

Specifies a 2d translation.

Parameters:

  • x Number

    The value to transate on the x-axis.

  • y Number

    The value to translate on the y-axis.

translateX

(
  • x
)

Translates the shape along the x-axis. When translating x and y coordinates, use the translate method.

Parameters:

  • x Number

    The value to translate.

translateY

(
  • y
)

Translates the shape along the y-axis. When translating x and y coordinates, use the translate method.

Parameters:

  • y Number

    The value to translate.

Attributes

data

String

Represents an SVG Path string. This will be parsed and added to shape's API to represent the SVG data across all implementations. Note that when using VML or SVG implementations, part of this content will be added to the DOM using respective VML/SVG attributes. If your content comes from an untrusted source, you will need to ensure that no malicious code is included in that content.

fill

Object

Contains information about the fill of the shape.

color
The color of the fill.
opacity
Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.
type
Type of fill.
solid
Solid single color fill. (default)
linear
Linear gradient fill.
radial
Radial gradient fill.

If a linear or radial is specified as the fill type. The following additional property is used:

stops
An array of objects containing the following properties:
color
The color of the stop.
opacity
Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8
offset
Number between 0 and 1 indicating where the color stop is positioned.

Linear gradients also have the following property:

rotation
Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)

Radial gradients have the following additional properties:

r
Radius of the gradient circle.
fx
Focal point x-coordinate of the gradient.
fy
Focal point y-coordinate of the gradient.
cx

The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.

Note: Currently, this property is not implemented for corresponding CanvasShape and VMLShape classes which are used on Android or IE 6 - 8.

cy

The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.

Note: Currently, this property is not implemented for corresponding CanvasShape and VMLShape classes which are used on Android or IE 6 - 8.

graphic

Graphic readonly

Reference to the parent graphic instance

height

Number

Indicates the height of the shape

id

String

Unique id for class instance.

node

HTMLElement readonly

Dom node for the shape.

path

String readonly

Indicates the path used for the node.

stroke

Object

Contains information about the stroke of the shape.

color
The color of the stroke.
weight
Number that indicates the width of the stroke.
opacity
Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.
dashstyle
Indicates whether to draw a dashed stroke. When set to "none", a solid stroke is drawn. When set to an array, the first index indicates the length of the dash. The second index indicates the length of gap.
linecap
Specifies the linecap for the stroke. The following values can be specified:
butt (default)
Specifies a butt linecap.
square
Specifies a sqare linecap.
round
Specifies a round linecap.
linejoin
Specifies a linejoin for the stroke. The following values can be specified:
round (default)
Specifies that the linejoin will be round.
bevel
Specifies a bevel for the linejoin.
miter limit
An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having separate miter and miter limit values.

transform

String

A string containing, in order, transform operations applied to the shape instance. The transform string can contain the following values:

rotate
Rotates the shape clockwise around it transformOrigin.
translate
Specifies a 2d translation.
skew
Skews the shape around the x-axis and y-axis.
scale
Specifies a 2d scaling operation.
translateX
Translates the shape along the x-axis.
translateY
Translates the shape along the y-axis.
skewX
Skews the shape around the x-axis.
skewY
Skews the shape around the y-axis.
matrix
Specifies a 2D transformation matrix comprised of the specified six values.

Applying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform that will apply the transform to the current matrix. The below code illustrates how you might use the transform attribute to instantiate a recangle with a rotation of 45 degrees.

var myRect = new Y.Rect({ type:"rect", width: 50, height: 40, transform: "rotate(45)" };

The code below would apply translate and rotate to an existing shape.

 myRect.set("transform", "translate(40, 50) rotate(45)");

transformOrigin

Array

An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a fraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].

visible

Boolean

Indicates whether the shape is visible.

width

Number

Indicates the width of the shape

x

Number

Indicates the x position of shape.

y

Number

Indicates the y position of shape.

AltStyle によって変換されたページ (->オリジナル) /