- API Reference
- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ThreadedComments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.Collaboration
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.NamedCellTemplates
- GC.Spread.Sheets.Scenarios
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.AI
- Collaboration
- GC.Spread.Excel
GC.Spread.Sheets.Rect
Class: Rect
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new Rect(x, y, w, h)
Represents a rectangle with a special location, and its width and height in two-dimensional space.
Parameters
| Name | Type | Description |
|---|---|---|
x |
number |
The x-coordinate of the top-left corner of the rectangle. |
y |
number |
The y-coordinate of the top-left corner of the rectangle. |
w |
number |
The width of the rectangle. |
h |
number |
The height of the rectangle. |
Properties
height
• height: number
The width of the rectangle.
width
• width: number
The height of the rectangle.
x
• x: number
The x-coordinate of the top-left corner of the rectangle.
y
• y: number
The y-coordinate of the top-left corner of the rectangle.
Methods
contains
▸ contains(x, y): boolean
Indicates whether the rectangle contains the specified x-coordinate and y-coordinate.
Parameters
| Name | Type | Description |
|---|---|---|
x |
number |
The x-coordinate of the point to check. |
y |
number |
The y-coordinate of the point to check. |
Returns
boolean
true if (x, y) is contained by the rectangle; otherwise, false.
getIntersectRect
▸ getIntersectRect(rect): Rect
Gets the rectangle that intersects with the current rectangle.
Parameters
| Name | Type | Description |
|---|---|---|
rect |
Rect |
The rectangle. |
Returns
The intersecting rectangle. If the two rectangles do not intersect, returns null.
intersect
▸ intersect(x, y, width, height): boolean
Indicates whether the specified rectangle intersects with the current rectangle.
Parameters
| Name | Type | Description |
|---|---|---|
x |
number |
The x-coordinate of the top-left corner of the rectangle. |
y |
number |
The y-coordinate of the top-left corner of the rectangle. |
width |
number |
The width of the rectangle. |
height |
number |
The height of the rectangle. |
Returns
boolean
true if the specified rectangle intersects with the current rectangle; otherwise, false.
intersectRect
▸ intersectRect(rect): boolean
Indicates whether the specified rectangle intersects with the current rectangle.
Parameters
| Name | Type | Description |
|---|---|---|
rect |
Rect |
The specified rectangle. |
Returns
boolean
true if the specified rectangle intersects with the current rectangle; otherwise, false.