Class JXG.Ticks

JXG.GeometryElement
↳ JXG.Ticks

Ticks provides methods for creation and management of ticks on an axis.

Defined in: ticks.js.
Extends JXG.GeometryElement.

Class Summary
Constructor Attributes	Constructor Name and Description
	JXG.Ticks(line, ticks, attributes) Creates ticks for an axis.

Attributes Summary
Field Attributes	Field Name and Description
	anchor Determine the position of the tick with value 0.
	drawLabels Draw labels yes/no
	drawZero Draw the zero tick, that lies at line.point1?
	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).
	includeBoundaries Whether line boundaries should be counted or not in the lower and upper bounds when creating ticks.
	insertTicks If the distance between two ticks is too big we could insert new ticks.
	labels User defined labels for special ticks.
	majorHeight Total height of a major tick.
	maxLabelLength The maximum number of characters a tick label can use.
	minorHeight Total height of a minor tick.
	minorTicks The number of minor ticks between two major ticks.
	precision If a label exceeds JXG.Ticks#maxLabelLength this determines the precision used to shorten the tick label.
	scale Scale the ticks but not the tick labels.
	scaleSymbol A string that is appended to every tick, used to represent the scale factor given in JXG.Ticks#scaleSymbol.
	tickEndings Decides in which direction finite ticks are visible.
	ticksDistance The default distance between two ticks.

Field Summary
Field Attributes	Field Name and Description
	board The board the ticks line is drawn on.
	equidistant Equidistant ticks.
	fixedTicks Array of fixed ticks.
	labelCounter To ensure the uniqueness of label ids this counter is used.
	labelsRepo A list of labels that are currently unused and ready for reassignment.
	line The line the ticks belong to.
	minTicksDistance Least distance between two ticks, measured in pixels.
	ticks Stores the ticks coordinates
	ticksDelta Distance between two major ticks in user coordinates
	ticksFunction A function calculating ticks delta depending on the ticks number.

Method Summary
Method Attributes	Method Name and Description
<private>	adjustTickDistance(ticksDelta, distScr, coordsZero, deltas) Auxiliary method used by JXG.Ticks#generateEquidistantTicks to adjust the distance between two ticks depending on JXG.Ticks#minTicksDistance value
<private>	calculateTicksCoordinates() (Re-)calculates the ticks coordinates.
<private>	generateEquidistantTicks(coordsZero, bounds) Creates ticks coordinates and labels automatically.
<private>	generateFixedTicks(coordsZero, bounds) Creates ticks coordinates and labels based on JXG.Ticks#fixedTicks and JXG.Ticks#labels.
<private>	generateLabel(labelText, tick, tickNumber) Create a tick label
<private>	generateLabelText(tick, zero, value) Creates the label text for a given tick.
<private>	getDistanceFromZero(zero, point) Calculates the distance in user coordinates from zero to a given point including its sign
<private>	getLowerAndUpperBounds(coordsZero) Calculate the lower and upper bounds for tick rendering If JXG.Ticks#includeBoundaries is false, the boundaries will exclude point1 and point2
<private>	getXandYdeltas() Calculates the x and y distance between two major ticks
<private>	getZeroCoordinates() Returns the coordinates of the point zero of the line.
	hasPoint(x, y) Checks whether (x,y) is near the line.
<private>	processTickPosition(coordsZero, tickPosition, ticksDelta, deltas) Auxiliary method used by JXG.Ticks#generateEquidistantTicks to create a tick in the line at the given tickPosition.
<private>	removeTickLabels() Removes the HTML divs of the tick labels before repositioning
	setPositionDirectly(method, coords, oldcoords) Sets x and y coordinate of the tick.
<private>	setTicksSizeVariables() Sets the variables used to set the height and slope of each tick.
	update() Recalculate the tick positions and the labels.
	updateRenderer() Uses the boards renderer to update the arc.

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.Ticks(line, ticks, attributes)

Creates ticks for an axis.

Parameters:
{JXG.Line} line: Reference to the axis the ticks are drawn on.
{Number|Array} ticks: Number defining the distance between two major ticks or an array defining static ticks.
{Object} attributes: Properties

See:: JXG.Line#addTicks

Attribute Detail

{String} anchor

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.
Defined in: options.js.

Default Value:: 'left'

{Boolean} drawLabels

Draw labels yes/no
Defined in: options.js.

Default Value:: false

{Boolean} drawZero

Draw the zero tick, that lies at line.point1?
Defined in: options.js.

Default Value:: false

{function} 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).
Defined in: options.js.

{Boolean} includeBoundaries

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

Default Value:: false

{Boolean} insertTicks

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.
Defined in: options.js.

// 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
 });

See:: JXG.Ticks#equidistant; JXG.Ticks#minTicksDistance

Default Value:: false

{Array} labels

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.
Defined in: options.js.

Default Value:: []

{Number} majorHeight

Total height of a major tick. If negative the full height of the board is taken.
Defined in: options.js.

{Number} maxLabelLength

The maximum number of characters a tick label can use.
Defined in: options.js.

See:: JXG.Ticks#precision

Default Value:: 3

{Number} minorHeight

Total height of a minor tick. If negative the full height of the board is taken.
Defined in: options.js.

{Number} minorTicks

The number of minor ticks between two major ticks.
Defined in: options.js.

{Number} precision

If a label exceeds JXG.Ticks#maxLabelLength this determines the precision used to shorten the tick label.
Defined in: options.js.

See:: JXG.Ticks#maxLabelLength

Default Value:: 3

{Number} scale

Scale the ticks but not the tick labels.
Defined in: options.js.

See:: JXG.Ticks#scaleSymbol

Default Value:: 1

{String} scaleSymbol

A string that is appended to every tick, used to represent the scale factor given in JXG.Ticks#scaleSymbol.
Defined in: options.js.

See:: JXG.Ticks#scale

Default Value:: ''

{Array} tickEndings

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.
Defined in: options.js.

{Number} ticksDistance

The default distance between two ticks. Please be aware that this value does not have to be used if JXG.Ticks#insertTicks is set to true.
Defined in: options.js.

See:: JXG.Ticks#equidistant; JXG.Ticks#insertTicks

Default Value:: 1

Field Detail

{JXG.Board} board

The board the ticks line is drawn on.

{Boolean} equidistant

Equidistant ticks. Distance is defined by ticksFunction

{Array} fixedTicks

Array of fixed ticks.

labelCounter

To ensure the uniqueness of label ids this counter is used.

labelsRepo

A list of labels that are currently unused and ready for reassignment.

{JXG.Line} line

The line the ticks belong to.

{int} minTicksDistance

Least distance between two ticks, measured in pixels.

ticks

Stores the ticks coordinates

ticksDelta

Distance between two major ticks in user coordinates

{Function} ticksFunction

A function calculating ticks delta depending on the ticks number.

Method Detail

<private> adjustTickDistance(ticksDelta, distScr, coordsZero, deltas)

Auxiliary method used by JXG.Ticks#generateEquidistantTicks to adjust the distance between two ticks depending on JXG.Ticks#minTicksDistance value

Parameters:
{Number} ticksDelta: distance between two major ticks in user coordinates
{Number} distScr: distance between two major ticks in screen coordinates
{JXG.Coords} coordsZero: coordinates of the point considered zero
{Object} deltas: x and y distance between two major ticks

<private> calculateTicksCoordinates()

(Re-)calculates the ticks coordinates.

<private> generateEquidistantTicks(coordsZero, bounds)

Creates ticks coordinates and labels automatically. The frequency of ticks is affected by the values of JXG.Ticks#insertTicks and JXG.Ticks#ticksDistance

Parameters:
{JXG.Coords} coordsZero: coordinates of the point considered zero
{Object} bounds: contains the lower and upper boundaries for ticks placement

<private> generateFixedTicks(coordsZero, bounds)

Creates ticks coordinates and labels based on JXG.Ticks#fixedTicks and JXG.Ticks#labels.

Parameters:
{JXG.Coords} coordsZero: Coordinates of the point considered zero
{Object} bounds: contains the lower and upper boundaries for ticks placement

<private> {JXG.Text} generateLabel(labelText, tick, tickNumber)

Create a tick label

Parameters:
{String} labelText
{JXG.Coords} tick
{Number} tickNumber

Returns:: {JXG.Text}

<private> {String} generateLabelText(tick, zero, value)

Creates the label text for a given tick. A value for the text can be provided as a number or string

Parameters:
{JXG.Coords} tick: The Coords of the tick to create a label for
{JXG.Coords} zero: The Coords of line's zero
{Number|String} value: A predefined value for this tick

Returns:: {String}

<private> {Number} getDistanceFromZero(zero, point)

Calculates the distance in user coordinates from zero to a given point including its sign

Parameters:
{JXG.Coords} zero: coordinates of the point considered zero
{JXG.Coords} point: coordinates of the point to find out the distance

Returns:: {Number} distance between zero and point, including its sign

<private> {Object} getLowerAndUpperBounds(coordsZero)

Calculate the lower and upper bounds for tick rendering If JXG.Ticks#includeBoundaries is false, the boundaries will exclude point1 and point2

Parameters:
{JXG.Coords} coordsZero

Returns:: {Object} contains the lower and upper bounds

<private> {Object} getXandYdeltas()

Calculates the x and y distance between two major ticks

Returns:: {Object}

<private> {JXG.Coords} getZeroCoordinates()

Returns the coordinates of the point zero of the line. If the line is an Axis, the coordinates of the projection of the board's zero point is returned Otherwise, the coordinates of the point that acts as zero are established depending on the value of JXG.Ticks#anchor

Returns:: {JXG.Coords} Coords object for the Zero point on the line

{Boolean} hasPoint(x, y)

Checks whether (x,y) is near the line.

Parameters:
{Number} x: Coordinate in x direction, screen coordinates.
{Number} y: Coordinate in y direction, screen coordinates.

Returns:: {Boolean} True if (x,y) is near the line, False otherwise.

<private> processTickPosition(coordsZero, tickPosition, ticksDelta, deltas)

Auxiliary method used by JXG.Ticks#generateEquidistantTicks to create a tick in the line at the given tickPosition.

Parameters:
{JXG.Coords} coordsZero: coordinates of the point considered zero
{Number} tickPosition: current tick position relative to zero
{Number} ticksDelta: distance between two major ticks in user coordinates
{Object} deltas: x and y distance between two major ticks

<private> removeTickLabels()

Removes the HTML divs of the tick labels before repositioning

{JXG.Ticks} setPositionDirectly(method, coords, oldcoords)

Sets x and y coordinate of the tick.

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
{Array} oldcoords: previous coordinates in screen/user units

Returns:: {JXG.Ticks} this element

<private> setTicksSizeVariables()

Sets the variables used to set the height and slope of each tick.

{JXG.Ticks} update()

Recalculate the tick positions and the labels.

Returns:: {JXG.Ticks}

{JXG.Ticks} updateRenderer()

Uses the boards renderer to update the arc.

Returns:: {JXG.Ticks}

JSXGraph Reference

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.

Elements

Classes

Class JXG.Ticks