Options
All
  • Public
  • Public/Protected
  • All
Menu

Size类

层次结构

  • Size

大小以二维坐标描述宽度和高度,宽度和高度都必须为非负数。

使用静态函数 Size.parseSize.stringify 可以与标准字符串表示形式进行转换,该表示形式独立于当前语言环境

此类的实例是一个 GraphObject 类或者 Diagram 或者 CommandHandler 或者 Tool 类, 你应该视为冻结或者只读对象,不能修改其属性。 这允许属性返回一个值,而无需分配新实例。 如果你需要使用该值进行自己的计算,请调用 copy 以使用可以修改的相同值创建一个新实例

许多方法会修改对象的属性,然后返回对 "this" 对象的引用。分配新对象的唯一实例方法是 copy 方法,静态方法 Size.parse 还分配一个新对象

此类的 "Debug" 实现比 "Release" 实现明显慢得多,这主要是由于附加的错误检查

你不能从此类继承

Index

Constructors

constructor

  • new Size(w?: number, h?: number): Size
  • 默认构造产生 Size(0,0). 该构造函数可以采用零个参数或者两个参数

    Parameters

    • Optional w: number

      初始宽度(必须为非负数)

    • Optional h: number

      初始高度(必须为非负数)

    Returns Size

Properties

height : number

  • 获取或者设置Size的高度值,该值不能为负数

width : number

  • 获取或者设置Size的宽度值,该值不能为负数

Methods

Virtual copy

  • 使用相同的值创建此Size的副本。

    Returns Size

equalTo

  • equalTo(w: number, h: number): boolean
  • 指示给定的大小是否等于此大小。

    see

    equals

    Parameters

    • w: number

      宽度

    • h: number

      高度

    Returns boolean

    如果大小具有相同的宽度和高度,则为true,否则为false

equals

  • equals(s: Size): boolean
  • 指示给定的大小是否等于当前大小.

    see

    equalTo

    Parameters

    • s: Size

      与当前大小比较的大小

    Returns boolean

    如果大小具有相同的宽度和高度,则为true,否则为false

isReal

  • isReal(): boolean
  • 如果大小的宽度和高度值是实数不是无穷大,则为true,否则为false

    Returns boolean

Static parse

  • parse(str: string): Size
  • 此静态函数用于从 Size.stringify 生成的字符串中读取 Size

    go.Size.parse("1 2") 生成 new go.Size(1, 2).

    Parameters

    • str: string

    Returns Size

set

  • 修改此大小,使其宽度和高度值与给定的大小相同

    Parameters

    • s: Size

      给定的大小

    Returns Size

    this.

setTo

  • setTo(w: number, h: number): Size
  • 使用新的宽度和高度值修改此大小

    Parameters

    • w: number

      宽度

    • h: number

      高度

    Returns Size

    this.

Static stringify

  • stringify(val: Size): string
  • 此静态函数可以将 Size 生成为可由 Size.parse 读取的字符串

    go.Size.stringify(new go.Size(1, 2)) 生成字符串 "1 2".

    Parameters

    Returns string