Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Box<BoxType>

Type parameters

  • BoxType

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns Box

Accessors

area

  • get area(): number

  • Returns number

bottom

  • get bottom(): number

  • Returns number

height

  • get height(): number

  • Returns number

left

  • get left(): number

  • Returns number

right

  • get right(): number

  • Returns number

top

  • get top(): number

  • Returns number

width

  • get width(): number

  • Returns number

x

  • get x(): number

  • Returns number

y

  • get y(): number

  • Returns number

Methods

calibrate

  • calibrate(region: Box): Box<any>

  • Parameters

    Returns Box<any>

clipAtImageBorders

  • clipAtImageBorders(imgWidth: number, imgHeight: number): Box<BoxType>

  • Parameters

    • imgWidth: number
    • imgHeight: number

    Returns Box<BoxType>

floor

  • floor(): Box<BoxType>

  • Returns Box<BoxType>

pad

  • pad(padX: number, padY: number): Box<BoxType>

  • Parameters

    • padX: number
    • padY: number

    Returns Box<BoxType>

padAtBorders

  • padAtBorders(imageHeight: number, imageWidth: number): object

  • Parameters

    • imageHeight: number
    • imageWidth: number

    Returns object

rescale

  • Parameters

    Returns Box<BoxType>

round

  • round(): Box<BoxType>

  • Returns Box<BoxType>

shift

  • shift(sx: number, sy: number): Box<BoxType>

  • Parameters

    • sx: number
    • sy: number

    Returns Box<BoxType>

toSquare

  • toSquare(): Box<BoxType>

  • Returns Box<BoxType>

Static assertIsValidBox

  • assertIsValidBox(box: any, callee: string, allowNegativeDimensions?: boolean): void

  • Parameters

    • box: any
    • callee: string
    • Default value allowNegativeDimensions: boolean = false

    Returns void

Static isRect

  • isRect(rect: any): boolean

  • Parameters

    • rect: any

    Returns boolean

Generated using TypeDoc