Class Box<BoxType>

Type Parameters

BoxType = any

Hierarchy (view full)

Box

Implements

Index

Constructors

Accessors

area bottom bottomLeft bottomRight height left right top topLeft topRight width x y

Methods

calibrate clipAtImageBorders floor pad padAtBorders rescale round shift toSquare assertIsValidBox isRect

Constructors

constructor

new Box<BoxType>(_box, allowNegativeDimensions?): Box<BoxType>
Type Parameters
- BoxType = any
Parameters
- _box: IRect | IBoundingBox
- allowNegativeDimensions: boolean = true
Returns Box<BoxType>
- Defined in src/classes/Box.ts:30

Accessors

area

get area(): number
Returns number
- Defined in src/classes/Box.ts:70

bottom

get bottom(): number
Returns number
Implementation of IBoundingBox.bottom
- Defined in src/classes/Box.ts:68

bottomLeft

get bottomLeft(): Point
Returns Point
- Defined in src/classes/Box.ts:76

bottomRight

get bottomRight(): Point
Returns Point
- Defined in src/classes/Box.ts:78

height

get height(): number
Returns number
Implementation of IRect.height
- Defined in src/classes/Box.ts:60

left

get left(): number
Returns number
Implementation of IBoundingBox.left
- Defined in src/classes/Box.ts:62

right

get right(): number
Returns number
Implementation of IBoundingBox.right
- Defined in src/classes/Box.ts:66

top

get top(): number
Returns number
Implementation of IBoundingBox.top
- Defined in src/classes/Box.ts:64

topLeft

get topLeft(): Point
Returns Point
- Defined in src/classes/Box.ts:72

topRight

get topRight(): Point
Returns Point
- Defined in src/classes/Box.ts:74

width

get width(): number
Returns number
Implementation of IRect.width
- Defined in src/classes/Box.ts:58

x

get x(): number
Returns number
Implementation of IRect.x
- Defined in src/classes/Box.ts:54

y

get y(): number
Returns number
Implementation of IRect.y
- Defined in src/classes/Box.ts:56

Methods

calibrate

calibrate(region): Box<any>
Parameters
- region: Box<any>
Returns Box<any>
- Defined in src/classes/Box.ts:189

clipAtImageBorders

clipAtImageBorders(imgWidth, imgHeight): Box<BoxType>
Parameters
- imgWidth: number
- imgHeight: number
Returns Box<BoxType>
- Defined in src/classes/Box.ts:134

floor

floor(): Box<BoxType>
Returns Box<BoxType>
- Defined in src/classes/Box.ts:88

pad

pad(padX, padY): Box<BoxType>
Parameters
- padX: number
- padY: number
Returns Box<BoxType>
- Defined in src/classes/Box.ts:124

padAtBorders

padAtBorders(imageHeight, imageWidth): {
    dx: number;
    dy: number;
    edx: number;
    edy: number;
    ex: number;
    ey: number;
    h: number;
    w: number;
    x: number;
    y: number;
}
Parameters
- imageHeight: number
- imageWidth: number
Returns {
    dx: number;
    dy: number;
    edx: number;
    edy: number;
    ex: number;
    ey: number;
    h: number;
    w: number;
    x: number;
    y: number;
}
- dx: number
- dy: number
- edx: number
- edy: number
- ex: number
- ey: number
- h: number
- w: number
- x: number
- y: number
- Defined in src/classes/Box.ts:155

rescale

rescale(s): Box<BoxType>
Parameters
- s: number | IDimensions
Returns Box<BoxType>
- Defined in src/classes/Box.ts:113

round

round(): Box<BoxType>
Returns Box<BoxType>
- Defined in src/classes/Box.ts:80

shift

shift(sx, sy): Box<BoxType>
Parameters
- sx: number
- sy: number
Returns Box<BoxType>
- Defined in src/classes/Box.ts:147

toSquare

toSquare(): Box<BoxType>
Returns Box<BoxType>
- Defined in src/classes/Box.ts:96

`Static`assertIsValidBox

assertIsValidBox(box, callee, allowNegativeDimensions?): void
Parameters
- box: any
- callee: string
- allowNegativeDimensions: boolean = false
Returns void
- Defined in src/classes/Box.ts:12

`Static`isRect

isRect(rect): boolean
Parameters
- rect: any
Returns boolean
- Defined in src/classes/Box.ts:8