RevGrid - v0.9.3
    Preparing search index...

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    • This object represents a rectangular area within an abstract 2-dimensional matrix.

      Parameters

      • inexclusiveX: number

        Horizontal coordinate of some corner of the rect.

      • inexclusiveY: number

        Vertical coordinate of some corner of the rect.

      • width: number

        Width of the new rect. May be negative (see above).

      • height: number

        Height of the new rect. May be negative (see above).

      Returns RevInexclusiveRectangle

      The unit of measure is typically pixels. (If used to model computer graphics, vertical coordinates are typically measured downwards from the top of the window. This convention however is not inherent in this object.)

      Normally, the x and y parameters to the constructor describe the upper left corner of the rect. However, negative values of width and height will be added to the given x and y. That is, a negative value of the width parameter will extend the rect to the left of the given x and a negative value of the height parameter will extend the rect above the given y. In any case, after instantiation the following are guaranteed to always be true:

      • The extent, width, and height properties always give positive values.
      • The origin, top, and left properties always reflect the upper left corner.
      • The corner, bottom, and right properties always reflect the lower right corner.

      Note: This object should be instantiated with the new keyword.

    Accessors

    • get area(): number

      Area of this rect.

      Returns number

    • get exclusiveBottom(): number

      Returns number

    • get exclusiveRight(): number

      For exclusive, maximum horizontal coordinate of this rect + 1. For inclusive, maximum horizontal coordinate of this rect.

      Returns number

    • get inclusiveBottom(): number

      Returns number

    • get inclusiveRight(): number

      Returns number

    • get left(): number

      Minimum horizontal coordinate of this rect.

      Returns number

    • get top(): number

      Minimum vertical coordinate of this rect.

      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

    • Tests whether this rectangle contains a point

      Parameters

      • point: RevPoint

        The point or rect to test for containment.

      Returns boolean

      true if point is within rectangle

    • Parameters

      • x: number

      Returns boolean

    • Parameters

      • x: number
      • y: number

      Returns boolean

    • Parameters

      • y: number

      Returns boolean

    • 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