RevGrid - v0.10.0
    Preparing search index...

    Represents a rectangle with one corner designated as its first corner.

    • RevCornerRectangle
    • RevFirstCornerArea

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    firstCorner: CornerId

    The corner of the rectangle designated as its first corner.

    Accessors

    • get area(): number

      Area of this rectangle.

      Returns number

    • get exclusiveBottom(): number

      Exclusive bottom co-ordinate of rectangle. (inclusiveBottom + 1)

      Returns number

    • get exclusiveFirst(): RevPoint

      The exclusive first corner point in a rectangle.

      If the x and y coordinates respectively represent the right or bottom edge, the point is the first point outside the rectangle.

      Returns RevPoint

    • get exclusiveLast(): RevPoint

      The exclusive corner point opposite the first point in the rectangle.

      If the x and y coordinates respectively represent the right or bottom edge, the point is the first point outside the rectangle.

      Returns RevPoint

    • get exclusiveRight(): number

      Exclusive right co-ordinate of rectangle. (inclusiveRight + 1)

      Returns number

    • get height(): number

      Height of this rect (always positive).

      Returns number

    • get inclusiveBottom(): number

      Bottom co-ordinate of rectangle.

      Returns number

    • get inclusiveBottomRight(): RevPoint

      Returns RevPoint

    • get inclusiveLast(): RevPoint

      The inclusive corner point opposite the first point in the rectangle.

      The x and y coordinates represent the edges of the rectangle.

      Returns RevPoint

    • get inclusiveRight(): number

      Right co-ordinate of rectangle.

      Returns number

    • get left(): number

      Left co-ordinate of rectangle (same as x).

      Returns number

    • get top(): number

      Top co-ordinate of rectangle (same as y).

      Returns number

    • get width(): number

      Width of this rectangle (always positive).

      Returns number

    • get x(): number

      The x-coordinate of the top-left corner of the rectangle.

      Returns number

    • get y(): number

      The y-coordinate of the top-left corner of the rectangle.

      Returns number

    Methods

    • Adjusts the selection to where it would be after a columns deletion.

      Parameters

      • deletionLeft: number
      • deletionCount: number

      Returns null | boolean

      true if selection changed, false if it was not changed or null if it should be fully deleted

    • Adjusts the selection to where it would be after a columns insertion.

      Parameters

      • index: number
      • count: number

      Returns boolean

      true if selection changed

    • Parameters

      • oldIndex: number
      • newIndex: number
      • count: number

      Returns void

    • Adjusts the selection to where it would be after a rows deletion.

      Parameters

      • deletionTop: number
      • deletionCount: number

      Returns null | boolean

      true if selection changed, false if it was not changed or null if it should be fully deleted

    • Adjusts the selection to where it would be after a rows insertion.

      Parameters

      • index: number
      • count: number

      Returns boolean

      true if selection changed

    • Parameters

      • oldIndex: number
      • newIndex: number
      • count: number

      Returns void

    • Determines whether the specified point is contained within the rectangle.

      Parameters

      • point: RevPoint

        The point or rect to test for containment.

      Returns boolean

      true if the point is within the rectangle; otherwise, false.

    • Determines whether the specified x-coordinate is within the horizontal bounds of the rectangle.

      Parameters

      • x: number

        The x-coordinate to test.

      Returns boolean

      true if the x-coordinate is within the rectangle's horizontal bounds; otherwise, false.

    • Determines whether the specified point (x, y) is contained within the rectangle.

      Parameters

      • x: number

        The x-coordinate of the point to test.

      • y: number

        The y-coordinate of the point to test.

      Returns boolean

      true if the point is within the rectangle; otherwise, false.

    • Determines whether the specified y-coordinate is within the vertical bounds of the rectangle.

      Parameters

      • y: number

        The y-coordinate to test.

      Returns boolean

      true if the y-coordinate is within the rectangle's vertical bounds; otherwise, false.

    • Grows this Rectangle in x direction with let staying fixed

      Parameters

      • widthIncrease: number

      Returns void

    • Grows this Rectangle in y direction with top staying fixed

      Parameters

      • heightIncrease: number

      Returns void

    • Moves this Rectangle in x direction

      Parameters

      • offset: number

      Returns void

    • Moves this Rectangle in y direction

      Parameters

      • offset: number

      Returns void