Summary
Constructor
new Size(width, height)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
width |
Number | 0 | 宽度,大于等于0的数值类型。 |
height |
Number | 高度,大于等于0的数值类型。 |
Throws:
当参数width、height不是数值类型时或者当参数width、height是小于0的数值时,抛出异常
Example
let size = new hmap.basetype.Size(20,30);
Methods
-
clone() → {module:basetype~Size}
-
克隆Size对象
Returns:
module:basetype~SizeExample
let newSize = size.clone();
-
destroy()
-
销毁Size对象
Example
size.destroy();
-
equals(size) → {Boolean}
-
判断两个对象的数据是否相等
Parameters:
Name Type Description size
module:basetype~Size 待检测的size对象
Returns:
Boolean -相等返回true,否则返回false。
Example
let result = size.equals(size2);
-
getHeight() → {Number}
-
获取高度值
Returns:
Number -高度值
Example
let height = size.getHeight();
-
getWidth() → {Number}
-
获取宽度值
Returns:
Number -宽度值
Example
let width = size.getWidth();
-
setHeight(height)
-
设置高度
Parameters:
Name Type Description height
Number 大于等于0的数值
Throws:
当参数height不是数值类型或者是小于0的数值时,抛出异常
Example
size.setHeight(22);
-
setWidth(width)
-
设置宽度
Parameters:
Name Type Description width
Number 大于等于0的数值
Throws:
当参数width不是数值类型或者是小于0的数值时,抛出异常
Example
size.setWidth(22);
-
toString() → {String}
-
返回当前实例字符串表示
Returns:
String -一个字符串
Example
let str = size.toString();