Skip to main content

LineBlock

new LineBlock(options)

LineBlock class is line shape inherted from ShapeBlock class.

info

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

Options​

lineType​

Line can be straigth line or cubic bezier in LineBlock.

block.lineType(option)

Option

  • type : "line" | "cubicBezier" | undefined
  • default: "line"

Returns

  • lineType : "line" | "cubicBezier"

startX​

Start point of line in x axis.

block.startX(option)

Option

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

Returns

  • startX : number | string | undefined

startY​

Start point of line in y axis.

block.startY(option)

Option

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

Returns

  • startY : number | string | undefined

endX​

End point of line in x axis.

block.endX(option)

Option

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

Returns

  • endX : number | string | undefined

endY​

End point of line in y axis.

block.endY(option)

Option

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

Returns

  • endY : number | string | undefined

startControlX​

Control point for startX in x axis. This option only works when lineType is set to cubicBezier.

block.startControlX(option)

Option

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

Returns

  • startControlX : number | string | undefined

startControlY​

Control point for startY in y axis. This option only works when lineType is set to cubicBezier.

block.startControlY(option)

Option

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

Returns

  • startControlY : number | string | undefined

endControlX​

Control point for endX in x axis. This option only works when lineType is set to cubicBezier.

block.endControlX(option)

Option

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

Returns

  • endControlX : number | string | undefined

endControlY​

Control point for endY in y axis. This option only works when lineType is set to cubicBezier.

block.endControlY(option)

Option

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

Returns

  • endControlY : number | string | undefined

controlPointsSize​

describtion

block.controlPointsSize(option)

Option

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

Returns

  • controlPointsSize : number | string

editable​

describtion

block.editable(option)

Option

  • type : boolean
  • default: false

Returns

  • editable : boolean

startDraggable​

Dragging start control point in relative x and y axis. This option depeneds on editable property.

block.startDraggable(option)

Option

  • type : boolean
  • default: false

Returns

  • startDraggable : boolean

endDraggable​

Dragging end control point in relative x and y axis. This option depeneds on editable property.

block.endDraggable(option)

Option

  • type : boolean
  • default: false

Returns

  • endDraggable : boolean

startControllable​

Start controlrollable enables or disables controling for start control point. This option depeneds on editable property.

block.startControllable(option)

Option

  • type : boolean
  • default: false

Returns

  • startControllable : boolean

endControllable​

End controlrollable enables or disables controling for end control point. This option depeneds on editable property.

block.endControllable(option)

Option

  • type : boolean
  • default: false

Returns

  • endControllable : boolean

lineColor​

Line color defines color of line for LineBlock.

block.lineColor(option)

Option

  • type : number | undefined
  • default: undefined

Returns

  • lineColor : number | undefined

backgroundColor​

Background color defines color of background for LineBlock.

block.backgroundColor(option)

Option

  • type : string | undefined
  • default: undefined

Returns

  • backgroundColor : string | undefined

closeLine​

Closing defined line in LineBlock.

block.closeLine(option)

Option

  • type : boolean | undefined
  • default: false

Returns

  • closeLine : boolean

stickStart​

Sticking line start point to a block, in defined x and y axis relative to sticked block.

block.stickStart(option)

Option

  • type : {block: Block , x: number, y: number} | undefined
  • default: undefined

Returns

  • stickStart : {block: Block , x: number, y: number} | undefined

stickEnd​

Sticking line end point to a block, in defined x and y axis relative to sticked block.

block.stickEnd(option)

Option

  • type : {block: Block , x: number, y: number} | undefined
  • default: undefined

Returns

  • stickStart : {block: Block , x: number, y: number} | undefined

joinTo​

Join to defines which line to join. Joined lines move, resize, drag together, behaving like a grouped blocks.

block.joinTo(option)

Option

  • type : LineBlock | undefined
  • default: undefined

Returns

  • joinTo : LineBlock | undefined