Skip to main content

RectangleBlock

new RectangleBlock(options)

RectangleBlock class is rectangle shape inherted from ShapeBlock class.

info

Keep in mind that because RectangleBlock inherits from ShapeBlock, it can use some of the options of ShapeBlock. You can check shape block api for other options apply to RectangleBlock.

Options​

backgroundColor​

Background color defines color of background for rectangle shape.

block.backgroundColor(option)

Option

  • type : number | undefined
  • default: undefined

Returns

  • backgroundColor : number | undefined

borderRadius​

Border radius defines raidus of borders for rectangle shape.

block.borderRadius(option)

Option

  • type : number[] | number | undefined
  • default: 0

Returns

  • borderRadius : number[]

borderStyle​

Border style defines solid or dotted style of border for rectangle shape.

block.borderStyle(option)

Option

  • type : "solid" | "dotted" | undefined
  • default: "solid"

Returns

  • borderStyle : "solid" | "dotted"

borderWidth​

Border width defines size of border for rectangle shape.

block.borderWidth(option)

Option

  • type : number | string | undefined
  • default: 0

Returns

  • borderWidth : number

borderColor​

Border color defines color of border for rectangle shape.

block.borderColor(option)

Option

  • type : string | undefined
  • default: "black"

Returns

  • borderColor : string

border​

Border defines borderWidth, borderStyle, and borderColor in order for border for rectangle shape.

block.border(option)

Option

  • type : [borderWidth, borderStyle, borderColor] | string | undefined
  • default: undefined

Returns

  • border : [borderWidth, borderStyle, borderColor] | undefined

borderTop​

Border top defines borderWidth, borderStyle, and borderColor in order for top of border for rectangle shape.

block.borderTop(option)

Option

  • type : [borderWidth, borderStyle, borderColor] | string | undefined
  • default: undefined

Returns

  • borderTop : [borderWidth, borderStyle, borderColor] | undefined

borderBottom​

Border bottom defines borderWidth, borderStyle, and borderColor in order for bottom of border for rectangle shape.

block.borderBottom(option)

Option

  • type : [borderWidth, borderStyle, borderColor] | string | undefined
  • default: undefined

Returns

  • borderBottom : [borderWidth, borderStyle, borderColor] | undefined

borderLeft​

Border left defines borderWidth, borderStyle, and borderColor in order for left of border for rectangle shape.

block.borderLeft(option)

Option

  • type : [borderWidth, borderStyle, borderColor] | string | undefined
  • default: undefined

Returns

  • borderLeft : [borderWidth, borderStyle, borderColor] | undefined

borderRight​

Border right defines borderWidth, borderStyle, and borderColor in order for right of border for rectangle shape.

block.borderRight(option)

Option

  • type : [borderWidth, borderStyle, borderColor] | string | undefined
  • default: undefined

Returns

  • borderRight : [borderWidth, borderStyle, borderColor] | undefined