Displays text. Can set attributes font, fillStyle, textAlign, and textBaseline.

Implements

Constructors

  • Parameters

    • Optional opt_text: string

      the text to display (default is empty string)

    • Optional opt_position: Vector

      the position in simulation coords to display the text (default is origin)

    • Optional proto: null | DisplayText

      the prototype DisplayText to inherit properties from

    Returns DisplayText

Properties

fillStyle_: undefined | string

The color used when drawing the text, a CSS3 color value.

font_: undefined | string

The font used when drawing the text, a CSS3 font specification.

textAlign_: undefined | string

The horizontal alignment of text; legal values are 'left', 'center', 'right', 'start' and 'end'.

textBaseline_: undefined | string

The vertical alignment of text; legal values are 'top', 'middle', 'bottom', 'alphabetic', 'hanging', and 'ideographic'.

Methods

  • Whether the DisplayObject contains the given world coordinates point.

    Parameters

    • _p_world: Vector

      the point in world coordinates

    Returns boolean

    true if this DisplayObject contains the given point

  • Draws this DisplayObject using the given CoordMap.

    Parameters

    • context: CanvasRenderingContext2D

      the canvas's context to draw this object into

    • map: CoordMap

      the mapping to use for translating between simulation and screen coordinates

    Returns void

  • The horizontal alignment of text; allowed values are 'left', 'center', 'right', 'start' and 'end'.

    Returns string

  • The vertical alignment of text; allowed values are 'top', 'middle', 'bottom', 'alphabetic', 'hanging', and 'ideographic'.

    Returns string

  • Sets the z-index which specifies front-to-back ordering of objects; objects with a higher zIndex are drawn over (in front of) objects with a lower zIndex.

    Returns number

    the zIndex of this DisplayObject

  • Sets whether this DisplayObject is currently dragable; has no effect on objects that are not dragable.

    Parameters

    • dragable: boolean

      whether this DisplayObject should be dragable

    Returns void

  • Sets this DisplayObject's position in simulation coordinates of the containing SimView. Each type of DisplayObject has a different policy regarding whether this will have an effect. Generally the policies are:

    • If the DisplayObject does not represent a SimObject, then the position can be set. Examples are DisplayClock, EnergyBarGraph.

    • If the SimObject's position is dependent on other objects, then the position cannot be set. Examples are DisplayConnector, DisplayRope, DisplaySpring.

    • If the SimObject can be moved independently and isDragable is true, then the position of the SimObject is modified. Example: DisplayShape.

    Parameters

    • position: GenericVector

      this DisplayObject's position, in simulation coordinates.

    Returns void

  • The horizontal alignment of text; allowed values are 'left', 'center', 'right', 'start' and 'end'.

    Parameters

    • value: undefined | string

    Returns DisplayText

    this object for chaining setters

  • The vertical alignment of text; allowed values are 'top', 'middle', 'bottom', 'alphabetic', 'hanging', and 'ideographic'.

    Parameters

    • value: undefined | string

    Returns DisplayText

    this object for chaining setters

  • Sets the z-index which specifies front-to-back ordering of objects; objects with a higher zIndex are drawn over objects with a lower zIndex. Default is zero.

    Parameters

    • Optional zIndex: number

      the zIndex of this DisplayObject

    Returns void

  • Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

    For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:

    DisplayShape{polygon:Polygon{'chain3'}}
    

    Returns string

    a minimal string representation of this object.

Generated using TypeDoc