JavaScript must be enabled in order for you to use JSXGraph and JSXGraph reference. However, it seems JavaScript is either disabled or not supported by your browser.

Class Index | File Index

Elements
Classes

Class Cardinalspline

JXG.GeometryElement
   ↳ JXG.Curve
         ↳ Cardinalspline

This element is used to provide a constructor for cardinal spline curves. Create a dynamic cardinal spline interpolated curve given by sample points p_1 to p_n.

Defined in: curve.js.
Extends JXG.Curve.

Class Summary
Constructor Attributes Constructor Name and Description
 
Cardinalspline(board, parents, attributes)
Fields borrowed from class JXG.Curve:
dataX, dataY, numberPoints, qdt, ticks
Fields borrowed from class JXG.GeometryElement:
_org_type, _pos, ancestors, baseElement, board, childElements, dash, dashScale, descendants, draft, dragToTopOfLayer, dump, elementClass, elType, fillColor, fillOpacity, fixed, frozen, gradient, gradientAngle, gradientCX, gradientCY, gradientEndOffset, gradientFR, gradientFX, gradientFY, gradientR, gradientSecondColor, gradientSecondOpacity, gradientStartOffset, hasLabel, highlight, highlighted, highlightFillColor, highlightFillOpacity, highlightStrokeColor, highlightStrokeOpacity, highlightStrokeWidth, id, inherits, isDraggable, isLabel, isReal, lastDragTime, layer, lineCap, methodMap, mouseover, name, needsRegularUpdate, needsUpdate, notExistingParents, numTraces, parents, precision, priv, quadraticform, rendNode, rotatable, scalable, shadow, snapToGrid, stdform, strokeColor, strokeOpacity, strokeWidth, subs, symbolic, tabindex, trace, traceAttributes, traces, transformations, transitionDuration, transitionProperties, type, visible, visProp, visPropCalc, withLabel
Field Summary
Field Attributes Field Name and Description
 
Controls if the data points of the cardinal spline when given as arrays should be converted into JXG.Points.
 
If set to true, the supplied coordinates are interpreted as [[x_0, y_0], [x_1, y_1], p, .
 
Attributes for the points generated by Cardinalspline in cases createPoints is set to true
Fields borrowed from class JXG.Curve:
dataX, dataY, numberPoints, qdt, ticks
Fields borrowed from class JXG.GeometryElement:
_org_type, _pos, ancestors, baseElement, board, childElements, dash, dashScale, descendants, draft, dragToTopOfLayer, dump, elementClass, elType, fillColor, fillOpacity, fixed, frozen, gradient, gradientAngle, gradientCX, gradientCY, gradientEndOffset, gradientFR, gradientFX, gradientFY, gradientR, gradientSecondColor, gradientSecondOpacity, gradientStartOffset, hasLabel, highlight, highlighted, highlightFillColor, highlightFillOpacity, highlightStrokeColor, highlightStrokeOpacity, highlightStrokeWidth, id, inherits, isDraggable, isLabel, isReal, lastDragTime, layer, lineCap, methodMap, mouseover, name, needsRegularUpdate, needsUpdate, notExistingParents, numTraces, parents, precision, priv, quadraticform, rendNode, rotatable, scalable, shadow, snapToGrid, stdform, strokeColor, strokeOpacity, strokeWidth, subs, symbolic, tabindex, trace, traceAttributes, traces, transformations, transitionDuration, transitionProperties, type, visible, visProp, visPropCalc, withLabel
Methods borrowed from class JXG.Curve:
addTransform, allocatePoints, generateTerm, getTransformationSource, hasPoint, interpolationFunctionFromArray, maxX, minX, moveTo, notifyParents, update, updateCurve, updateDataArray, updateRenderer, updateTransform, X, Y, Z
Methods borrowed from class JXG.GeometryElement:
_set, addChild, addDescendants, addParents, addParentsFromJCFunctions, addRotation, addTicks, animate, bounds, clearTrace, cloneToBackground, countChildren, createGradient, createLabel, draggable, formatNumberLocale, fullUpdate, generatePolynomial, getAttribute, getAttributes, getLabelAnchor, getName, getParents, getProperty, getSnapSizes, getTextAnchor, getType, handleSnapToGrid, hide, hideElement, labelColor, noHighlight, normalize, prepareUpdate, remove, removeAllTicks, removeChild, removeDescendants, removeTicks, resolveShortcuts, setArrow, setAttribute, setDash, setDisplayRendNode, setLabel, setLabelText, setName, setParents, setPosition, setPositionDirectly, setProperty, show, showElement, snapToPoints, updateVisibility, useLocale
Events borrowed from class JXG.GeometryElement:
attribute, attribute:key, down, drag, keydrag, mousedown, mousedrag, mousemove, mouseout, mouseover, mouseup, move, out, over, pendown, pendrag, penup, touchdown, touchdrag, touchup, up
Class Detail
Cardinalspline(board, parents, attributes)
Parameters:
{JXG.Board} board
Reference to the board the cardinal spline is drawn on.


{Array} parents
Array with three entries.

First entry: Array of points the spline interpolates. This can be

  • an array of JSXGraph points
  • an array of coordinate pairs
  • an array of functions returning coordinate pairs
  • an array consisting of an array with x-coordinates and an array of y-coordinates
All individual entries of coordinates arrays may be numbers or functions returning numbers.

Second entry: tau number or function

Third entry: type string containing 'uniform' (default) or 'centripetal'.



{Object} attributes
Define color, width, ... of the cardinal spline


Returns:
{JXG.Curve} Returns reference to an object of type JXG.Curve.
See:
JXG.Curve
Examples:
//create a cardinal spline out of an array of JXG points with adjustable tension
//create array of points
var p1 = board.create('point',[0,0])
var p2 = board.create('point',[1,4])
var p3 = board.create('point',[4,5])
var p4 = board.create('point',[2,3])
var p5 = board.create('point',[3,0])
var p = [p1,p2,p3,p4,p5]

// tension
tau = board.create('slider', [[4,3],[9,3],[0.001,0.5,1]], {name:'tau'});
c = board.create('curve', JXG.Math.Numerics.CardinalSpline(p, function(){ return tau.Value();}), {strokeWidth:3});

				
                
Field Detail
{Boolean} createPoints
Controls if the data points of the cardinal spline when given as arrays should be converted into JXG.Points.
Defined in: options.js.
See:
Cardinalspline#points
Default Value:
true

{Boolean} isArrayOfCoordinates
If set to true, the supplied coordinates are interpreted as [[x_0, y_0], [x_1, y_1], p, ...]. Otherwise, if the data consists of two arrays of equal length, it is interpreted as [[x_o x_1, ..., x_n], [y_0, y_1, ..., y_n]]
Defined in: options.js.
Default Value:
true

{Object} points
Attributes for the points generated by Cardinalspline in cases createPoints is set to true
Defined in: options.js.
See:
Cardinalspline#createPoints

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Aug 13 2023 17:09:59 GMT-0000 (UTC)