GoJS API
/ to search
    Preparing search index...

    Class Spot

    GoJS® Diagramming Components
    version 4.0.0
    by Northwoods Software®

    A Spot represents a relative point from (0,0) to (1,1) within the bounds of a rectangular area plus an absolute offset.

    Use the static functions Spot.parse and Spot.stringify to convert to and from a standard string representation that is independent of the current locale.

    When an instance of this class is the value of a property of a GraphObject class or Diagram or CommandHandler or a Tool class, you should treat the object as if it were frozen or read-only -- you cannot modify its properties. This allows the property to return a value without allocating a new instance. If you need to do your own calculations with the value, call copy to make a new instance with the same values that you can modify.

    Many methods modify the object's properties and then return a reference to "this" object. The only instance methods to allocate a new Spot are the copy and opposite methods. The static Spot.parse method also allocates a new object.

    The "Debug" implementation of this class is significantly slower than the "Release" implementation, mostly due to additional error checking.

    You cannot inherit from this class.

    Index

    Constructors

    constructor

    Accessors

    offsetX offsetY x y

    Methods

    copy equals includesSide isDefault isNone isNoSpot isSide isSpot opposite set setTo parse stringify stringifyFixed

    Properties

    AllSides Bottom BottomCenter BottomLeft BottomLeftSides BottomRight BottomRightSides BottomSide Center Default Left LeftCenter LeftRightSides LeftSide MiddleBottom MiddleLeft MiddleRight MiddleTop None NotBottomSide NotLeftSide NotRightSide NotTopSide Right RightCenter RightSide Top TopBottomSides TopCenter TopLeft TopLeftSides TopRight TopRightSides TopSide

    Constructors

    • The default constructor produces the Spot(0, 0, 0, 0), at the top-left corner.

      Parameters

      • Optionalx: number

        The x value of the Spot. Default is zero.

      • Optionaly: number

        The y value of the Spot. Default is zero.

      • Optionaloffx: number

        (Optional) The absolute x offset. Default is zero.

      • Optionaloffy: number

        (Optional) The absolute y offset. Default is zero.

      Returns Spot

    Accessors

    • get offsetX(): number

      Gets or sets the offsetX value of the Spot. The value may be negative. If this represents a side value instead of a specific spot, this value is meaningless.

      A Spot(0,0,5,5) of a large rectangle is near the top-left corner, inside the rectangle. A Spot(1,1,5,5) would be near the bottom-right corner, outside the rectangle. A Spot(1,1,-5,-5) would also be near the bottom-right corner, but inside the rectangle.

      Returns number

    • get offsetY(): number

      Gets or sets the offsetY value of the Spot. The value may be negative. If this represents a side value instead of a specific spot, this value is meaningless.

      A Spot(0,0,5,5) of a large rectangle is near the top-left corner, inside the rectangle. A Spot(1,1,5,5) would be near the bottom-right corner, outside the rectangle. A Spot(1,1,-5,-5) would also be near the bottom-right corner, but inside the rectangle.

      Returns number

    • get x(): number

      Gets or sets the x value of the Spot, a fractional value between zero and one.

      The Spot(0,0) of a rectangle is at the top-left corner. This value is commonly available as Spot.TopLeft. The Spot(0.5,1) would be at the middle of the bottom side. That value is commonly available as Spot.MiddleBottom.

      Returns number

    • get y(): number

      Gets or sets the y value of the Spot, a fractional value between zero and one.

      The Spot(0,1) of a rectangle is at the bottom-left corner. This value is commonly available as Spot.BottomLeft. The Spot(1,0.5) would be at the middle of the right side. That value is commonly available as Spot.MiddleRight.

      Returns number

    Methods

    • Create a copy of this Spot, with the same values.

      Returns Spot

    • Two spots are equal if all four property values are the same.

      Parameters

      • spot: Spot

        The Spot to compare to the current Spot.

      Returns boolean

      True if the two spots are equal, false otherwise.

    • This predicate is true if this Spot is a side that includes the side(s) given by the argument Spot.

      Parameters

      Returns boolean

      false if either this Spot or the argument Spot is not a "Side"; true if the side(s) that this Spot represents are a superset or the same set of sides represented by the argument Spot.

    • True if this is a special spot indicating that the real spot value will come from another source.

      Returns boolean

    • True if this is a special spot referring to no particular spot point or side.

      Returns boolean

    • True if this is an unspecific special spot, such as Spot.None or Spot.Default or one of the side spots.

      Returns boolean

    • True if this is a special spot referring to one (or more) of the sides. This is false if the spot is Spot.None or if it is a spot point.

      Returns boolean

    • True if this is a specific spot point, not a side nor Spot.None.

      Returns boolean

    • Return a new spot that is opposite this spot. The X and Y values will be an equal distance away from the center on the other side of the center. The OffsetX and OffsetY values are also negated.

      The result is meaningless if isNoSpot is true.

      Returns Spot

    • Modify this Spot so that its X, Y, OffsetX, and OffsetY values are the same as the given Spot.

      Parameters

      • s: Spot

        the given Spot.

      Returns this

      this.

    • Modify this Spot with new X, Y, OffsetX, and OffsetY values.

      Parameters

      • x: number
      • y: number
      • offx: number
      • offy: number

      Returns this

      this.

    • This static function can be used to read in a Spot from a string that was produced by Spot.stringify.

      go.Spot.parse("0 1 2 3") produces the Spot new go.Spot(0, 1, 2, 3).

      Parameters

      • str: string

      Returns Spot

    • This static function can be used to write out a Spot as a string that can be read by Spot.parse.

      go.Spot.stringify(new go.Spot(0, 1, 2, 3)) produces the string "0 1 2 3".

      Parameters

      Returns string

    • This static function returns a function that can be used as a back converter for a Binding to write out a Spot's values as numbers with a fixed number of digits after the decimal point.

      This is useful for limiting the size of JSON output and making it more legible. It might also be useful for regression testing.

      Parameters

      • digits: number

        must be a non-negative integer

      Returns (val: Spot) => string

      a function that converts a Spot to a string without so many decimals

      since

      3.0

    Properties

    AllSides: Spot = ...

    The set of points on all sides of the bounding rectangle.

    Bottom: Spot = Spot.BottomCenter

    A synonym for Spot.BottomCenter.

    BottomCenter: Spot = ...

    The specific point at the middle of the bottom side of bounding rectangle.

    BottomLeft: Spot = ...

    The specific point at the bottom-left corner of the bounding rectangle.

    BottomLeftSides: Spot = ...

    The set of points at the left or bottom sides of the bounding rectangle.

    BottomRight: Spot = ...

    The specific point at the bottom-right corner of the bounding rectangle.

    BottomRightSides: Spot = ...

    The set of points at the right or bottom sides of the bounding rectangle.

    BottomSide: Spot = ...

    The set of points at the bottom side of the bounding rectangle.

    Center: Spot = ...

    The specific point at the very center of the bounding rectangle.

    Default: Spot = ...

    Use this value to indicate that the real spot value is inherited from elsewhere.

    Left: Spot = Spot.LeftCenter

    A synonym for Spot.LeftCenter.

    LeftCenter: Spot = ...

    The specific point at the middle of the left side of bounding rectangle.

    LeftRightSides: Spot = ...

    The set of points at the left or right sides of the bounding rectangle.

    LeftSide: Spot = ...

    The set of points at the left side of the bounding rectangle.

    MiddleBottom: Spot = Spot.BottomCenter

    A synonym for Spot.BottomCenter.

    MiddleLeft: Spot = Spot.LeftCenter

    A synonym for Spot.LeftCenter.

    MiddleRight: Spot = Spot.RightCenter

    A synonym for Spot.RightCenter.

    MiddleTop: Spot = Spot.TopCenter

    A synonym for Spot.TopCenter.

    None: Spot = ...

    Use this Spot value to indicate no particular spot -- code looking for a particular point on an element will need to do their own calculations to determine the desired point depending on the circumstances.

    NotBottomSide: Spot = ...

    The set of points on all sides of bounding rectangle except bottom side.

    NotLeftSide: Spot = ...

    The set of points on all sides of the bounding rectangle except left side.

    NotRightSide: Spot = ...

    The set of points on all sides of the bounding rectangle except right side.

    NotTopSide: Spot = ...

    The set of points on all sides of the bounding rectangle except top side.

    Right: Spot = Spot.RightCenter

    A synonym for Spot.RightCenter.

    RightCenter: Spot = ...

    The specific point at the middle of the right side of bounding rectangle.

    RightSide: Spot = ...

    The set of points at the right side of the bounding rectangle.

    Top: Spot = Spot.TopCenter

    A synonym for Spot.TopCenter.

    TopBottomSides: Spot = ...

    The set of points at the top or bottom sides of the bounding rectangle.

    TopCenter: Spot = ...

    The specific point at the center of the top side of the bounding rectangle.

    TopLeft: Spot = ...

    The specific point at the top-left corner of the bounding rectangle.

    TopLeftSides: Spot = ...

    The set of points at the top or left sides of the bounding rectangle.

    TopRight: Spot = ...

    The specific point at the top-right corner of the bounding rectangle.

    TopRightSides: Spot = ...

    The set of points at the top or right sides of the bounding rectangle.

    TopSide: Spot = ...

    The set of points at the top side of the bounding rectangle.

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    Properties