API Docs for: 0.99.4
Show:

JXG.Options Class

Defined in: src/options.js:50
Module: JXG

Options Namespace

These are the default options of the board and of all geometry elements.

Item Index

Properties

Properties

anchor

Object

Defined in src/options.js:3159

Anchor element Point, Text or Image of the text. If it exists, the coordinates of the text are relative to this anchor element.

Default: null

anchorX

String

Defined in src/options.js:3170

The horizontal alignment of the text. Possible values include 'left', 'middle', and 'right'.

Default: 'left'

anchorY

String

Defined in src/options.js:3181

The vertical alignment of the text. Possible values include 'top', 'middle', and 'bottom'.

Default: 'middle'

Angle#orthoSensitivity

Number

Defined in src/options.js:1030

Sensitivity (in degrees) to declare an angle as right angle. If the angle measure is inside this distance from a rigth angle, the orthoType of the angle is used for display.

Default: 1.0

See also:

  • Angle#orthoType

Angle#orthoType

String

Defined in src/options.js:1018

Display type of the angle field in case of a right angle. Possible values are 'sector' or 'sectordot' or 'square' or 'none'.

Default: square

See also:

  • Angle#orthoSensitivity

Angle#radius

Number

Defined in src/options.js:997

Radius of the sector, displaying the angle.

Default: 0.5

Angle#type

String

Defined in src/options.js:1007

Display type of the angle field. Possible values are 'sector' or 'sectordot' or 'square' or 'none'.

Default: 'sector'

attractors

Array

Defined in src/options.js:3269

List of attractor elements. If the distance of the text is less than attractorDistance the text is made to glider of this element.

Default: empty

Axis#label

Label

Defined in src/options.js:1173

Attributes for the axis label.

Axis#point1

Point

Defined in src/options.js:1153

Attributes for first point the axis.

Axis#point2

Point

Defined in src/options.js:1163

Attributes for second point the axis.

Axis#ticks

Ticks

Defined in src/options.js:1125

Attributes for ticks of the axis.

Bisector#point

Point

Defined in src/options.js:1194

Attributes for the helper point of the bisector.

Bisectorlines#line1

Line

Defined in src/options.js:1216

Attributes for first line.

Bisectorlines#line2

Line

Defined in src/options.js:1226

Attributes for second line.

Circle#center

Point

Defined in src/options.js:1317

Attributes for center point.

Circle#hasInnerPoints

Boolean

Defined in src/options.js:1302

If true, moving the mouse over inner points triggers hasPoint.

Default: false

See also:

Circle#label

Label

Defined in src/options.js:1536

Attributes for circle label.

Circle#label

Label

Defined in src/options.js:1330

Attributes for circle label.

Circle#point

Point

Defined in src/options.js:1407

Attributes for center point.

Circumcircle#center

Point

Defined in src/options.js:1353

Attributes for center point.

CircumcircleArc#center

Point

Defined in src/options.js:1378

Attributes for center point.

Conic#foci

Point

Defined in src/options.js:1433

Attributes for foci points.

cssClass

String

Defined in src/options.js:3192

The precision of the slider value displayed in the optional text.

Curve#curveType

String

Defined in src/options.js:1470

The curveType is set in JXG.Curve#generateTerm and used in JXG.Curve#updateCurve. Possible values are

  • 'none'
  • 'plot': Data plot
  • 'parameter': we can not distinguish function graphs and parameter curves
  • 'functiongraph': function graph
  • 'polar'
  • 'implicit' (not yet)
Only parameter and plot are set directly. Polar is set with JXG.GeometryElement#setAttribute only.

Default: null

Curve#doAdvancedPlot

Boolean

Defined in src/options.js:1515

If true use a recursive bisection algorithm. It is slower, but usually the result is better. It tries to detect jumps and singularities.

Default: true

Curve#doAdvancedPlotOld

Boolean

Defined in src/options.js:1526

If true use the algorithm by Gillam and Hohenwarter, which was default until version 0.98.

Default: false

See also:

  • Curve#doAdvancedPlot

Curve#handDrawing

Boolean

Defined in src/options.js:1462

The data points of the curve are not connected with straight lines but with bezier curves.

Default: false

Curve#numberPointsHigh

Number

Defined in src/options.js:1495

Number of points used for plotting triggered by up events in case undefined is false.

Default: 1600

See also:

  • Curve#doAdvancedPlot

Curve#numberPointsLow

Number

Defined in src/options.js:1505

Number of points used for plotting triggered by move events in case undefined is false.

Default: 400

See also:

  • Curve#doAdvancedPlot

Curve#RDPsmoothing

Boolean

Defined in src/options.js:1486

Apply Ramer-Douglas-Peuker smoothing.

Default: false

digits

Number

Defined in src/options.js:3080

Used to round texts given by a number.

Default: 2

disabled

Boolean

Defined in src/options.js:1840

Control the attribute "disabled" of the HTML input field.

Default: false

disabled

Boolean

Defined in src/options.js:1245

Control the attribute "disabled" of the HTML button.

Default: false

disabled

Boolean

Defined in src/options.js:1282

Control the attribute "disabled" of the HTML checkbox.

Default: false

display

String

Defined in src/options.js:3148

Determines the rendering method of the text. Possible values include 'html' and 'internal.

Default: 'html'

fontSize

Number

Defined in src/options.js:3070

The font size in pixels.

Default: 12

highlightCssClass

String

Defined in src/options.js:3201

The precision of the slider value displayed in the optional text.

Image#attractors

Array

Defined in src/options.js:1674

List of attractor elements. If the distance of the image is less than attractorDistance the image is made to glider of this element.

Default: empty

Image#rotate

Number

Defined in src/options.js:1633

Image rotation in degrees.

Default: 0

Image#snapSizeX

Number

Defined in src/options.js:1642

Defines together with undefined the grid the image snaps on to. The image 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.

Default: 1

See also:

  • JXG.Point#snapToGrid
  • Image#snapSizeY
  • JXG.Board#defaultAxes

Image#snapSizeY

Number

Defined in src/options.js:1658

Defines together with undefined the grid the image snaps on to. The image 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.

Default: 1

See also:

  • JXG.Point#snapToGrid
  • Image#snapSizeX
  • JXG.Board#defaultAxes

Incircle#center

Point

Defined in src/options.js:1699

Attributes of circle center.

Inequality#inverse

Boolean

Defined in src/options.js:1723

By default an inequality is less (or equal) than. Set inverse to true will consider the inequality greater (or equal) than.

Default: false

Integral#baseLeft

Point

Defined in src/options.js:1781

Attributes of the (left) base point of the integral.

See also:

Integral#baseRight

Point

Defined in src/options.js:1808

Attributes of the (right) base point of the integral.

See also:

Integral#curveLeft

Point

Defined in src/options.js:1768

Attributes of the (left) starting point of the integral.

See also:

Integral#curveRight

Point

Defined in src/options.js:1795

Attributes of the (right) end point of the integral.

See also:

Integral#label

Label

Defined in src/options.js:1822

Attributes for integral label.

Intersection.alwaysIntersect

Boolean

Defined in src/options.js:1860

Used in undefined. This flag sets the behaviour of intersection points of e.g. two segments. If true, the intersection is treated as intersection of lines. If false the intersection point exists if the segments intersect setwise.

Default: true

isLabel

Boolean

Defined in src/options.js:3114

If enabled, the text will be handled as label. Intended for internal use.

Default: false

JXG.Board#animationDelay

Number

Defined in src/options.js:247

Time (in msec) between two animation steps. Used in JXG.CoordsElement#moveAlong, JXG.CoordsElement#moveTo and JXG.CoordsElement#visit.

Default: 35

See also:

JXG.Board#axis

Boolean

Defined in src/options.js:127

Show default axis. If shown, the horizontal axis can be accessed via JXG.Board.defaultAxis.x, the vertical axis can be accessed via JXG.Board.defaultAxis.y. Both axes have a sub-element "defaultTicks".

Default: false

JXG.Board#boundingbox

Array

Defined in src/options.js:75

Bounding box of the visible area in user coordinates. It is an array consisting of four values: [x1, y1, x2, y2]

The canvas will be spanned from the upper left corner (1, y1) to the lower right corner (x2, y2).

Default: [-5, 5, 5, -5]

JXG.Board#document

DOM object

Defined in src/options.js:210

Supply the document object. Defaults to window.document

Default: false (meaning window.document)

JXG.Board#ignoreLabels

Booelan

Defined in src/options.js:184

If set true and hasPoint() is true for both an element and it's label, the element (and not the label) is taken as drag element.

If set false and hasPoint() is true for both an element and it's label, the label is taken (if it is on a higher layer than the element)

Default: true

JXG.Board#keepAspectRatio

Boolean

Defined in src/options.js:166

If set to true the bounding box might be changed such that the ratio of width and height of the hosting HTML div is equal to the ratio of wifth and height of the bounding box.

This is necessary if circles should look like circles and not like ellipses. It is recommended to set keepAspectRatio = true for geometric applets. For function plotting keepAspectRatio = false might be the better choice.

Default: false

See also:

JXG.Board#maxNameLength

Number

Defined in src/options.js:198

Maximum number of digits in automatic label generation. For example, if set to 1 automatic point labels end at "Z". If set to 2, point labels end at "ZZ".

Default: 1

See also:

JXG.Board#name

String

Defined in src/options.js:269

Change redraw strategy in SVG rendering engine.

If set to 'svg', before every redrawing of the JSXGraph construction the SVG sub-tree of the DOM tree is taken out of the DOM.

If set to 'all', before every redrawing of the JSXGraph construction the complete DOM tree is taken out of the DOM. If set to 'none' the redrawing is done in-place.

Using 'svg' or 'all' speeds up the update process considerably. The risk is that if there is an exception, only a white div or window is left.

Default: 'svg'

JXG.Board#offsetX

Number

Defined in src/options.js:288

A number that will be added to the absolute position of the board used in mouse coordinate calculations in JXG.Board#getCoordsTopLeftCorner.

Default: 0

See also:

  • JXG.Board#offsetY

JXG.Board#offsetY

Number

Defined in src/options.js:299

A number that will be added to the absolute position of the board used in mouse coordinate calculations in JXG.Board#getCoordsTopLeftCorner.

Default: 0

See also:

  • JXG.Board#offsetX

JXG.Board#pan

Object

Defined in src/options.js:336

Control the possibilities for panning interaction (i.e. moving the origin).

Possible sub-attributes with default values are:

                    pan: {
                      enabled: true   // Allow panning
                      needTwoFingers: true, // panningis done with two fingers on touch devices
                      needshift: true, // mouse panning needs pressing of the shift key
                    }
                    

JXG.Board#registerEvents

Boolean

Defined in src/options.js:260

Allow user interaction by registering mouse and touch events.

Default: true

JXG.Board#renderer

String

Defined in src/options.js:237

Default rendering engine. Possible values are 'svg', 'canvas', 'vml', 'no'. If the rendering engine is not available JSXGraph tries to detect a different engine.

Default: 'svg'

JXG.Board#showClearTraces

Boolean

Defined in src/options.js:157

Show a button which allows to clear all traces of a board.

Default: false

JXG.Board#showCopyright

Boolean

Defined in src/options.js:118

Show copyright string in canvas.

Default: true

JXG.Board#showNavigation

Boolean

Defined in src/options.js:138

Display of navigation arrows and zoom buttons

Default: true

JXG.Board#showReload

Boolean

Defined in src/options.js:147

Show a button to force reload of a construction. Works only with the JessieCode tag

Default: false

JXG.Board#takeFirst

Boolean

Defined in src/options.js:219

If true the first element of the set JXG.board.objects having hasPoint==true is taken as drag element.

Default: false

JXG.Board#takeSizeFromFile

Boolean

Defined in src/options.js:228

If true, when read from a file or string - the size of the div can be changed by the construction text.

Default: false

JXG.Board#zoom

Object

Defined in src/options.js:310

Control the possibilities for zoom interaction.

Possible sub-attributes with default values are:

                    zoom: {
                      factorX: 1.25,  // horizontal zoom factor (multiplied to JXG.Board#zoomX)
                      factorY: 1.25,  // vertical zoom factor (multiplied to JXG.Board#zoomY)
                      wheel: false,   // allow zooming by mouse wheel
                      needshift: false, // mouse wheel zooming needs pressing of the shift key
                      eps: 0.1        // minimal values of JXG.Board#zoomX and JXG.Board#zoomY
                    }
                    

JXG.Board#zoomFactor

Number

Defined in src/options.js:89

Additional zoom factor multiplied to JXG.Board#zoomX and JXG.Board#zoomY.

Default: 1.0

JXG.Board#zoomX

Number

Defined in src/options.js:98

Zoom factor in horizontal direction.

Default: 1.0

See also:

JXG.Board#zoomY

Number

Defined in src/options.js:108

Zoom factor in vertical direction.

Default: 1.0

See also:

JXG.GeometryElement#dash

Number

Defined in src/options.js:572

Determines the elements border-style. Possible values are:

  • 0 for a solid line
  • 1 for a dotted line
  • 2 for a line with small dashes
  • 3 for a line with medium dashes
  • 4 for a line with big dashes
  • 5 for a line with alternating medium and big dashes and large gaps
  • 6 for a line with alternating medium and big dashes and small gaps

Default: 0

JXG.GeometryElement#draft

Boolean

Defined in src/options.js:659

If true the element will be drawn in grey scale colors to visualize that it's only a draft.

Default: {@link JXG.Options.elements.draft#draft}

JXG.GeometryElement#fillColor

String

Defined in src/options.js:428

The fill color of this geometry element.

Default: {@link JXG.Options.elements.color#fillColor}

See also:

JXG.GeometryElement#fillOpacity

Number

Defined in src/options.js:474

Opacity for fill color.

Default: {@link JXG.Options.elements.color#fillOpacity}

See also:

JXG.GeometryElement#fixed

Boolean

Defined in src/options.js:522

If true the element is fixed and can not be dragged around. The element will be repositioned on zoom and moveOrigin events.

Default: false

JXG.GeometryElement#frozen

Boolean

Defined in src/options.js:531

If true the element is fixed and can not be dragged around. The element will even stay at its position on zoom and moveOrigin events. Only free elements like points, texts, curves can be frozen.

Default: false

JXG.GeometryElement#highlight

Boolean

Defined in src/options.js:618

Default: true

JXG.GeometryElement#highlightFillColor

String

Defined in src/options.js:439

The fill color of the given geometry element when the mouse is pointed over it.

Default: {@link JXG.Options.elements.color#highlightFillColor}

See also:

JXG.GeometryElement#highlightFillOpacity

Number

Defined in src/options.js:485

Opacity for fill color when the object is highlighted.

Default: {@link JXG.Options.elements.color#highlightFillOpacity}

See also:

JXG.GeometryElement#highlightStrokeColor

String

Defined in src/options.js:416

The stroke color of the given geometry element when the user moves the mouse over it.

Default: {@link JXG.Options.elements.color#highlightStrokeColor}

See also:

JXG.GeometryElement#highlightStrokeOpacity

Number

Defined in src/options.js:462

Opacity for stroke color when the object is highlighted.

Default: {@link JXG.Options.elements#highlightStrokeOpacity}

See also:

JXG.GeometryElement#highlightStrokeWidth

Number

Defined in src/options.js:508

Width of the element's stroke when the mouse is pointed over it.

Default: {@link JXG.Options.elements#strokeWidth}

See also:

JXG.GeometryElement#label.offset

Array

Defined in src/options.js:1899

Label offset from label anchor The label anchor is determined by JXG.GeometryElement#label.position

Default: [10,10]

JXG.GeometryElement#label.position

String

Defined in src/options.js:1887

Possible string values for the position of a label for label anchor points are: 'lft'|'rt'|'top'|'bot'|'ulft'|'urt'|'llft'|'lrt' This is relevant for non-points: line, circle, curve.

Default: 'urt'

JXG.GeometryElement#needsRegularUpdate

Boolean

Defined in src/options.js:626

If this is set to true, the element is updated in every update call of the board. If set to false, the element is updated only after zoom events or more generally, when the bounding box has been changed. Examples for the latter behaviour should be axes.

Default: true

See also:

  • JXG.GeometryElement#needsRegularUpdate

JXG.GeometryElement#scalable

Boolean

Defined in src/options.js:648

Determines whether two-finger manipulation of this object may change its size. If set to false, the object is only rotated and translated.

Default: true

JXG.GeometryElement#shadow

Boolean

Defined in src/options.js:590

If true the element will get a shadow.

Default: false

JXG.GeometryElement#snapToGrid

Boolean

Defined in src/options.js:638

Snaps the element or its parents to the grid. Currently only relevant for points, circles, and lines. Points are snapped to grid directly, on circles and lines it's only the parent points that are snapped

Default: false

JXG.GeometryElement#strokeColor

String

Defined in src/options.js:404

The stroke color of the given geometry element.

Default: {@link JXG.Options.elements.color#strokeColor}

See also:

JXG.GeometryElement#strokeOpacity

Number

Defined in src/options.js:450

Opacity for element's stroke color.

Default: {@link JXG.Options.elements#strokeOpacity}

See also:

JXG.GeometryElement#strokeWidth

Number

Defined in src/options.js:496

Width of the element's stroke.

Default: {@link JXG.Options.elements#strokeWidth}

See also:

JXG.GeometryElement#trace

Boolean

Defined in src/options.js:598

If true the element will be traced, i.e. on every movement the element will be copied to the background. Use JXG.GeometryElement#clearTrace to delete the trace elements.

Default: false

See also:

JXG.GeometryElement#traceAttributes

Object

Defined in src/options.js:610

Extra visual properties for traces of an element

See also:

  • JXG.GeometryElement#trace

JXG.GeometryElement#visible

Boolean

Defined in src/options.js:549

If false the element won't be visible on the board, otherwise it is shown.

Default: true

See also:

JXG.GeometryElement#withLabel

Boolean

Defined in src/options.js:541

If true a label will display the element's name.

Default: false

Line#firstArrow

Boolean

Defined in src/options.js:1929

Line has an arrow head at the position of its first point or the corresponding intersection with the canvas border.

Default: false

See also:

  • Line#lastArrow
  • Line#touchFirstPoint

Line#label

Label

Defined in src/options.js:2028

Attributes for the line label.

Line#lastArrow

Boolean

Defined in src/options.js:1941

Line has an arrow head at the position of its second point or the corresponding intersection with the canvas border.

Default: false

See also:

  • Line#firstArrow
  • Line#touchLastPoint

Line#point1

Point

Defined in src/options.js:1981

Attributes for first defining point of the line.

Line#point2

Point

Defined in src/options.js:1994

Attributes for second defining point of the line.

Line#snapSizeX

Number

Defined in src/options.js:2050

Defines together with undefined the grid the point snaps on to. The point 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.

Default: 1

See also:

  • Point#snapToGrid
  • Point#snapSizeY
  • JXG.Board#defaultAxes

Line#snapSizeY

Number

Defined in src/options.js:2065

Defines together with undefined the grid the point snaps on to. The point 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.

Default: 1

See also:

  • Point#snapToGrid
  • Point#snapSizeX
  • Board#defaultAxes

Line#snapToGrid

Boolean

Defined in src/options.js:2038

If set to true, the point will snap to a grid defined by undefined and undefined.

Default: false

See also:

  • Point#snapSizeX
  • Point#snapSizeY

Line#straightFirst

Boolean

Defined in src/options.js:1953

If true, line stretches infinitely in direction of its first point. Otherwise it ends at point1.

Default: true

See also:

  • Line#straightLast

Line#straightLast

Boolean

Defined in src/options.js:1964

If true, line stretches infinitely in direction of its second point. Otherwise it ends at point2.

Default: true

See also:

  • Line#straightFirst

Line#ticks

Ticks

Defined in src/options.js:2007

Attributes for ticks of the line.

Line#touchFirstPoint

Boolean

Defined in src/options.js:2080

If set to true and undefined is set to true, the arrow head will just touch the circle line of the start point of the line.

Default: false

See also:

  • Line#firstArrow

Line#touchLastPoint

Boolean

Defined in src/options.js:2091

If set to true and undefined is set to true, the arrow head will just touch the circle line of the start point of the line.

Default: false

See also:

  • Line#firstArrow

Normal#point

Point

Defined in src/options.js:2126

Attributes of helper point of normal.

numberPoints

Number

Defined in src/options.js:3291

The number of evaluated data points.

Default: 100

Parallel#point

Point

Defined in src/options.js:2159

Attributes of helper point of normal.

parse

Boolean

Defined in src/options.js:3090

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.

Default: true

Point#attractorDistance

Number

Defined in src/options.js:2336

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.

Default: 0.0

Point#attractors

Array

Defined in src/options.js:2310

List of attractor elements. If the distance of the point is less than attractorDistance the point is made to glider of this element.

Default: empty

Point#attractorUnit

String

Defined in src/options.js:2321

Unit for attractorDistance and snatchDistance, used for magnetized points and for snapToPoints. Possible values are 'screen' and 'user.

Default: 'user'

See also:

  • Point#attractorDistance
  • Point#snatchDistance
  • Point#snapToPoints
  • Point#attractors

Point#face

String

Defined in src/options.js:2231

There are different point styles which differ in appearance. Posssible values are

Value
cross
circle
square
plus
diamond
triangleUp
triangleDown
triangleLeft
triangleRight

Default: circle

See also:

  • Point#setStyle

Point#ignoredSnapToPoints

Array

Defined in src/options.js:2419

List of elements which are ignored by snapToPoints.

Default: empty

Point#infoboxDigits

String, Number

Defined in src/options.js:2293

Truncating rule for the digits in the infobox.

  • 'auto': done automatically by JXG#autoDigits
  • 'none': no truncation
  • number: use String.toFixed();

Default: 'auto'

Point#showInfobox

Boolean

Defined in src/options.js:2283

If true, the infobox is shown on mouse over, else not.

Default: true

Point#size

Number

Defined in src/options.js:2254

Size of a point. Means radius resp. half the width of a point (depending on the face).

Default: 3

See also:

  • Point#face
  • Point#setStyle

Point#snapSizeX

Number

Defined in src/options.js:2375

Defines together with undefined the grid the point snaps on to. The point 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.

Default: 1

See also:

  • Point#snapToGrid
  • Point#snapSizeY
  • Board#defaultAxes

Point#snapSizeY

Number

Defined in src/options.js:2391

Defines together with undefined the grid the point snaps on to. The point 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.

Default: 1

See also:

  • Point#snapToGrid
  • Point#snapSizeX
  • Board#defaultAxes

Point#snapToGrid

Boolean

Defined in src/options.js:2362

If set to true, the point will snap to a grid defined by undefined and undefined.

Default: false

See also:

  • JXG.Point#snapSizeX
  • JXG.Point#snapSizeY

Point#snapToPoints

Boolean

Defined in src/options.js:2407

If set to true, the point will snap to the nearest point in distance of undefined.

Default: false

See also:

  • Point#attractorDistance

Point#snatchDistance

Number

Defined in src/options.js:2349

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.

Default: 0.0

Point#style

Number deprecated

Defined in src/options.js:2217

This attribute was used to determined the point layout. It was derived from GEONExT and was replaced by undefined and undefined.

Default: 5

See also:

  • Point#face
  • Point#size

Point#zoom

Boolean

Defined in src/options.js:2273

If true, the point size changes on zoom events.

Default: false

Polygon#borders

Line

Defined in src/options.js:2461

Attributes for the polygon border lines.

Polygon#hasInnerPoints

Boolean

Defined in src/options.js:2437

If true, moving the mouse over inner points triggers hasPoint.

Default: false

See also:

Polygon#label

Label

Defined in src/options.js:2587

Attributes for the polygon label.

Polygon#label

Label

Defined in src/options.js:2493

Attributes for the polygon label.

Polygon#vertices

Point

Defined in src/options.js:2478

Attributes for the polygon vertices.

Polygon#withLines

Boolean

Defined in src/options.js:2452

Is the polygon bordered by lines?

Default: true

precision

Number

Defined in src/options.js:2983

The precision of the tape measure value displayed in the optional text.

Default: 2

precision

Number

Defined in src/options.js:2732

The precision of the slider value displayed in the optional text.

Default: 2

PrescribedAngle#anglepoint

Point

Defined in src/options.js:2512

Attributes for the helper point of the prescribed angle.

RegularPolygon#borders

Line

Defined in src/options.js:2556

Attributes for the polygon border lines.

RegularPolygon#hasInnerPoints

Boolean

Defined in src/options.js:2533

If true, moving the mouse over inner points triggers hasPoint.

Default: false

See also:

RegularPolygon#vertices

Point

Defined in src/options.js:2573

Attributes for the polygon vertices.

RegularPolygon#withLines

Boolean

Defined in src/options.js:2547

Is the polygon bordered by lines?

Default: true

Sector#anglepoint

Point

Defined in src/options.js:2659

Attributes for helper point anglepoint.

Sector#arc

Arc

Defined in src/options.js:2626

Attributes for sub-element arc.

Sector#center

Point

Defined in src/options.js:2648

Attributes for helper point center.

Sector#label

Label

Defined in src/options.js:2670

Attributes for the sector label.

Sector#radiuspoint

Point

Defined in src/options.js:2637

Attributes for helper point radiuspoint.

Semicircle#midpoint

Point

Defined in src/options.js:2700

Attributes for center point of the semicircle.

Slider#baseline

Line

Defined in src/options.js:2811

Attributes for the base line of the slider.

Slider#highline

Line

Defined in src/options.js:2848

Attributes for the highlighting line of the slider.

Slider#label

Label

Defined in src/options.js:2862

Attributes for the slider label.

Slider#point1

Point

Defined in src/options.js:2781

Attributes for first (left) helper point defining the slider position.

Slider#point2

Point

Defined in src/options.js:2796

Attributes for second (right) helper point defining the slider position.

Slider#size

Number

Defined in src/options.js:2771

Size of slider point.

Default: 6

See also:

  • Point#size

Slider#ticks

Ticks

Defined in src/options.js:2826

Attributes for the ticks of the base line of the slider.

Slider#withLabel

Boolean

Defined in src/options.js:2753

Show slider label.

Default: true

Slider#withTicks

Boolean

Defined in src/options.js:2744

Show slider ticks.

Default: true

Slopetriangle#baseline

Line

Defined in src/options.js:2898

Attributes for the base line.

Slopetriangle#basepoint

Point

Defined in src/options.js:2910

Attributes for the base point.

Slopetriangle#glider

Point

Defined in src/options.js:2886

Attributes for the gliding helper point.

Slopetriangle#label

Label

Defined in src/options.js:2934

Attributes for the slope triangle label.

Slopetriangle#toppoint

Point

Defined in src/options.js:2922

Attributes for the top point.

snapSizeX

Number

Defined in src/options.js:3235

Defines together with undefined 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.

Default: 1

See also:

  • JXG.Point#snapToGrid
  • Text#snapSizeY
  • JXG.Board#defaultAxes

snapSizeY

Number

Defined in src/options.js:3252

Defines together with undefined 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.

Default: 1

See also:

  • JXG.Point#snapToGrid
  • Text#snapSizeX
  • JXG.Board#defaultAxes

snapWidth

Number

Defined in src/options.js:2722

The slider only returns integer multiples of this value, e.g. for discrete values set this property to 1. For continuous results set this to -1.

Tapemeasure#label

Label

Defined in src/options.js:3052

Attributes for the tape measure label.

Tapemeasure#point1

Point

Defined in src/options.js:2992

Attributes for first helper point defining the tape measure position.

Tapemeasure#point2

Point

Defined in src/options.js:3012

Attributes for second helper point defining the tape measure position.

Tapemeasure#ticks

Ticks

Defined in src/options.js:3032

Attributes for the ticks of the tape measure.

Tapemeasure#withLabel

Boolean

Defined in src/options.js:2974

Show tape measure label.

Default: true

Tapemeasure#withTicks

Boolean

Defined in src/options.js:2965

Show tape measure ticks.

Default: true

Text#dragArea

String

Defined in src/options.js:3210

Sensitive area for dragging the text. Possible values are 'all', or something else. This may be extended to left, right, ... in the future.

Default: 'all'

Text#rotate

Number

Defined in src/options.js:3223

Text rotation in degrees. Works for non-zero values only in combination with display=='internal'.

Default: 0

Ticks#anchor

String

Defined in src/options.js:730

Determine the position of the tick with value 0. 'left' means point1 of the line, 'right' means point2, and 'middle' is equivalent to the midpoint of the defining points. This attribute is ignored if the parent line is of type axis and is parallel to either the x (i.e. y = 0) or the y (i.e. x = 0) axis.

Default: 'left'

Ticks#drawLabels

Boolean

Defined in src/options.js:709

Draw labels yes/no

Default: false

Ticks#drawZero

Boolean

Defined in src/options.js:741

Draw the zero tick, that lies at line.point1?

Default: false

Ticks#generateLabelText

Function

Defined in src/options.js:690

A function that expects two JXG.Coords, the first one representing the coordinates of the tick that is to be labeled, the second one the coordinates of the center (the tick with position 0).

Ticks#generateLabelValue

Function deprecated

Defined in src/options.js:699

Deprecated: Use {@link JGX.Options@generateLabelValue}

A function that expects two JXG.Coords, the first one representing the coordinates of the tick that is to be labeled, the second one the coordinates of the center (the tick with position 0).

Ticks#includeBoundaries

Boolean

Defined in src/options.js:893

Whether line boundaries should be counted or not in the lower and upper bounds when creating ticks.

Default: false

Ticks#insertTicks

Boolean

Defined in src/options.js:750

If the distance between two ticks is too big we could insert new ticks. If insertTicks is true, we'll do so, otherwise we leave the distance as is. This option is ignored if equidistant is false. In the example below the distance between two ticks is given as 1 but because insertTicks is set to true many ticks will be omitted in the rendering process to keep the display clear.

Default: false

See also:

  • Ticks#equidistant
  • Ticks#minTicksDistance

Example:

// Create an axis providing two coord pairs. var p1 = board.create('point', [0, 0]); var p2 = board.create('point', [50, 25]); var l1 = board.create('line', [p1, p2]); var t = board.create('ticks', [l1, 1], { insertTicks: true, majorHeight: -1, label: { offset: [4, -9] }, drawLabels: true });

Ticks#labels

Array

Defined in src/options.js:846

User defined labels for special ticks. Instead of the i-th tick's position, the i-th string stored in this array is shown. If the number of strings in this array is less than the number of special ticks, the tick's position is shown as a fallback.

Default: []

Ticks#majorHeight

Number

Defined in src/options.js:798

Total height of a major tick. If negative the full height of the board is taken.

Default: 10

Ticks#maxLabelLength

Number

Defined in src/options.js:857

The maximum number of characters a tick label can use.

Default: 5

See also:

  • Ticks#precision

Ticks#minorHeight

Number

Defined in src/options.js:789

Total height of a minor tick. If negative the full height of the board is taken.

Default: 4

Ticks#minorTicks

Number

Defined in src/options.js:818

The number of minor ticks between two major ticks.

Default: 4

Ticks#precision

Number

Defined in src/options.js:867

If a label exceeds undefined this determines the precision used to shorten the tick label.

Default: 3

See also:

  • Ticks#maxLabelLength

Ticks#scale

Number

Defined in src/options.js:826

Scale the ticks but not the tick labels.

Default: 1

See also:

  • Ticks#scaleSymbol

Ticks#scaleSymbol

String

Defined in src/options.js:835

A string that is appended to every tick, used to represent the scale factor given in undefined.

Default: ''

See also:

  • Ticks#scale

Ticks#tickEndings

Array

Defined in src/options.js:807

Decides in which direction finite ticks are visible. Possible values are 0=false or 1=true. In case of [0,1] the tick is only visible to the right of the line. In case of [1,0] the tick is only visible to the left of the line.

Default: [1, 1]

Ticks#ticksDistance

Number

Defined in src/options.js:877

The default distance between two ticks. Please be aware that this value does not have to be used if undefined is set to true.

Default: 1

See also:

  • Ticks#equidistant
  • Ticks#insertTicks

Ticks#useUnicodeMinus

Boolean

Defined in src/options.js:720

Use the unicode character 0x2212, i.e. the HTML entity − as minus sign. That is −1 instead of -1.

Default: true

Turtle#arrow

Curve

Defined in src/options.js:3313

Attributes for the turtle arrow.

useASCIIMathML

Boolean

Defined in src/options.js:3128

If true the input will be given to ASCIIMathML before rendering.

Default: false

useCaja

Boolean

Defined in src/options.js:3103

If set to true and caja's sanitizeHTML function can be found it will be used to sanitize text output.

Default: false

useMathJax

Boolean

Defined in src/options.js:3138

If true MathJax will be used to render the input string.

Default: false