API Docs for: 0.99.4
Show:

Hatch Class

PSEUDO

Extends JXG.Ticks
Module: JXG

Hashes can be used to mark congruent lines.

Constructor

Hatch

(
  • line,numberofhashes
)

Parameters:

  • line,numberofhashes JXG.Line,Number

    The parents consist of the line the hatch marks are going to be attached to and the number of dashes.

Throws:

Exception:

If the element cannot be constructed with the given parent objects an exception is thrown.

Example:

 // Create an axis providing two coord pairs.
          var p1 = board.create('point', [0, 3]);
           var p2 = board.create('point', [1, 3]);
            var l1 = board.create('line', [p1, p2]);
         var t = board.create('hatch', [l1, 3]);
        

Item Index

Methods

_set

(
  • property
  • value
)
private chainable

Sets the value of property property to value.

Parameters:

  • property String

    The property's name.

  • value Object

    The new value

addChild

(
  • obj
)
chainable

Add an element as a child to the current element. Can be used to model dependencies between geometry elements.

Parameters:

addDescendants

(
  • obj
)
private chainable

Adds the given object to the descendants list of this object and all its child objects.

Parameters:

addParents

(
  • parents
)
JXG.Object chainable

Adds ids of elements to the array this.parents. This method needs to be called if some dependencies can not be detected automatically by JSXGraph. For example if a function graph is given by a function which referes to coordinates of a point, calling addParents() is necessary.

Parameters:

  • parents Array

    Array of elements or ids of elements. Alternatively, one can give a list of objects as parameters.

Returns:

JXG.Object:

reference to the object itself.

Example:

// Movable function graph
                    var A = board.create('point', [1, 0], {name:'A'}),
                        B = board.create('point', [3, 1], {name:'B'}),
                        f = board.create('functiongraph', function(x) {
                                 var ax = A.X(),
                                     ay = A.Y(),
                                     bx = B.X(),
                                     by = B.Y(),
                                    a = (by - ay) / ( (bx - ax) * (bx - ax) );
                                 return a * (x - ax) * (x - ax) + ay;
                             }, {fixed: false});
                    f.addParents([A, B]);
                    

addRotation

(
  • angle
)
chainable

Rotate texts or images by a given degree. Works only for texts where JXG.Text#display equal to "internal".

Parameters:

  • angle Number

    The degree of the rotation (90 means vertical text).

See also:

  • JXG.GeometryElement#rotate

addTransform

(
  • transform
)
JXG.GeometryElement chainable

Add transformations to this element.

Parameters:

  • transform JXG.Transformation | Array

    Either one {@link JXG.Transformation} or an array of {@link JXG.Transformation}s.

Returns:

JXG.GeometryElement:

Reference to the element.

adjustTickDistance

(
  • ticksDelta
  • coordsZero
  • deltas
  • bounds
)
Number private

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

Parameters:

  • ticksDelta Number

    distance between two major ticks in user coordinates

  • coordsZero JXG.Coords

    coordinates of the point considered zero

  • deltas Object

    x and y distance in pixel between two user units

  • bounds Object

    upper and lower bound of the tick positions in user units.

Returns:

Number:

returns the new value of ticksDelta

animate

(
  • hash
  • time
  • [options]
)
JXG.GeometryElement chainable

Animates properties for that object like stroke or fill color, opacity and maybe even more later.

Parameters:

  • hash Object

    Object containing properties with target values for the animation.

  • time Number

    Number of milliseconds to complete the animation.

  • [options] Object optional

    Optional settings for the animation:

    • callback: A function that is called as soon as the animation is finished.

Returns:

JXG.GeometryElement:

A reference to the object

bounds

() Array

Dimensions of the smallest rectangle enclosing the element.

Returns:

Array:

The coordinates of the enclosing rectangle in a format like the bounding box in {@link JXG.Board#setBoundingBox}.

calculateTicksCoordinates

() JXG.Ticks private chainable

(Re-)calculates the ticks coordinates.

Returns:

JXG.Ticks:

this element

clearTrace

() chainable

Removes all objects generated by the trace function.

cloneToBackground

() chainable

Copy the element to background. This is used for tracing elements.

countChildren

() Number private

Counts the direct children of an object without counting labels.

Returns:

Number:

Number of children

createGradient

() private chainable

Creates a gradient nodes in the renderer.

See also:

  • JXG.SVGRenderer#setGradient

createLabel

() chainable

Creates a label element for this geometry element.

See also:

  • #addLabelToElement

dash

(
  • d
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1703

Deprecated: Use {@link #setAttribute}

Set the dash type of an element

Parameters:

  • d Number

    Integer which determines the way of dashing an element's outline.

See also:

draggable

() Boolean private

Decides whether an element can be dragged. This is used in JXG.GeometryElement#setPositionDirectly methods where all parent elements are checked if they may be dragged, too.

Returns:

fillColor

(
  • fColor
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1657

Deprecated: Use {@link #setAttribute}

Set the fillColor of an element

Parameters:

  • fColor String

    String which determines the fill color of an object.

See also:

generateEquidistantTicks

(
  • coordsZero
  • bounds
)
JXG.Ticks private chainable

Creates ticks coordinates and labels automatically. The frequency of ticks is affected by the values of undefined and undefined

Parameters:

  • coordsZero JXG.Coords

    coordinates of the point considered zero

  • bounds Object

    contains the lower and upper boundaries for ticks placement

Returns:

JXG.Ticks:

this element

generateFixedTicks

(
  • coordsZero
  • bounds
)
JXG.Ticks private chainable

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

Parameters:

  • coordsZero JXG.Coords

    Coordinates of the point considered zero

  • bounds Object

    contains the lower and upper boundaries for ticks placement

Returns:

JXG.Ticks:

this element

generateLabel

(
  • labelText
  • tick
  • tickNumber
)
JXG.Text private

Create a tick label

Parameters:

Returns:

generateLabelText

(
  • tick
  • zero
  • value
)
String private

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

Parameters:

  • tick JXG.Coords

    The Coords-object of the tick to create a label for

  • zero JXG.Coords

    The Coords-object of line's zero

  • value Number | String

    A predefined value for this tick

Returns:

generatePolynomial

() Array

Array of strings containing the polynomials defining the element. Used for determining geometric loci the groebner way.

Returns:

Array:

An array containing polynomials describing the locus of the current object.

getAttribute

(
  • key
)

Get the value of the property key.

Parameters:

  • key String

    The name of the property you are looking for

Returns:

The value of the property

getAttributes

() Object

Retrieve a copy of the current visProp.

Returns:

getDistanceFromZero

(
  • zero
  • point
)
Number private

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

Parameters:

  • zero JXG.Coords

    coordinates of the point considered zero

  • point JXG.Coords

    coordinates of the point to find out the distance

Returns:

Number:

distance between zero and point, including its sign

getLabelAnchor

() JXG.Coords

Returns the coords object where the label of the element shall be drawn. Differs in some cases from the values that getTextAnchor returns.

Returns:

JXG.Coords:

JXG.Coords Place where the text shall be drawn.

See also:

getLowerAndUpperBounds

(
  • coordsZero
)
Object private

Calculate the lower and upper bounds for tick rendering If undefined is false, the boundaries will exclude point1 and point2

Parameters:

Returns:

Object:

contains the lower and upper bounds

getName

() String

Returns the elements name, used in JessieCode.

Returns:

getParents

() Array

List of the element ids resp. values used as parents in JXG.Board#create.

Returns:

getProperty

() deprecated

Inherited from JXG.GeometryElement: src/base/element.js:1237

Deprecated: Use {@link JXG.GeometryElement#getAttribute}.

Deprecated alias for JXG.GeometryElement#getAttribute.

getTextAnchor

() JXG.Coords

Returns the coords object where a text that is bound to the element shall be drawn. Differs in some cases from the values that getLabelAnchor returns.

Returns:

JXG.Coords:

JXG.Coords Place where the text shall be drawn.

See also:

getTpye

() String

The type of the element as used in JXG.Board#create.

Returns:

getXandYdeltas

() Object private

Calculates the x and y distance in pixel between two units in user space.

Returns:

Object:

Object of the from

    {
                            x: Number,
                            y: Number
                        }

getZeroCoordinates

() JXG.Coords private

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 undefined

Returns:

JXG.Coords:

Coords object for the Zero point on the line

handleSnapToGrid

(
  • force
)
JXG.GeometryElement chainable

Move an element to its nearest grid point. The function uses the coords object of the element as its actual position. If there is no coords object, nothing is done.

Parameters:

  • force Boolean

    force snapping independent from what the snaptogrid attribute says

Returns:

JXG.GeometryElement:

Reference to this element

hasPoint

(
  • x
  • y
)
Boolean

Inherited from JXG.GeometryElement but overwritten in src/base/ticks.js:223

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

Parameters:

  • x Number

    Coordinate in x direction, screen coordinates.

  • y Number

    Coordinate in y direction, screen coordinates.

Returns:

Boolean:

True if (x,y) is near the line, False otherwise.

hideElement

() chainable

Hide the element. It will still exist but not visible on the board.

highlight

(
  • [force=false]
)
chainable

Highlights the element.

Parameters:

  • [force=false] Boolean optional

    Force the highlighting

highlightFillColor

(
  • fColor
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1673

Deprecated: Use {@link #setAttribute}

Set the highlightFillColor of an element

Parameters:

  • fColor String

    String which determines the fill color of an object when its highlighted.

See also:

highlightStrokeColor

(
  • sColor
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1611

Deprecated: Use {@link #setAttribute}

Set the highlightStrokeColor of an element

Parameters:

  • sColor String

    String which determines the stroke color of an object when its highlighted.

See also:

labelColor

(
  • lColor
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1688

Deprecated: Use {@link #setAttribute}

Set the labelColor of an element

Parameters:

  • lColor String

    String which determines the text color of an object's label.

See also:

makeTicksFunction

(
  • ticks
)
Function private

Ticks function: determines the distance (in user units) of two major ticks. See above in constructor and in @see JXG.GeometryElement#setAttribute

Parameters:

  • ticks Number

    Distance between two major ticks

Returns:

Function:

returns method ticksFunction

noHighlight

() chainable

Uses the "normal" properties of the element.

normalize

() private chainable

Normalize the element's standard form.

prepareUpdate

() private chainable

Notify all child elements for updates.

processTickPosition

(
  • coordsZero
  • tickPosition
  • ticksDelta
  • deltas
)
JXG.Ticks private chainable

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

Parameters:

  • coordsZero JXG.Coords

    coordinates of the point considered zero

  • tickPosition Number

    current tick position relative to zero

  • ticksDelta Number

    distance between two major ticks in user coordinates

  • deltas Object

    x and y distance between two major ticks

Returns:

JXG.Ticks:

this element

remove

() chainable

Removes the element from the construction. This only removes the SVG or VML node of the element and its label (if available) from the renderer, to remove the element completely you should use JXG.Board#removeObject.

removeChild

(
  • obj
)
chainable

Remove an element as a child from the current element.

Parameters:

removeDescendants

(
  • obj
)
private chainable

Removes the given object from the descendants list of this object and all its child objects.

Parameters:

removeTickLabels

() JXG.Ticks private chainable

Removes the HTML divs of the tick labels before repositioning

Returns:

JXG.Ticks:

this element

resolveShortcuts

(
  • properties
)
Object

Resolves property shortcuts like color and expands them, e.g. strokeColor and fillColor. Writes the expanded properties back to the given properties.

Parameters:

Returns:

Object:

The given parameter with shortcuts expanded.

setArrow

(
  • firstArrow
  • lastArrow
)
chainable

Determines whether the element has arrows at start or end of the arc.

Parameters:

  • firstArrow Boolean

    True if there is an arrow at the start of the arc, false otherwise.

  • lastArrow Boolean

    True if there is an arrow at the end of the arc, false otherwise.

setAttribute

(
  • attributes
)
chainable

Sets an arbitrary number of attributes.

Parameters:

  • attributes Object

    An object with attributes.

Example:

// Set property directly on creation of an element using the attributes object parameter
                    var board = JXG.JSXGraph.initBoard('jxgbox', {boundingbox: [-1, 5, 5, 1]};
                    var p = board.create('point', [2, 2], {visible: false});
                    
                    // Now make this point visible and fixed:
                    p.setAttribute({
                        fixed: true,
                        visible: true
                    });

setDash

(
  • dash
)
private chainable

Set the dash style of an object. See undefined for a list of available dash styles. You should use undefined instead of this method.

Parameters:

  • dash Number

    Indicates the new dash style

setLabel

(
  • str
)
chainable

Sets a label and it's text If label doesn't exist, it creates one

Parameters:

setLabelText

(
  • str
)
chainable

Updates the element's label text, strips all html.

Parameters:

setName

(
  • str
)
chainable

Updates the element's label text and the element's attribute "name", strips all html.

Parameters:

setParents

(
  • parents
)
JXG.Object chainable

Sets ids of elements to the array this.parents. First, this.parents is cleared. See undefined.

Parameters:

  • parents Array

    Array of elements or ids of elements. Alternatively, one can give a list of objects as parameters.

Returns:

JXG.Object:

reference to the object itself.

setPosition

(
  • method
  • coords
)
JXG.GeometryElement chainable

Translates the object by (x, y). In case the element is defined by points, the defining points are translated, e.g. a circle constructed by a center point and a point on the circle line.

Parameters:

  • method Number

    The type of coordinates used here. Possible values are {@link JXG.COORDS_BY_USER} and {@link JXG.COORDS_BY_SCREEN}.

  • coords Array

    array of translation vector.

Returns:

JXG.GeometryElement:

Reference to the element object.

setPositionDirectly

(
  • method
  • coords
  • oldcoords
)
JXG.Ticks chainable

Inherited from JXG.GeometryElement but overwritten in src/base/ticks.js:273

Sets x and y coordinate of the tick.

Parameters:

  • method Number

    The type of coordinates used here. Possible values are {@link JXG.COORDS_BY_USER} and {@link JXG.COORDS_BY_SCREEN}.

  • coords Array

    coordinates in screen/user units

  • oldcoords Array

    previous coordinates in screen/user units

Returns:

JXG.Ticks:

this element

setProperty

() deprecated

Inherited from JXG.GeometryElement: src/base/element.js:1030

Deprecated: Use {@link JXG.GeometryElement#setAttribute}.

Deprecated alias for JXG.GeometryElement#setAttribute.

setTicksSizeVariables

() JXG.Ticks private chainable

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

Returns:

JXG.Ticks:

this element

shadow

(
  • s
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1733

Deprecated: Use {@link #setAttribute}

Set the shadow of an element

Parameters:

  • s Boolean

    Boolean which determines whether the element has a shadow or not.

See also:

showElement

() chainable

Make the element visible.

snapToGrid

() JXG.GeometryElement chainable

Snaps the element to the grid. Only works for points, lines and circles. Points will snap to the grid as defined in their properties undefined and undefined. Lines and circles will snap their parent points to the grid, if they have undefined set to true.

Returns:

JXG.GeometryElement:

Reference to the element.

snapToPoints

() JXG.GeometryElement chainable

Snaps the element to points. Only works for points. Points will snap to the next point as defined in their properties undefined and undefined. Lines and circles will snap their parent points to points.

Returns:

JXG.GeometryElement:

Reference to the element.

strokeColor

(
  • sColor
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1626

Deprecated: Use {@link #setAttribute}

Set the strokeColor of an element

Parameters:

  • sColor String

    String which determines the stroke color of an object.

See also:

strokeWidth

(
  • width
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1641

Deprecated: Use {@link #setAttribute}

Set the strokeWidth of an element

Parameters:

  • width Number

    Integer which determines the stroke width of an outline.

See also:

tickEndings

(
  • coords
  • major
)
Array private

Parameters:

  • coords JXG.Coords

    Coordinates of the tick on the line.

  • major Boolean

    True if tick is major tick.

Returns:

Array:

Array of length 3 containing start and end coordinates in screen coordinates of the tick (arrays of length 2). 3rd entry is true if major tick otherwise false. If the tick is outside of the canvas, the return array is empty.

toJSON

() private

EXPERIMENTAL. Generate JSON object code of visProp and other properties.

Returns:

JSON string containing element's properties.

update

() JXG.Ticks chainable

Inherited from JXG.GeometryElement but overwritten in src/base/ticks.js:954

Recalculate the tick positions and the labels.

Returns:

JXG.Ticks:

this element

updateRenderer

() private chainable

Provide updateRenderer method.

visible

(
  • v
)
deprecated chainable

Inherited from JXG.GeometryElement: src/base/element.js:1718

Deprecated: Use {@link #setAttribute}

Set the visibility of an element

Parameters:

  • v Boolean

    Boolean which determines whether the element is drawn.

See also:

Properties

_org_type

Number final

Original type of the element at construction time. Used for removing glider property.

_pos

Number private

The position of this element inside the undefined.

Default: -1

ancestors

Object

Elements on which this element depends on are stored here.

baseElement

JXG.GeometryElement private

Default: null

board

JXG.Board

Inherited from JXG.GeometryElement but overwritten in src/base/ticks.js:84

The board the ticks line is drawn on.

childElements

Object

Stores all dependent objects to be updated when this point is moved.

descendants

Object

Elements depending on this element are stored here.

dump

Boolean

The element is saved with an explicit entry in the file (true) or implicitly via a composition.

Default: true

elementClass

Number final

The element's class.

elType

String

The string used with JXG.Board#create

equidistant

Boolean

Equidistant ticks. Distance is defined by ticksFunction

fixedTicks

Array

Array of fixed ticks.

hasLabel

Boolean

If element has a label subelement then this property will be set to true.

Default: false

highlighted

Boolean

True, if the element is currently highlighted.

Default: false

id

String

Unique identifier for the element. Equivalent to id-attribute of renderer element.

isDraggable

Boolean

Controls if this element can be dragged. In GEONExT only free points and gliders can be dragged.

Default: false

isReal

Boolean

If element is in two dimensional real space this is true, else false.

Default: true

labelCounter

Number

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

labels

Array

Array where the labels are saved. There is an array element for every tick, even for minor ticks which don't have labels. In this case the array element contains just null.

labelsRepo

Array

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

lastDragTime

Date

Time stamp containing the last time this element has been dragged.

Default: creation time

line

JXG.Line

The line the ticks belong to.

methodMap

Object

The methodMap determines which methods can be called from within JessieCode and under which name it can be used. The map is saved in an object, the name of a property is the name of the method used in JessieCode, the value of a property is the name of the method in JavaScript.

minTicksDistance

Int

Least distance between two ticks, measured in pixels.

mouseover

Boolean

Is the mouse over this element?

Default: false

name

String

Not necessarily unique name for the element.

Default: Name generated by {@link JXG.Board#generateName}.

See also:

needsUpdate

Boolean

Controls if updates are necessary

Default: true

notExistingParents

Object

Stores all Intersection Objects which in this moment are not real and so hide this element.

numTraces

Number

Counts the number of objects drawn as part of the trace of the element.

See also:

parents

Object

Ids of elements on which this element depends directly are stored here.

quadraticform

Array

Quadratic form representation of circles (and conics)

Default: [[1,0,0],[0,1,0],[0,0,1]]

rendNode

Object

Stores the rendering node for the element.

stdform

Array

[c,b0,b1,a,k,r,q0,q1]

See A.E. Middleditch, T.W. Stacey, and S.B. Tor: "Intersection Algorithms for Lines and Circles", ACM Transactions on Graphics, Vol. 8, 1, 1989, pp 25-40.

The meaning of the parameters is: Circle: points p=[p0,p1] on the circle fulfill a<p,p> + <b,p> + c = 0 For convenience we also store r: radius k: discriminant = sqrt(<b,b>-4ac) q=[q0,q1] center

Points have radius = 0. Lines have radius = infinity. b: normalized vector, representing the direction of the line.

Should be put into Coords, when all elements possess Coords.

Default: [1, 0, 0, 0, 1, 1, 0, 0]

subs

Object

Subs contains the subelements, created during the create method.

symbolic

Object

Stores variables for symbolic computations

ticks

Array

Stores the ticks coordinates

ticksDelta

Number

Distance between two major ticks in user coordinates

ticksFunction

Function

A function calculating ticks delta depending on the ticks number.

traces

Object

Keeps track of all objects drawn as part of the trace of the element.

See also:

transformations

Array

Stores the transformations which are applied during update in an array

See also:

type

Number final

Type of the element.

visProp

Object

An associative array containing all visual properties.

Default: empty object

Events

attribute

Notify everytime an attribute is changed.

Event Payload:

  • o Object

    A list of changed attributes and their new value.

  • el Object

    Reference to the element

attribute:<attribute>

This is a generic event handler. It exists for every possible attribute that can be set for any element, e.g. if you want to be notified everytime an element's strokecolor is changed, is the event attribute:strokecolor.

Event Payload:

down

Whenever the user starts to touch or click an element.

Event Payload:

  • e Event

    The browser's event object.

drag

This event is fired whenever the user drags an element.

Event Payload:

  • e Event

    The browser's event object.

mousedown

Whenever the user starts to click an element.

Event Payload:

  • e Event

    The browser's event object.

mousedrag

This event is fired whenever the user drags the element with a mouse.

Event Payload:

  • e Event

    The browser's event object.

mousemove

This event is fired whenever the user is moving the mouse over an element.

Event Payload:

  • e Event

    The browser's event object.

mouseout

This event is fired whenever the user puts the mouse away from an element.

Event Payload:

  • e Event

    The browser's event object.

mouseover

This event is fired whenever the user puts the mouse over an element.

Event Payload:

  • e Event

    The browser's event object.

mouseup

Whenever the user releases the mousebutton over an element.

Event Payload:

  • e Event

    The browser's event object.

move

This event is fired whenever the user is moving over an element.

Event Payload:

  • e Event

    The browser's event object.

out

This event is fired whenever the user is leaving an element.

Event Payload:

  • e Event

    The browser's event object.

over

This event is fired whenever the user is hovering over an element.

Event Payload:

  • e Event

    The browser's event object.

touchdown

Whenever the user starts to touch an element.

Event Payload:

  • e Event

    The browser's event object.

touchdrag

This event is fired whenever the user drags the element on a touch device.

Event Payload:

  • e Event

    The browser's event object.

touchup

Whenever the user stops touching an element.

Event Payload:

  • e Event

    The browser's event object.

up

Whenever the user stops to touch or click an element.

Event Payload:

  • e Event

    The browser's event object.