Interface FloatRectArrayType

interface FloatRectArrayType {
    add: (newItem: Rect) => Promise<number>;
    append: (arr: FloatRectArrayType) => Promise<number>;
    copy: (arr: FloatRectArrayType) => Promise<void>;
    destroy: () => Promise<void>;
    find: (rect: Rect, startIndex: number) => Promise<number>;
    getAt: (index: number) => Promise<null | Rect>;
    getSize: () => Promise<number>;
    getUpperBound: () => Promise<number>;
    insertAt: (index: number, newItem: Rect, count: number) => Promise<void>;
    options?: Options;
    removeAll: () => Promise<void>;
    removeAt: (index: number, count: number) => Promise<void>;
    setAt: (index: number, newItem: Rect) => Promise<void>;
    setSize: (size: number, growBy: number) => Promise<void>;
}

Implemented by

Properties

add append copy destroy find getAt getSize getUpperBound insertAt options? removeAll removeAt setAt setSize

Properties

add

add: (newItem: Rect) => Promise<number>

将一个 Rect 对象添加到数组中。

Type declaration

    • (newItem: Rect): Promise<number>

    • Parameters

      • newItem: Rect

        要添加的 Rect 对象。

      Returns Promise<number>

      添加元素的索引。

Example

const rect = {
   top: 0,
   right: 100,
   bottom: 100,
   left: 0
};
const floatRectArr = await FloatRectArray.create();
const index = await floatRectArr.add(rect

append

append: (arr: FloatRectArrayType) => Promise<number>

将一个数组追加到当前数组。

Type declaration

copy

copy: (arr: FloatRectArrayType) => Promise<void>

从数组中复制。

Type declaration

destroy

destroy: () => Promise<void>

从数组中复制。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

find

find: (rect: Rect, startIndex: number) => Promise<number>

查找元素的索引。

Type declaration

    • (rect: Rect, startIndex: number): Promise<number>

    • Parameters

      • rect: Rect

        要查找的元素。

      • startIndex: number

        查找的起始索引。

      Returns Promise<number>

getAt

getAt: (index: number) => Promise<null | Rect>

获取指定索引位置的 Rect 对象。

Type declaration

    • (index: number): Promise<null | Rect>

    • Parameters

      • index: number

        要获取的元素索引。

      Returns Promise<null | Rect>

      返回指定索引位置的 Rect 对象。

getSize

getSize: () => Promise<number>

获取数组中的元素数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回数组中的元素数量。

getUpperBound

getUpperBound: () => Promise<number>

获取数组中的上界，实际上是最大有效索引。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回数组中的上界。

insertAt

insertAt: (index: number, newItem: Rect, count: number) => Promise<void>

插入一个元素。

Type declaration

    • (index: number, newItem: Rect, count: number): Promise<void>

    • Parameters

      • index: number

        要插入的位置索引。

      • newItem: Rect

        要插入的元素。

      • count: number

        要插入的元素数量。

      Returns Promise<void>

Optionaloptions

options?: Options

removeAll

removeAll: () => Promise<void>

移除数组中的所有元素。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

removeAt

removeAt: (index: number, count: number) => Promise<void>

按指定索引移除元素。

Type declaration

    • (index: number, count: number): Promise<void>

    • Parameters

      • index: number

        要移除的元素索引。

      • count: number

        要移除的元素数量。

      Returns Promise<void>

setAt

setAt: (index: number, newItem: Rect) => Promise<void>

在指定索引位置设置 Rect 对象。

Type declaration

    • (index: number, newItem: Rect): Promise<void>

    • Parameters

      • index: number

        在指定索引位置设置 Rect 对象。

      • newItem: Rect

        要设置的 Rect 对象。

      Returns Promise<void>

setSize

setSize: (size: number, growBy: number) => Promise<void>

更改已分配的大小和增长量。

Type declaration

    • (size: number, growBy: number): Promise<void>

    • Parameters

      • size: number

        预期的新元素大小。

      • growBy: number

        要增加的元素数量。

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties