Type alias FieldBoundingBox

FieldBoundingBox: {
    bottom: number;
    bottomLeft: Point;
    bottomRight: Point;
    height: number;
    left: number;
    right: number;
    top: number;
    topLeft: Point;
    topRight: Point;
    width: number;
    x: number;
    y: number;
}

A field bounding box defines the area vertically and horizontally a field occupies. If the field is not rotated, that is the same as the field position and size. But rotation will cause a change to the bounding box. This object can be easily used to understand the final positioning of the field on the canvas.

All properties are in points.

Type declaration

  • bottom: number

    The bottom edge of the bounding box. Value in points.

  • bottomLeft: Point

    The position of the bottom left corner of the field on the actual canvas. This position is always within or on the bounding box.

  • bottomRight: Point

    The position of the bottom right corner of the field on the actual canvas. This position is always within or on the bounding box.

  • height: number

    The height of the bounding box. Value in points.

  • left: number

    The left edge of the bounding box. Value in points. Same as x.

  • right: number

    The right edge of the bounding box. Value in points.

  • top: number

    The top edge of the bounding box. Value in points. Same as y.

  • topLeft: Point

    The position of the top left corner of the field on the actual canvas. This position is always within or on the bounding box.

  • topRight: Point

    The position of the top right corner of the field on the actual canvas. This position is always within or on the bounding box.

  • width: number

    The width of the bounding box. Value in points.

  • x: number

    The x coordinate of the bounding box as the top left corner. Value in points.

  • y: number

    The y coordinate of the bounding box as the top left corner. Value in points.

Settings

Member Visibility

Theme

Generated using TypeDoc