Class RevFirstCornerRectangle

Hierarchy (View Summary)

RevInexclusiveRectangle
- RevFirstCornerRectangle
  - RevLastSelectionArea
  - RevSelectionRectangle

Implements

RevFirstCornerArea

Constructors

constructor

new RevFirstCornerRectangle(
    firstInexclusiveX: number,
    firstInexclusiveY: number,
    width: number,
    height: number,
): RevFirstCornerRectangle
Parameters
- firstInexclusiveX: number
- firstInexclusiveY: number
- width: number
- height: number
Returns RevFirstCornerRectangle
Overrides RevInexclusiveRectangle.constructor

Properties

`Readonly`firstCorner

firstCorner: CornerId

Accessors

area

get area(): number
Area of this rect.

Returns number
Inherited from RevInexclusiveRectangle.area

exclusiveBottom

get exclusiveBottom(): number
Returns number
Inherited from RevInexclusiveRectangle.exclusiveBottom

exclusiveBottomRight

get exclusiveBottomRight(): RevPoint
Returns RevPoint
Implementation of RevFirstCornerArea.exclusiveBottomRight
Inherited from RevInexclusiveRectangle.exclusiveBottomRight

exclusiveFirst

get exclusiveFirst(): RevPoint
The first (exclusive) point specified in a rectangle

Returns RevPoint

exclusiveLast

get exclusiveLast(): RevPoint
The last point specified in a rectangle

Returns RevPoint

exclusiveRight

get exclusiveRight(): number
For exclusive, maximum horizontal coordinate of this rect + 1. For inclusive, maximum horizontal coordinate of this rect.

Returns number
Inherited from RevInexclusiveRectangle.exclusiveRight

extent

get extent(): RevPoint
Returns RevPoint
Inherited from RevInexclusiveRectangle.extent

height

get height(): number
Height of this rect (always positive).

Returns number
Implementation of RevFirstCornerArea.height
Inherited from RevInexclusiveRectangle.height

inclusiveBottom

get inclusiveBottom(): number
Returns number
Inherited from RevInexclusiveRectangle.inclusiveBottom

inclusiveBottomRight

get inclusiveBottomRight(): RevPoint
Returns RevPoint
Inherited from RevInexclusiveRectangle.inclusiveBottomRight

inclusiveFirst

get inclusiveFirst(): RevPoint
The first (inclusive) point specified in a rectangle

Returns RevPoint
Implementation of RevFirstCornerArea.inclusiveFirst

inclusiveLast

get inclusiveLast(): RevPoint
The last point specified in a rectangle

Returns RevPoint

inclusiveRight

get inclusiveRight(): number
Returns number
Inherited from RevInexclusiveRectangle.inclusiveRight

left

get left(): number
Minimum horizontal coordinate of this rect.

Returns number
Inherited from RevInexclusiveRectangle.left

top

get top(): number
Minimum vertical coordinate of this rect.

Returns number
Inherited from RevInexclusiveRectangle.top

topLeft

get topLeft(): RevPoint
Returns RevPoint
Implementation of RevFirstCornerArea.topLeft
Inherited from RevInexclusiveRectangle.topLeft

width

get width(): number
Width of this rect (always positive).

Returns number
Implementation of RevFirstCornerArea.width
Inherited from RevInexclusiveRectangle.width

x

get x(): number
Returns number
Implementation of RevFirstCornerArea.x
Inherited from RevInexclusiveRectangle.x

y

get y(): number
Returns number
Implementation of RevFirstCornerArea.y
Inherited from RevInexclusiveRectangle.y

Methods

adjustForXRangeDeleted

adjustForXRangeDeleted(
deletionLeft: number,
deletionCount: number,
): null | boolean
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

Inherited from RevInexclusiveRectangle.adjustForXRangeDeleted

adjustForXRangeInserted

adjustForXRangeInserted(index: number, count: number): boolean
Adjusts the selection to where it would be after a columns insertion.
Parameters
- index: number
- count: number
Returns boolean
true if selection changed

Inherited from RevInexclusiveRectangle.adjustForXRangeInserted

adjustForXRangeMoved

adjustForXRangeMoved(oldIndex: number, newIndex: number, count: number): void
Parameters
- oldIndex: number
- newIndex: number
- count: number
Returns void
Inherited from RevInexclusiveRectangle.adjustForXRangeMoved

adjustForYRangeDeleted

adjustForYRangeDeleted(
deletionTop: number,
deletionCount: number,
): null | boolean
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

Inherited from RevInexclusiveRectangle.adjustForYRangeDeleted

adjustForYRangeInserted

adjustForYRangeInserted(index: number, count: number): boolean
Adjusts the selection to where it would be after a rows insertion.
Parameters
- index: number
- count: number
Returns boolean
true if selection changed

Inherited from RevInexclusiveRectangle.adjustForYRangeInserted

adjustForYRangeMoved

adjustForYRangeMoved(oldIndex: number, newIndex: number, count: number): void
Parameters
- oldIndex: number
- newIndex: number
- count: number
Returns void
Inherited from RevInexclusiveRectangle.adjustForYRangeMoved

containsPoint

containsPoint(point: RevPoint): boolean
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

Inherited from RevInexclusiveRectangle.containsPoint

containsX

containsX(x: number): boolean
Parameters
- x: number
Returns boolean
Inherited from RevInexclusiveRectangle.containsX

containsXY

containsXY(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from RevInexclusiveRectangle.containsXY

containsY

containsY(y: number): boolean
Parameters
- y: number
Returns boolean
Inherited from RevInexclusiveRectangle.containsY

createCopy

createCopy(): RevFirstCornerRectangle
Returns RevFirstCornerRectangle
Overrides RevInexclusiveRectangle.createCopy

growFromLeft

growFromLeft(widthIncrease: number): void
Grows this Rectangle in x direction with let staying fixed
Parameters
- widthIncrease: number
Returns void
Inherited from RevInexclusiveRectangle.growFromLeft

growFromTop

growFromTop(heightIncrease: number): void
Grows this Rectangle in y direction with top staying fixed
Parameters
- heightIncrease: number
Returns void
Inherited from RevInexclusiveRectangle.growFromTop

intersects

intersects(rect: RevInexclusiveRectangle): boolean
Parameters
- rect: RevInexclusiveRectangle
  The rectangle to intersect with this rect.
Returns boolean
true iff this rect overlaps with given rect.

Inherited from RevInexclusiveRectangle.intersects

moveX

moveX(offset: number): void
Moves this Rectangle in x direction
Parameters
- offset: number
Returns void
Inherited from RevInexclusiveRectangle.moveX

moveY

moveY(offset: number): void
Moves this Rectangle in y direction
Parameters
- offset: number
Returns void
Inherited from RevInexclusiveRectangle.moveY

newGrownFromCenter

newGrownFromCenter(padding: number): RevInexclusiveRectangle
(Formerly: insetBy.)
Parameters
- padding: number
  Amount by which to increase (+) or decrease (-) this rect
Returns RevInexclusiveRectangle
That is enlarged/shrunk by given padding.

See
The shrinkBy method.

Inherited from RevInexclusiveRectangle.newGrownFromCenter

newShrunkFromCenter

newShrunkFromCenter(padding: number): RevInexclusiveRectangle
Parameters
- padding: number
  Amount by which to decrease (+) or increase (-) this rect.
Returns RevInexclusiveRectangle
That is enlarged/shrunk by given padding.

See
The growBy method.

Inherited from RevInexclusiveRectangle.newShrunkFromCenter

newUnioned

newUnioned(rect: RevInexclusiveRectangle): RevInexclusiveRectangle
Parameters
- rect: RevInexclusiveRectangle
  The rectangle to union with this rect.
Returns RevInexclusiveRectangle
Bounding rect that contains both this rect and the given rect.

Inherited from RevInexclusiveRectangle.newUnioned

newXFlattened

newXFlattened(x: number): RevInexclusiveRectangle
Parameters
- x: number
  Horizontal coordinate of the new rect.
Returns RevInexclusiveRectangle
A copy of this rect but with horizontal position reset to given x and no width.

Inherited from RevInexclusiveRectangle.newXFlattened

newXMoved

newXMoved(xOffset: number): RevInexclusiveRectangle
Parameters
- xOffset: number
Returns RevInexclusiveRectangle
Inherited from RevInexclusiveRectangle.newXMoved

newYFlattened

newYFlattened(y: number): RevInexclusiveRectangle
Parameters
- y: number
  Vertical coordinate of the new rect.
Returns RevInexclusiveRectangle
A copy of this rect but with vertical position reset to given y and no height.

Inherited from RevInexclusiveRectangle.newYFlattened

newYMoved

newYMoved(yOffset: number): RevInexclusiveRectangle
Parameters
- yOffset: number
Returns RevInexclusiveRectangle
Inherited from RevInexclusiveRectangle.newYMoved

within

within(rect: RevInexclusiveRectangle): boolean
Parameters
- rect: RevInexclusiveRectangle
  Rectangle to test against this rect.
Returns boolean
true iff this rect is entirely contained within given rect.

Inherited from RevInexclusiveRectangle.within