Class Markups

Class managing markups on a canvas.

Hierarchy

Markups

Index

Constructors

Accessors

backgroundColor customCursor dashedLabelTag editing foregroundColor mode roundedCornerLabelTag shadowLabelTag shapes stage strokeWidth visible

Constructors

constructor

new Markups(owner: BaseBimCanvas): Markups
Parameters
- owner: BaseBimCanvas
Returns Markups
- Defined in overlay/markups.ts:1224

Accessors

backgroundColor

get backgroundColor(): RGB
Returns RGB
- Defined in overlay/markups.ts:1291
set backgroundColor(color: RGB): void
Parameters
- color: RGB
Returns void
- Defined in overlay/markups.ts:1295

customCursor

set customCursor(cursorURL: string): void
Parameters
- cursorURL: string
Returns void
- Defined in overlay/markups.ts:1231

dashedLabelTag

get dashedLabelTag(): boolean
Returns boolean
- Defined in overlay/markups.ts:1315
set dashedLabelTag(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in overlay/markups.ts:1319

editing

get editing(): boolean
Returns boolean
- Defined in overlay/markups.ts:2360

foregroundColor

get foregroundColor(): RGB
Returns RGB
- Defined in overlay/markups.ts:1299
set foregroundColor(color: RGB): void
Parameters
- color: RGB
Returns void
- Defined in overlay/markups.ts:1303

mode

get mode(): MARKUP_MODE
Returns MARKUP_MODE
- Defined in overlay/markups.ts:1394

roundedCornerLabelTag

get roundedCornerLabelTag(): boolean
Returns boolean
- Defined in overlay/markups.ts:1323
set roundedCornerLabelTag(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in overlay/markups.ts:1327

shadowLabelTag

get shadowLabelTag(): boolean
Returns boolean
- Defined in overlay/markups.ts:1331
set shadowLabelTag(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in overlay/markups.ts:1335

shapes

get shapes(): MarkupShape[]
Returns MarkupShape[]
- Defined in overlay/markups.ts:1287

stage

get stage(): Stage
Returns Stage
- Defined in overlay/markups.ts:2418

strokeWidth

get strokeWidth(): number
Returns number
- Defined in overlay/markups.ts:1307
set strokeWidth(weight: number): void
Parameters
- weight: number
Returns void
- Defined in overlay/markups.ts:1311

visible

get visible(): boolean
Returns boolean
- Defined in overlay/markups.ts:2405

Methods

addArrowShape

addArrowShape(x1: number, y1: number, x2: number, y2: number, select?: boolean): ArrowShape
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- select: boolean = true
Returns ArrowShape
- Defined in overlay/markups.ts:2151

addCloudShape

addCloudShape(x1: number, y1: number, x2: number, y2: number, select?: boolean): CloudShape
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- select: boolean = true
Returns CloudShape
- Defined in overlay/markups.ts:2241

addEllipseShape

addEllipseShape(x1: number, y1: number, x2: number, y2: number, select?: boolean): EllipseShape
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- select: boolean = true
Returns EllipseShape
- Defined in overlay/markups.ts:2205

addLabelShape

addLabelShape(text: string, x: number, y: number, select?: boolean): LabelShape
Adds a new label shape.

Returns
The added label shape.
Parameters
- text: string
  
  The text of the label.
- x: number
  
  The x-coordinate of the label.
- y: number
  
  The y-coordinate of the label.
- select: boolean = true
  
  True to select the shape after adding.
Returns LabelShape
- Defined in overlay/markups.ts:2078

addLineShape

addLineShape(x1: number, y1: number, x2: number, y2: number, select?: boolean): LineShape
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- select: boolean = true
Returns LineShape
- Defined in overlay/markups.ts:2169

addPencilShape

addPencilShape(x: number, y: number, select?: boolean): PencilShape
Parameters
- x: number
- y: number
- select: boolean = true
Returns PencilShape
- Defined in overlay/markups.ts:2260

addRectangleShape

addRectangleShape(x1: number, y1: number, x2: number, y2: number, select?: boolean): RectangleShape
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- select: boolean = true
Returns RectangleShape
- Defined in overlay/markups.ts:2187

addStarShape

addStarShape(x1: number, y1: number, x2: number, y2: number, select?: boolean): StarShape
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- select: boolean = true
Returns StarShape
- Defined in overlay/markups.ts:2223

clearTrasformerSelection

clearTrasformerSelection(): void
Returns void
- Defined in overlay/markups.ts:2515

clearUndoRedoActions

clearUndoRedoActions(): void
Returns void
- Defined in overlay/markups.ts:2681

deleteAllShapes

deleteAllShapes(undoable?: boolean): void
Parameters
- undoable: boolean = true
Returns void
- Defined in overlay/markups.ts:2524

deleteShapes

deleteShapes(shapes: MarkupShape[], undoable?: boolean): void
Parameters
- shapes: MarkupShape[]
- undoable: boolean = true
Returns void
- Defined in overlay/markups.ts:2542

focus

focus(): void
Returns void
- Defined in overlay/markups.ts:2414

getCursor

getCursor(): BaseBimCanvasCursor
Returns BaseBimCanvasCursor
- Defined in overlay/markups.ts:1279

getSelectedLabelShapes

getSelectedLabelShapes(): LabelShape[]
Returns LabelShape[]
- Defined in overlay/markups.ts:2504

getSelectedShapes

getSelectedShapes(): MarkupShape[]
Returns MarkupShape[]
- Defined in overlay/markups.ts:2482

getSelectionRect

getSelectionRect(): IRect
Returns IRect
- Defined in overlay/markups.ts:2444

hasAnyShape

hasAnyShape(): boolean
Returns boolean
- Defined in overlay/markups.ts:1339

hasRedo

hasRedo(): boolean
Returns boolean
- Defined in overlay/markups.ts:1369

hasSelectedLabelShape

hasSelectedLabelShape(): boolean
Returns boolean
- Defined in overlay/markups.ts:2433

hasSelectedShape

hasSelectedShape(): boolean
Returns boolean
- Defined in overlay/markups.ts:2422

hasUndo

hasUndo(): boolean
Returns boolean
- Defined in overlay/markups.ts:1343

isDashTagLines

isDashTagLines(): boolean
Returns boolean
- Defined in overlay/markups.ts:2646

isPanningIn3D

isPanningIn3D(): boolean
Returns boolean
- Defined in overlay/markups.ts:1517

isRoundedCorners

isRoundedCorners(): boolean
Returns boolean
- Defined in overlay/markups.ts:2635

isShadowsEnabled

isShadowsEnabled(): boolean
Returns boolean
- Defined in overlay/markups.ts:2657

isTextAreaShowing

isTextAreaShowing(): boolean
Returns boolean
- Defined in overlay/markups.ts:2053

loadShapeByState

loadShapeByState(data: MarkupShapeData): MarkupShape
Loads a shape by its state.

Returns
The loaded shape.
Parameters
- data: MarkupShapeData
  
  The state of the shape.
Returns MarkupShape
- Defined in overlay/markups.ts:2099

pushUndoableAction

pushUndoableAction(action: UndoableAction): void
Parameters
- action: UndoableAction
Returns void
- Defined in overlay/markups.ts:2668

redo

redo(): boolean
Returns boolean
- Defined in overlay/markups.ts:1373

redraw

redraw(): void
Returns void
- Defined in overlay/markups.ts:2311

refresh

refresh(): void
Returns void
- Defined in overlay/markups.ts:2409

reloadShapeWithState

reloadShapeWithState(shape: MarkupShape, data: MarkupShapeData): void
Reloads a shape with a given state.
Parameters
- shape: MarkupShape
  
  The shape to reload.
- data: MarkupShapeData
  
  The state of the shape.
Returns void
- Defined in overlay/markups.ts:2142

resize

resize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in overlay/markups.ts:2278

setBackgroundColor

setBackgroundColor(red: number, green: number, blue: number): void
Parameters
- red: number
- green: number
- blue: number
Returns void
- Defined in overlay/markups.ts:2573

setCursor

setCursor(cursor: BaseBimCanvasCursor): void
Parameters
- cursor: BaseBimCanvasCursor
Returns void
- Defined in overlay/markups.ts:1242

setDashTagLines

setDashTagLines(enabled: boolean): boolean
Parameters
- enabled: boolean
Returns boolean
- Defined in overlay/markups.ts:2611

setForegroundColor

setForegroundColor(red: number, green: number, blue: number): void
Parameters
- red: number
- green: number
- blue: number
Returns void
- Defined in overlay/markups.ts:2588

setMarkupMode

setMarkupMode(mode: MARKUP_MODE): void
Parameters
- mode: MARKUP_MODE
Returns void
- Defined in overlay/markups.ts:1398

setPanningIn3D

setPanningIn3D(e: MouseEvent, pan: boolean): void
Parameters
- e: MouseEvent
- pan: boolean
Returns void
- Defined in overlay/markups.ts:1498

setRoundedCorners

setRoundedCorners(enabled: boolean): boolean
Parameters
- enabled: boolean
Returns boolean
- Defined in overlay/markups.ts:2600

setShadowEnabled

setShadowEnabled(enabled: boolean): boolean
Parameters
- enabled: boolean
Returns boolean
- Defined in overlay/markups.ts:2624

setStrokeWidth

setStrokeWidth(width: number): void
Parameters
- width: number
Returns void
- Defined in overlay/markups.ts:2562

showMarkups

showMarkups(visible: boolean, editing: boolean): boolean
Parameters
- visible: boolean
- editing: boolean
Returns boolean
- Defined in overlay/markups.ts:2315

undo

undo(): boolean
Returns boolean
- Defined in overlay/markups.ts:1347

updateRender

updateRender(): void
Returns void
- Defined in overlay/markups.ts:2302