Class Index | File Index

Classes


Class JXG.Point


Extends JXG.GeometryElement.
Creates a new point object. Do not use this constructor to create a point. Use JXG.Board#create with type Point, Glider, or Intersection instead.
Defined in: Point.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
JXG.Point(board, coordinates, attributes)
A point is the basic geometric element.
Field Summary
Field Attributes Field Name and Description
 
If the distance of the point to one of its attractors is less than this number the point will be a glider on this attracting element.
 
List of attractor elements.
 
If true, the infobox is shown on mouse over, else not.
 
Defines together with JXG.Point#snapSizeY the grid the point snaps on to.
 
Defines together with JXG.Point#snapSizeX the grid the point snaps on to.
 
If set to true, the point will snap to a grid defined by JXG.Point#snapSizeX and JXG.Point#snapSizeY.
 
If set to true, the point will snap to the nearest point in distance of JXG.Point#attractorDistance.
 
If the distance of the point to one of its attractors is at least this number the point will be released from being a glider on the attracting element.
 
This attribute was used to determined the point layout.
Fields borrowed from class JXG.GeometryElement:
addEvent, ancestors, board, childElements, dash, descendants, draft, dump, elementClass, elType, eventHandlers, fillColor, fillOpacity, fixed, frozen, getAttribute, hasLabel, highlight, highlighted, highlightFillColor, highlightFillOpacity, highlightStrokeColor, highlightStrokeOpacity, highlightStrokeWidth, id, isDraggable, isReal, methodMap, mouseover, name, needsRegularUpdate, needsUpdate, notExistingParents, numTraces, quadraticform, removeEvent, scalable, shadow, stdform, strokeColor, strokeOpacity, strokeWidth, subs, symbolic, trace, traceAttributes, traces, transformations, type, visible, visProp, withLabel
Method Summary
Method Attributes Method Name and Description
 
Convert the point to CAS point and call update().
 
addTransform(el, transform)
Add transformations to this point.
 
Dist(point2)
Getter method for the distance to a second point, this is required for CAS-elements.
 
face(f)
Set the face of a point element.
 
free()
Converts a glider into a free point.
 
A point can change its type from free point to glider and vice versa.
 
Move a point to its nearest grid point.
 
Let a point snap to the nearest point in distance of JXG.Point#attractorDistance.
 
makeGlider(glideObject)
Convert the point to glider and update the construction.
 
moveAlong(path, time, options)
Starts an animation which moves the point along a given path in given time.
 
moveTo(where, time, options)
Starts an animated point movement towards the given coordinates where.
 
All point faces can be defined with more than one name, e.g.
 
Remove the point from the drawing.
 
Sets the position of a glider relative to the defining elements of the JXG.Point#slideObject.
 
setPosition(method, coords)
Sets coordinates and calls the point's update() method.
 
Translates the point by tv = (x, y).
 
setPositionDirectly(method, coords)
Sets coordinates and calls the point's update() method.
 
size(s)
Set the size of a point element
 
update(fromParent)
Updates the position of the point.
 
Applies the transformations of the curve to JXG.Point#baseElement.
 
visit(where, time, options)
Starts an animated point movement towards the given coordinates where.
 
X()
Getter method for x, this is used by for CAS-points to access point coordinates.
 
Y()
Getter method for y, this is used by CAS-points to access point coordinates.
 
Z()
Getter method for z, this is used by CAS-points to access point coordinates.
Methods borrowed from class JXG.GeometryElement:
addChild, addRotation, animate, bounds, clearTrace, cloneToBackground, createLabel, getAttributes, getLabelAnchor, getName, getParents, getProperty, getTextAnchor, getType, hasPoint, hideElement, labelColor, noHighlight, off, on, resolveShortcuts, setArrow, setAttribute, setLabelText, setProperty, showElement, triggerEventHandlers
Events borrowed from class JXG.GeometryElement:
attribute, attribute:<attribute><attribute>, down, drag, mousedown, mousedrag, mousemove, mouseout, mouseover, mouseup, move, out, over, touchdown, touchdrag, touchup, up
Class Detail
JXG.Point(board, coordinates, attributes)
A point is the basic geometric element. Based on points lines and circles can be constructed which can be intersected which in turn are points again which can be used to construct new lines, circles, polygons, etc. This class holds methods for all kind of points like free points, gliders, and intersection points.
Parameters:
{string|JXG.Board} board
The board the new point is drawn on.
{Array} coordinates
An array with the affine user coordinates of the point.
{Object} attributes
An object containing visual properties like in JXG.Options#point and JXG.Options#elements, and optional a name and a id.
See:
JXG.Board#generateName
JXG.Board#addPoint
Field Detail
{number} attractorDistance
If the distance of the point to one of its attractors is less than this number the point will be a glider on this attracting element. If set to zero nothing happens.
Defined in: Options.js.
Default Value:
0

{array} attractors
List of attractor elements. If the distance of the point is less than attractorDistance the point is made to glider of this element.
Defined in: Options.js.
Default Value:
empty

{Boolean} showInfobox
If true, the infobox is shown on mouse over, else not.
Defined in: Options.js.
Default Value:
true

{Number} snapSizeX
Defines together with JXG.Point#snapSizeY the grid the point snaps on to. The point will only snap on values multiple to snapSizeX in x and snapSizeY in y direction. If this value is equal to or less than 0, it will use the grid displayed by the major ticks of the default ticks of the default x axes of the board.
Defined in: Options.js.
See:
JXG.Point#snapToGrid
JXG.Point#snapSizeY
JXG.Board#defaultAxes
Default Value:
1

{Number} snapSizeY
Defines together with JXG.Point#snapSizeX the grid the point snaps on to. The point will only snap on values multiple to snapSizeX in x and snapSizeY in y direction. If this value is equal to or less than 0, it will use the grid displayed by the major ticks of the default ticks of the default y axes of the board.
Defined in: Options.js.
See:
JXG.Point#snapToGrid
JXG.Point#snapSizeX
JXG.Board#defaultAxes
Default Value:
1

{Boolean} snapToGrid
If set to true, the point will snap to a grid defined by JXG.Point#snapSizeX and JXG.Point#snapSizeY.
Defined in: Options.js.
See:
JXG.Point#snapSizeX
JXG.Point#snapSizeY
Default Value:
false

{Boolean} snapToPoints
If set to true, the point will snap to the nearest point in distance of JXG.Point#attractorDistance.
Defined in: Options.js.
See:
JXG.Point#attractorDistance
Default Value:
false

{number} snatchDistance
If the distance of the point to one of its attractors is at least this number the point will be released from being a glider on the attracting element. If set to zero nothing happens.
Defined in: Options.js.
Default Value:
0

{Number} style
This attribute was used to determined the point layout. It was derived from GEONExT and was replaced by JXG.Point#face and JXG.Point#size.
Defined in: Options.js.
See:
JXG.Point#face
JXG.Point#size
Default Value:
JXG.Options.point#style
Method Detail
addConstraint(terms)
Convert the point to CAS point and call update().
Parameters:
{Array} terms
[[zterm], xterm, yterm] defining terms for the z, x and y coordinate. The z-coordinate is optional and it is used for homogeneous coordinates. The coordinates may be either
  • a JavaScript function,
  • a string containing GEONExT syntax. This string will be converted into a JavaScript function here,
  • a Number
  • a pointer to a slider object. This will be converted into a call of the Value()-method of this slider.
See:
JXG.GeonextParser#geonext2JS

{JXG.Point} addTransform(el, transform)
Add transformations to this point.
Parameters:
{JXG.GeometryElement} el
TODO base element
{JXG.Transform|Array} transform
Either one JXG.Transform or an array of JXG.Transforms.
Returns:
{JXG.Point} Reference to this point object.

{Number} Dist(point2)
Getter method for the distance to a second point, this is required for CAS-elements. Here, function inlining seems to be worthwile (for plotting).
Parameters:
{JXG.Point} point2
The point to which the distance shall be calculated.
Returns:
{Number} Distance in user coordinate to the given point

face(f)
Set the face of a point element.
Parameters:
{string} f
String which determines the face of the point. See JXG.GeometryElement#face for a list of available faces.
See:
JXG.GeometryElement#face

free()
Converts a glider into a free point.

handleAttractors()
A point can change its type from free point to glider and vice versa. If it is given an array of attractor elements (attribute attractors) and the attribute attractorDistance then the pint will be made a glider if it less than attractorDistance apart from one of its attractor elements. If attractorDistance is equal to zero, the point stays in its current form.

handleSnapToGrid()
Move a point to its nearest grid point. The function uses the coords object of the point as its actual position.

handleSnapToPoints()
Let a point snap to the nearest point in distance of JXG.Point#attractorDistance. The function uses the coords object of the point as its actual position.

makeGlider(glideObject)
Convert the point to glider and update the construction.
Parameters:
{String|Object} glideObject
The Object the point will be bound to.

{JXG.Point} moveAlong(path, time, options)
Starts an animation which moves the point along a given path in given time.
Parameters:
{Array|function} path
The path the point is moved on. This can be either an array of arrays containing x and y values of the points of the path, or function taking the amount of elapsed time since the animation has started and returns an array containing a x and a y value or NaN. In case of NaN the animation stops.
{Number} time
The time in milliseconds in which to finish the animation
{Object} options Optional
Optional settings for the animation:
  • callback: A function that is called as soon as the animation is finished.
Returns:
{JXG.Point} Reference to the point.

{JXG.Point} moveTo(where, time, options)
Starts an animated point movement towards the given coordinates where. The animation is done after time milliseconds. If the second parameter is not given or is equal to 0, setPosition() is called, see #setPosition.
Parameters:
{Array} where
Array containing the x and y coordinate of the target location.
{Number} time Optional
Number of milliseconds the animation should last.
{Object} options Optional
Optional settings for the animation:
  • callback: A function that is called as soon as the animation is finished.
  • effect: animation effects like speed fade in and out. possible values are '<>' for speed increase on start and slow down at the end (default) and '--' for constant speed during the whole animation.
Returns:
{JXG.Point} Reference to itself.
See:
#animate

{String} normalizeFace(s)
All point faces can be defined with more than one name, e.g. a cross faced point can be given by face equal to 'cross' or equal to 'x'. This method maps all possible values to fixed ones to simplify if- and switch-clauses regarding point faces. The translation table is as follows:
InputOutput
cross, xx
circle, oo
square, [][]
plus, ++
diamond, <><>
triangleup, a, ^A
triangledown, vv
triangleleft, <<
triangleright, >>
Parameters:
{String} s
A string which should determine a valid point face.
Returns:
{String} Returns a normalized string or undefined if the given string is not a valid point face.

remove()
Remove the point from the drawing. This only removes the SVG or VML node of the point and its label from the renderer, to remove the object completely you should use JXG.Board#removeObject.

{JXG.Point} setGliderPosition(x)
Sets the position of a glider relative to the defining elements of the JXG.Point#slideObject.
Parameters:
{Number} x
Returns:
{JXG.Point} Reference to the point element.

{JXG.Point} setPosition(method, coords)
Sets coordinates and calls the point's update() method.
Parameters:
{Number} method
The type of coordinates used here. Possible values are JXG.COORDS_BY_USER and JXG.COORDS_BY_SCREEN.
{Array} coords
coordinates in screen/user units
Returns:
{JXG.Point}

{JXG.Point} setPositionByTransform(method, tv)
Translates the point by tv = (x, y).
Parameters:
{Number} method
The type of coordinates used here. Possible values are JXG.COORDS_BY_USER and JXG.COORDS_BY_SCREEN.
{Number} tv
(x, y)
Returns:
{JXG.Point}

{JXG.Point} setPositionDirectly(method, coords)
Sets coordinates and calls the point's update() method.
Parameters:
{Number} method
The type of coordinates used here. Possible values are JXG.COORDS_BY_USER and JXG.COORDS_BY_SCREEN.
{Array} coords
coordinates (z, x, y) in screen/user units
Returns:
{JXG.Point}

size(s)
Set the size of a point element
Parameters:
{int} s
Integer which determines the size of the point.
See:
JXG.GeometryElement#size

update(fromParent)
Updates the position of the point.
Parameters:
fromParent

{JXG.Point} updateTransform()
Applies the transformations of the curve to JXG.Point#baseElement.
Returns:
{JXG.Point} Reference to this point object.

{JXG.Point} visit(where, time, options)
Starts an animated point movement towards the given coordinates where. After arriving at where the point moves back to where it started. The animation is done after time milliseconds.
Parameters:
{Array} where
Array containing the x and y coordinate of the target location.
{Number} time
Number of milliseconds the animation should last.
{Object} options Optional
Optional settings for the animation:
  • callback: A function that is called as soon as the animation is finished.
  • effect: animation effects like speed fade in and out. possible values are '<>' for speed increase on start and slow down at the end (default) and '--' for constant speed during the whole animation.
  • repeat: How often this animation should be repeated (default: 1)
Returns:
{JXG.Point} Reference to itself.
See:
#animate

{Number} X()
Getter method for x, this is used by for CAS-points to access point coordinates.
Returns:
User coordinate of point in x direction.

{Number} Y()
Getter method for y, this is used by CAS-points to access point coordinates.
Returns:
User coordinate of point in y direction.

{Number} Z()
Getter method for z, this is used by CAS-points to access point coordinates.
Returns:
User coordinate of point in z direction.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 30 2013 23:22:18 GMT+0200 (CEST)