Represents margins or padding for a rectangular area in two-dimensional Cartesian coordinates.
Inheritance Hierarchy
Remarks
This is a convertible type that can be used with the following notation(s) in parameter lists, parameter objects or setters.
It is possible to specify a single , an Array or a plain Object to define Insets:
5 // horizontal and vertical
[5] // also horizontal and vertical
[5, 10] // vertical, horizontal
[5, 10, 15] // top, horizontal, bottom
[5, 10, 15, 20] // top, right, bottom, left
// for objects, all properties are optional and 0 implicitly when omitted,
// but at least one needs to be specified:
{ top: 5, right: 10, bottom: 15, left: 20}
{ horizontal: 10, vertical: 5}
{ horizontal: 5, right: 10} // more specific value wins, so right becomes 10Examples
The following example shows a few ways to use Insets:
// Create new insets
const insets = new Insets(10, 10, 5, 2)
// Create other insets that are uniform on every side
const insets2 = new Insets(12)
console.log(`Top: ${insets.top}`)
console.log(`Right: ${insets.right}`)
console.log(`Bottom: ${insets.bottom}`)
console.log(`Left: ${insets.left}`)
console.log(`Total vertical: ${insets.verticalInsets}`)
console.log(`Total horizontal: ${insets.horizontalInsets}`)
// Enlarge the first insets
const larger = insets.getEnlarged(new Insets(2))
console.log(larger) // top: 12, right: 12, bottom: 7, left: 4
// Reduce them again
const smaller = larger.getReduced(new Insets(1, 5, 2, 3))
console.log(smaller) // top: 11, right: 7, bottom: 5, left: 1
// Scale by a uniform factor
const scaled = Insets.multiply(insets, 1.5)
console.log(scaled) // top: 15, right: 15, bottom: 7.5, left: 3See Also
Developer's Guide
Members
No filters for this type
Constructors
Parameters
- inset: number
- The inset to use for all sides.
Properties
readonlyfinal
Property Value
true if this instance has all properties set to 0.0d; false otherwise.Methods
final
Parameters
- other: any
- Another object to compare to.
Return Value
- boolean
trueifotherand this instance are the same type and represent the same value; otherwise,false.
final
Parameters
- insets: Insets
- The insets to add to this instance.
Return Value
- Insets
- An enlarged instance of the given insets instance.
See Also
API
- getReduced
final
Parameters
- insets: Insets
- The insets to subtract from this instance.
Return Value
- Insets
- A reduced instance of the given instance of insets.
See Also
API
- getEnlarged
The hash code is a numeric value that can be used to treat this object as a key in a hash table or similar data structure.
Two objects that are considered equal must have the same hash code. However, the reverse does not hold and two objects having the same hash code don't have to be equal. Ideally, the hash code should be roughly uniformly-distributed to prevent hash tables from performing poorly. Calculating the hash code is also a potentially frequent operation and should therefore be fast.
final
Return Value
- number
- the hash code for this object
Constants
The "empty" insets that have all properties set to 0.0d.
The "empty" insets that have all properties set to
0.0d.