Class Markups

Class managing markups on a canvas.

Index

Constructors

Accessors

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

Constructors

constructor

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

Accessors

customCursor

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

shapes

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

backgroundColor

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

foregroundColor

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

strokeWidth

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

dashedLabelTag

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

roundedCornerLabelTag

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

shadowLabelTag

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

mode

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

editing

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

visible

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

visibleNotEditing

get visibleNotEditing(): boolean
Returns boolean
- Defined in overlay/markups.ts:2449

visibleNotByPassing

get visibleNotByPassing(): boolean
Returns boolean
- Defined in overlay/markups.ts:2453

stage

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

Methods

setCursor

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

getCursor

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

hasAnyShape

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

hasUndo

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

undo

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

hasRedo

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

redo

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

setMarkupMode

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

setPanningIn3D

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

isPanningIn3D

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

isTextAreaShowing

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

addLabelShape

addLabelShape(text: string, x: number, y: number, select?: boolean): LabelShape
Adds a new 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
The added label shape.
- Defined in overlay/markups.ts:2080

loadShapeByState

loadShapeByState(data: MarkupShapeData): MarkupShape
Loads a shape by its state.
Parameters
- data: MarkupShapeData
  The state of the shape.
Returns MarkupShape
The loaded shape.
- Defined in overlay/markups.ts:2101

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:2144

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:2153

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:2171

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:2189

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:2207

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:2225

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:2243

addPencilShape

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

resize

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

updateRender

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

redraw

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

showMarkups

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

isByPassingEventsToRenderer

isByPassingEventsToRenderer(): boolean
Returns boolean
- Defined in overlay/markups.ts:2375

setByPassEventsToRenderer

setByPassEventsToRenderer(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in overlay/markups.ts:2379

refresh

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

focus

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

hasSelectedShape

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

hasSelectedLabelShape

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

getSelectionRect

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

getSelectedShapes

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

getSelectedLabelShapes

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

clearTrasformerSelection

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

deleteAllShapes

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

deleteShapes

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

setStrokeWidth

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

setBackgroundColor

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

setForegroundColor

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

setRoundedCorners

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

setDashTagLines

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

setShadowEnabled

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

isRoundedCorners

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

isDashTagLines

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

isShadowsEnabled

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

pushUndoableAction

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

clearUndoRedoActions

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