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


Element Text

JXG.CoordsElement,JXG.GeometryElement
   ↳ JXG.Text
         ↳ Text

Construct and handle texts. The coordinates can be relative to the coordinates of an element given in JXG.Options#text.anchor. MathJaX, HTML and GEONExT syntax can be handled.

Defined in: text.js.
Extends JXG.Text.

Element Summary
Constructor Attributes Constructor Name and Description
 
Attributes Summary
Field Attributes Field Name and Description
 
Anchor element Point, Text or Image of the text.
 
The horizontal alignment of the text.
 
The vertical alignment of the text.
 
List of attractor elements.
 
The precision of the slider value displayed in the optional text.
 
Used to round texts given by a number.
 
Determines the rendering method of the text.
 
Sensitive area for dragging the text.
 
The font size in pixels.
 
The precision of the slider value displayed in the optional text.
 
If enabled, the text will be handled as label.
 
If set to true, the text is parsed and evaluated.
 
Text rotation in degrees.
 
Defines together with Text#snapSizeY the grid the text snaps on to.
 
Defines together with Text#snapSizeX the grid the text snaps on to.
 
If true the input will be given to ASCIIMathML before rendering.
 
If set to true and caja's sanitizeHTML function can be found it will be used to sanitize text output.
 
If true MathJax will be used to render the input string.
Methods borrowed from class JXG.Text:
_setText, _setUpdateText, checkForSizeUpdate, convertGeonext2CSS, crudeSizeEstimate, expandShortMath, generateTerm, getSize, hasPoint, notifyParents, replaceSub, replaceSup, setCoords, setText, setTextJessieCode, update, updateRenderer, updateSize, updateText, utf8_decode
Methods borrowed from class JXG.GeometryElement:
_set, addChild, addDescendants, addParents, addRotation, addTransform, animate, bounds, clearTrace, cloneToBackground, countChildren, createGradient, createLabel, draggable, generatePolynomial, getAttribute, getAttributes, getLabelAnchor, getName, getParents, getProperty, getTextAnchor, getType, handleSnapToGrid, hideElement, labelColor, noHighlight, normalize, prepareUpdate, remove, removeChild, removeDescendants, resolveShortcuts, setArrow, setAttribute, setDash, setLabel, setLabelText, setName, setParents, setPosition, setPositionDirectly, setProperty, showElement, snapToPoints
Methods borrowed from class JXG.CoordsElement:
_anim, addAnchor, addConstraint, Dist, free, handleAttractors, handleSnapToPoints, makeGlider, moveAlong, moveTo, popSlideObject, setGliderPosition, setPositionByTransform, updateConstraint, updateCoords, updateGlider, updateGliderFromParent, updateTransform, visit, X, XEval, Y, YEval, Z, ZEval
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
Element Detail
Text
This element has no direct constructor. To create an instance of this element you have to call JXG.Board#create with type "text".

Possible parent array combinations are:
{number|function} z   Optional
{number|function} x
{number|function} y
{String|function} str

Parent elements for text elements.

Parent elements can be two or three elements of type number, a string containing a GEONExT constraint, or a function which takes no parameter and returns a number. Every parent element determines one coordinate. If a coordinate is given by a number, the number determines the initial position of a free text. If given by a string or a function that coordinate will be constrained that means the user won't be able to change the texts's position directly by mouse because it will be calculated automatically depending on the string or the function's return value. If two parent elements are given the coordinates will be interpreted as 2D affine Euclidean coordinates, if three such parent elements are given they will be interpreted as homogeneous coordinates.

The text to display may be given as string or as function returning a string. There is the attribute 'display' which takes the values 'html' or 'internal'. In case of 'html' a HTML division tag is created to display the text. In this case it is also possible to use ASCIIMathML. Incase of 'internal', a SVG or VML text element is used to display the text.



See:
JXG.Text
Examples:
// Create a fixed text at position [0,1].
  var t1 = board.create('text',[0,1,"Hello World"]);

				
				
// Create a variable text at a variable position.
  var s = board.create('slider',[[0,4],[3,4],[-2,0,2]]);
  var graph = board.create('text',
                       [function(x){ return s.Value();}, 1,
                        function(){return "The value of s is"+s.Value().toFixed(2);}
                       ]
                    );

				
				
// Create a text bound to the point A
var p = board.create('point',[0, 1]),
    t = board.create('text',[0, -1,"Hello World"], {anchor: p});


				
                
Attribute Detail
{Object} anchor
Anchor element Point, Text or Image of the text. If it exists, the coordinates of the text are relative to this anchor element.
Defined in: options.js.
Default Value:
null

{String} anchorX
The horizontal alignment of the text. Possible values include 'left', 'middle', and 'right'.
Defined in: options.js.
Default Value:
'left'

{String} anchorY
The vertical alignment of the text. Possible values include 'top', 'middle', and 'bottom'.
Defined in: options.js.
Default Value:
'middle'

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

{String} cssClass
The precision of the slider value displayed in the optional text.
Defined in: options.js.

{Number} digits
Used to round texts given by a number.
Defined in: options.js.
Default Value:
2

{String} display
Determines the rendering method of the text. Possible values include 'html' and 'internal.
Defined in: options.js.
Default Value:
'html'

{String} dragArea
Sensitive area for dragging the text. Possible values are 'all', or something else. This may be extended to left, right, ... in the future.
Defined in: options.js.
Default Value:
'all'

{Number} fontSize
The font size in pixels.
Defined in: options.js.
Default Value:
12

{String} highlightCssClass
The precision of the slider value displayed in the optional text.
Defined in: options.js.

{Boolean} isLabel
If enabled, the text will be handled as label. Intended for internal use.
Defined in: options.js.
Default Value:
false

{Boolean} parse
If set to true, the text is parsed and evaluated. For labels parse==true results in converting names of the form k_a to subscripts. If the text is given by string and parse==true, the string is parsed as JessieCode expression.
Defined in: options.js.
Default Value:
true

{Number} rotate
Text rotation in degrees. Works for non-zero values only in combination with display=='internal'.
Defined in: options.js.
Default Value:
0

{Number} snapSizeX
Defines together with Text#snapSizeY the grid the text snaps on to. The text will only snap on integer multiples 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
Text#snapSizeY
JXG.Board#defaultAxes
Default Value:
1

{Number} snapSizeY
Defines together with Text#snapSizeX the grid the text snaps on to. The text will only snap on integer multiples 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
Text#snapSizeX
JXG.Board#defaultAxes
Default Value:
1

{Boolean} useASCIIMathML
If true the input will be given to ASCIIMathML before rendering.
Defined in: options.js.
Default Value:
false

{Boolean} useCaja
If set to true and caja's sanitizeHTML function can be found it will be used to sanitize text output.
Defined in: options.js.
Default Value:
false

{Boolean} useMathJax
If true MathJax will be used to render the input string.
Defined in: options.js.
Default Value:
false

Attributes borrowed from other Elements
Attributes borrowed from class JXG.GeometryElement:
dash, draft, fillColor, fillOpacity, fixed, frozen, highlight, highlightFillColor, highlightFillOpacity, highlightStrokeColor, highlightStrokeOpacity, highlightStrokeWidth, needsRegularUpdate, scalable, shadow, snapToGrid, strokeColor, strokeOpacity, strokeWidth, trace, traceAttributes, visible, withLabel

Fields borrowed from other Elements
Fields borrowed from class JXG.GeometryElement:
_org_type, _pos, ancestors, baseElement, board, childElements, descendants, dump, elementClass, elType, hasLabel, highlighted, id, isDraggable, isReal, lastDragTime, methodMap, mouseover, name, needsUpdate, notExistingParents, numTraces, parents, quadraticform, rendNode, stdform, subs, symbolic, traces, transformations, type, visProp
Fields borrowed from class JXG.CoordsElement:
coords, groups, needsUpdateFromParent, onPolygon, position, slideObjects

Methods borrowed from other Elements
Methods borrowed from class JXG.Text:
_setText, _setUpdateText, checkForSizeUpdate, convertGeonext2CSS, crudeSizeEstimate, expandShortMath, generateTerm, getSize, hasPoint, notifyParents, replaceSub, replaceSup, setCoords, setText, setTextJessieCode, update, updateRenderer, updateSize, updateText, utf8_decode
Methods borrowed from class JXG.GeometryElement:
_set, addChild, addDescendants, addParents, addRotation, addTransform, animate, bounds, clearTrace, cloneToBackground, countChildren, createGradient, createLabel, draggable, generatePolynomial, getAttribute, getAttributes, getLabelAnchor, getName, getParents, getProperty, getTextAnchor, getType, handleSnapToGrid, hideElement, labelColor, noHighlight, normalize, prepareUpdate, remove, removeChild, removeDescendants, resolveShortcuts, setArrow, setAttribute, setDash, setLabel, setLabelText, setName, setParents, setPosition, setPositionDirectly, setProperty, showElement, snapToPoints
Methods borrowed from class JXG.CoordsElement:
_anim, addAnchor, addConstraint, Dist, free, handleAttractors, handleSnapToPoints, makeGlider, moveAlong, moveTo, popSlideObject, setGliderPosition, setPositionByTransform, updateConstraint, updateCoords, updateGlider, updateGliderFromParent, updateTransform, visit, X, XEval, Y, YEval, Z, ZEval

Events borrowed from other Elements
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
Documentation generated by JsDoc Toolkit 2.4.0 on Tue Jul 05 2016 11:01:15 GMT+0200 (CEST)