TextBlock

Defined in: panel/TextBlock.ts:28

A text element in a panel.

Extends

GraphObject

Constructors

Constructor

new TextBlock(text?): TextBlock

Defined in: panel/TextBlock.ts:44

Parameters

text?

string

Returns

TextBlock

Overrides

GraphObject.constructor

Properties

actionCancel?

optional actionCancel?: (e, obj) => void

Defined in: panel/GraphObject.ts:86

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.actionCancel

actionDown?

optional actionDown?: (e, obj) => void

Defined in: panel/GraphObject.ts:83

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.actionDown

actionMove?

optional actionMove?: (e, obj) => void

Defined in: panel/GraphObject.ts:84

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.actionMove

actionUp?

optional actionUp?: (e, obj) => void

Defined in: panel/GraphObject.ts:85

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.actionUp

click?

optional click?: (e, obj) => void

Defined in: panel/GraphObject.ts:68

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.click

contextClick?

optional contextClick?: (e, obj) => void

Defined in: panel/GraphObject.ts:70

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.contextClick

doubleClick?

optional doubleClick?: (e, obj) => void

Defined in: panel/GraphObject.ts:69

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.doubleClick

isActionable

isActionable: boolean = false

Defined in: panel/GraphObject.ts:82

GoJS-compatible: when true, ActionTool dispatches actionDown/actionMove/actionUp/actionCancel on this object for mouse-down-move-up gestures starting on it — for building controls (buttons, sliders) that handle their own gesture without a new Tool.

Inherited from

GraphObject.isActionable

mouseEnter?

optional mouseEnter?: (e, obj, prev) => void

Defined in: panel/GraphObject.ts:71

Parameters

e

InputEvent

obj

GraphObject

GraphObject | null

Returns

void

Inherited from

GraphObject.mouseEnter

mouseLeave?

optional mouseLeave?: (e, obj, prev) => void

Defined in: panel/GraphObject.ts:72

Parameters

e

InputEvent

obj

GraphObject

GraphObject | null

Returns

void

Inherited from

GraphObject.mouseLeave

mouseOut?

optional mouseOut?: (e, obj) => void

Defined in: panel/GraphObject.ts:74

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.mouseOut

mouseOver?

optional mouseOver?: (e, obj) => void

Defined in: panel/GraphObject.ts:73

Parameters

e

InputEvent

obj

GraphObject

Returns

void

Inherited from

GraphObject.mouseOver

parentPanel

parentPanel: GraphObject | null = null

Defined in: panel/GraphObject.ts:89

The panel this object belongs to (set when added). Used for ofObject resolution.

Inherited from

GraphObject.parentPanel

portId

portId: string = ''

Defined in: panel/GraphObject.ts:92

GoJS-compatible: If non-empty, this object acts as a port on its part.

Inherited from

GraphObject.portId

OverflowClip

readonly static OverflowClip: "clip" = 'clip'

Defined in: panel/TextBlock.ts:30

GoJS-compatible: named constant for overflow — clips overflowing text with no ellipsis.

OverflowEllipsis

readonly static OverflowEllipsis: "ellipsis" = 'ellipsis'

Defined in: panel/TextBlock.ts:32

GoJS-compatible: named constant for overflow — truncates overflowing text with an ellipsis (“…”).

Accessors

actualSize

Get Signature

get actualSize(): Size

Defined in: panel/GraphObject.ts:481

The actual size computed during layout.

Returns

Size

Inherited from

GraphObject.actualSize

alignment

Get Signature

get alignment(): Spot | null

Defined in: panel/GraphObject.ts:491

The alignment spot for Spot panels.

Returns

Spot | null

Set Signature

set alignment(value): void

Defined in: panel/GraphObject.ts:495

Parameters

value

Spot | null

Returns

void

Inherited from

Placeholder.alignment

alignmentFocus

Get Signature

get alignmentFocus(): Spot | null

Defined in: panel/GraphObject.ts:553

GoJS-compatible: The spot within this object used for alignment/placement.

Returns

Spot | null

Set Signature

set alignmentFocus(value): void

Defined in: panel/GraphObject.ts:557

Parameters

value

Spot | null

Returns

void

Inherited from

GraphObject.alignmentFocus

angle

Get Signature

get angle(): number

Defined in: panel/GraphObject.ts:414

The rotation angle in degrees.

Returns

number

Set Signature

set angle(value): void

Defined in: panel/GraphObject.ts:418

Parameters

value

number

Returns

void

Inherited from

GraphObject.angle

bindings

Get Signature

get bindings(): readonly Binding[]

Defined in: panel/GraphObject.ts:104

GoJS-compatible: The bindings attached to this graph object.

Returns

readonly Binding[]

Inherited from

GraphObject.bindings

color

Get Signature

get color(): string

Defined in: panel/TextBlock.ts:57

Returns

string

Set Signature

set color(value): void

Defined in: panel/TextBlock.ts:61

Parameters

value

string

Returns

void

column

Get Signature

get column(): number

Defined in: panel/GraphObject.ts:524

GoJS-compatible: The column index for table panels.

Returns

number

Set Signature

set column(value): void

Defined in: panel/GraphObject.ts:528

Parameters

value

number

Returns

void

Inherited from

GraphObject.column

columnSpan

Get Signature

get columnSpan(): number

Defined in: panel/GraphObject.ts:542

GoJS-compatible: The number of columns this object spans.

Returns

number

Set Signature

set columnSpan(value): void

Defined in: panel/GraphObject.ts:546

Parameters

value

number

Returns

void

Inherited from

GraphObject.columnSpan

copyable

Get Signature

get copyable(): boolean

Defined in: panel/GraphObject.ts:635

GoJS-compatible: Whether this object is included when copying its part.

Returns

boolean

Set Signature

set copyable(value): void

Defined in: panel/GraphObject.ts:639

Parameters

value

boolean

Returns

void

Inherited from

GraphObject.copyable

cursor

Get Signature

get cursor(): string

Defined in: panel/GraphObject.ts:423

GoJS-compatible: The cursor displayed when hovering over this object.

Returns

string

Set Signature

set cursor(value): void

Defined in: panel/GraphObject.ts:427

Parameters

value

string

Returns

void

Inherited from

Placeholder.cursor

desiredSize

Get Signature

get desiredSize(): Size | null

Defined in: panel/GraphObject.ts:432

The desired size. If null, natural size is used.

Returns

Size | null

Set Signature

set desiredSize(value): void

Defined in: panel/GraphObject.ts:436

Parameters

value

Size | null

Returns

void

Inherited from

GraphObject.desiredSize

editable

Get Signature

get editable(): boolean

Defined in: panel/TextBlock.ts:84

GoJS-compatible: Whether this text can be edited in-place by the user.

Returns

boolean

Set Signature

set editable(value): void

Defined in: panel/TextBlock.ts:88

Parameters

value

boolean

Returns

void

font

Get Signature

get font(): string

Defined in: panel/TextBlock.ts:110

Returns

string

Set Signature

set font(value): void

Defined in: panel/TextBlock.ts:114

Parameters

value

string

Returns

void

fontFamily

Get Signature

get fontFamily(): string

Defined in: panel/TextBlock.ts:119

GoJS-compatible: The font family (e.g. “sans-serif”).

Returns

string

Set Signature

set fontFamily(value): void

Defined in: panel/TextBlock.ts:124

Parameters

value

string

Returns

void

fontStyle

Get Signature

get fontStyle(): string

Defined in: panel/TextBlock.ts:139

GoJS-compatible: The font style (e.g. “bold”, “italic”).

Returns

string

Set Signature

set fontStyle(value): void

Defined in: panel/TextBlock.ts:144

Parameters

value

string

Returns

void

height

Get Signature

get height(): number

Defined in: panel/GraphObject.ts:462

GoJS-compatible: the last explicitly-set desired height, or NaN if never set.

Returns

number

Set Signature

set height(value): void

Defined in: panel/GraphObject.ts:466

Parameters

value

number

Returns

void

Inherited from

Placeholder.height

isBold

Get Signature

get isBold(): boolean

Defined in: panel/TextBlock.ts:150

GoJS-compatible: Whether the text is bold.

Returns

boolean

Set Signature

set isBold(value): void

Defined in: panel/TextBlock.ts:154

Parameters

value

boolean

Returns

void

isItalic

Get Signature

get isItalic(): boolean

Defined in: panel/TextBlock.ts:162

GoJS-compatible: Whether the text is italic.

Returns

boolean

Set Signature

set isItalic(value): void

Defined in: panel/TextBlock.ts:166

Parameters

value

boolean

Returns

void

isMultiline

Get Signature

get isMultiline(): boolean

Defined in: panel/TextBlock.ts:93

GoJS-compatible: Whether the text can wrap to multiple lines.

Returns

boolean

Set Signature

set isMultiline(value): void

Defined in: panel/TextBlock.ts:97

Parameters

value

boolean

Returns

void

isShadowed

Get Signature

get isShadowed(): boolean

Defined in: panel/GraphObject.ts:578

GoJS-compatible: Whether this object casts a drop shadow.

Returns

boolean

Set Signature

set isShadowed(value): void

Defined in: panel/GraphObject.ts:582

Parameters

value

boolean

Returns

void

Inherited from

GraphObject.isShadowed

isUnderline

Get Signature

get isUnderline(): boolean

Defined in: panel/TextBlock.ts:176

GoJS-compatible: Whether the text is underlined.

Returns

boolean

Set Signature

set isUnderline(value): void

Defined in: panel/TextBlock.ts:180

Parameters

value

boolean

Returns

void

isVisibleObject

Get Signature

get isVisibleObject(): boolean

Defined in: panel/GraphObject.ts:379

GoJS-compatible: Whether this object and all of its ancestors are visible.

Returns

boolean

Inherited from

GraphObject.isVisibleObject

margin

Get Signature

get margin(): Margin | null

Defined in: panel/GraphObject.ts:500

The margin around this object.

Returns

Margin | null

Set Signature

set margin(value): void

Defined in: panel/GraphObject.ts:505

GoJS-compatible: a plain number sets a uniform margin on all four sides.

Parameters

value

number | Margin | null

Returns

void

Inherited from

GraphObject.margin

maxLines

Get Signature

get maxLines(): number

Defined in: panel/TextBlock.ts:198

GoJS-compatible: The maximum number of lines of text.

Returns

number

Set Signature

set maxLines(value): void

Defined in: panel/TextBlock.ts:202

Parameters

value

number

Returns

void

multiline

Get Signature

get multiline(): boolean

Defined in: panel/TextBlock.ts:214

Returns

boolean

Set Signature

set multiline(value): void

Defined in: panel/TextBlock.ts:218

Parameters

value

boolean

Returns

void

name

Get Signature

get name(): string

Defined in: panel/GraphObject.ts:95

The name of this graph object, used for findObject() lookups.

Returns

string

Set Signature

set name(value): void

Defined in: panel/GraphObject.ts:99

Parameters

value

string

Returns

void

Inherited from

Placeholder.name

opacity

Get Signature

get opacity(): number

Defined in: panel/GraphObject.ts:405

The opacity of this object (0-1).

Returns

number

Set Signature

set opacity(value): void

Defined in: panel/GraphObject.ts:409

Parameters

value

number

Returns

void

Inherited from

GraphObject.opacity

overflow

Get Signature

get overflow(): string

Defined in: panel/TextBlock.ts:187

GoJS-compatible: How overflowing text is handled (“visible”, “hidden”, “ellipsis”, “clip”).

Returns

string

Set Signature

set overflow(value): void

Defined in: panel/TextBlock.ts:191

Parameters

value

string

Returns

void

parent

Get Signature

get parent(): GraphObject | null

Defined in: panel/GraphObject.ts:389

GoJS-compatible: The parent panel of this object (or null).

Returns

GraphObject | null

Inherited from

GraphObject.parent

part

Get Signature

get part(): Part | null

Defined in: panel/GraphObject.ts:394

GoJS-compatible: The Part that contains this object (or null).

Returns

Part | null

Inherited from

GraphObject.part

pickable

Get Signature

get pickable(): boolean

Defined in: panel/GraphObject.ts:626

GoJS-compatible: Whether this object can be hit-tested.

Returns

boolean

Set Signature

set pickable(value): void

Defined in: panel/GraphObject.ts:630

Parameters

value

boolean

Returns

void

Inherited from

GraphObject.pickable

position

Get Signature

get position(): object

Defined in: panel/GraphObject.ts:471

The position within the parent panel.

Returns

object

x

x: number

y

y: number

Inherited from

GraphObject.position

row

Get Signature

get row(): number

Defined in: panel/GraphObject.ts:515

GoJS-compatible: The row index for table panels.

Returns

number

Set Signature

set row(value): void

Defined in: panel/GraphObject.ts:519

Parameters

value

number

Returns

void

Inherited from

GraphObject.row

rowSpan

Get Signature

get rowSpan(): number

Defined in: panel/GraphObject.ts:533

GoJS-compatible: The number of rows this object spans.

Returns

number

Set Signature

set rowSpan(value): void

Defined in: panel/GraphObject.ts:537

Parameters

value

number

Returns

void

Inherited from

GraphObject.rowSpan

scale

Get Signature

get scale(): number

Defined in: panel/GraphObject.ts:564

GoJS-compatible: The scale of this object relative to its normal size.

Returns

number

Set Signature

set scale(value): void

Defined in: panel/GraphObject.ts:568

Parameters

value

number

Returns

void

Inherited from

GraphObject.scale

shadow

Get Signature

get shadow(): string

Defined in: panel/GraphObject.ts:614

GoJS-compatible: Alias for shadowColor.

Returns

string

Set Signature

set shadow(value): void

Defined in: panel/GraphObject.ts:618

Parameters

value

string

Returns

void

Inherited from

GraphObject.shadow

shadowBlur

Get Signature

get shadowBlur(): number

Defined in: panel/GraphObject.ts:605

GoJS-compatible: The drop shadow blur radius.

Returns

number

Set Signature

set shadowBlur(value): void

Defined in: panel/GraphObject.ts:609

Parameters

value

number

Returns

void

Inherited from

GraphObject.shadowBlur

shadowColor

Get Signature

get shadowColor(): string

Defined in: panel/GraphObject.ts:587

GoJS-compatible: The drop shadow color.

Returns

string

Set Signature

set shadowColor(value): void

Defined in: panel/GraphObject.ts:591

Parameters

value

string

Returns

void

Inherited from

GraphObject.shadowColor

shadowOffset

Get Signature

get shadowOffset(): object

Defined in: panel/GraphObject.ts:596

GoJS-compatible: The drop shadow offset.

Returns

object

x

x: number

y

y: number

Set Signature

set shadowOffset(value): void

Defined in: panel/GraphObject.ts:600

Parameters

value

x

number

y

number

Returns

void

Inherited from

GraphObject.shadowOffset

stroke

Get Signature

get stroke(): string

Defined in: panel/TextBlock.ts:66

GoJS-compatible: Alias for the text color (GoJS uses stroke).

Returns

string

Set Signature

set stroke(value): void

Defined in: panel/TextBlock.ts:70

Parameters

value

string

Returns

void

strokeWidth

Get Signature

get strokeWidth(): number

Defined in: panel/TextBlock.ts:75

GoJS-compatible: The width of the text outline (0 = no outline).

Returns

number

Set Signature

set strokeWidth(value): void

Defined in: panel/TextBlock.ts:79

Parameters

value

number

Returns

void

text

Get Signature

get text(): string

Defined in: panel/TextBlock.ts:49

Returns

string

Set Signature

set text(value): void

Defined in: panel/TextBlock.ts:53

Parameters

value

string

Returns

void

textAlign

Get Signature

get textAlign(): "left" | "right" | "center"

Defined in: panel/TextBlock.ts:206

Returns

"left" | "right" | "center"

Set Signature

set textAlign(value): void

Defined in: panel/TextBlock.ts:210

Parameters

value

"left" | "right" | "center"

Returns

void

visible

Get Signature

get visible(): boolean

Defined in: panel/GraphObject.ts:370

Whether this object is visible.

Returns

boolean

Set Signature

set visible(value): void

Defined in: panel/GraphObject.ts:374

Parameters

value

boolean

Returns

void

Inherited from

GraphObject.visible

width

Get Signature

get width(): number

Defined in: panel/GraphObject.ts:453

GoJS-compatible: the last explicitly-set desired width, or NaN if never set — NOT the object’s current rendered size. Falling back to _actualSize here (as this used to) makes every measure() override (Shape/TextBlock/Picture/Panel, which all gate their real measurement behind !Number.isNaN(this.width)) permanently “lock onto” whatever size an earlier — possibly premature, e.g. before a data binding applied the real text — layout pass happened to produce, since that stale actualSize then reads back as “an explicit width was set” on every later pass and skips remeasuring for good. Those callers must check for NaN specifically, not > 0 — a Binding that legitimately resolves to 0 (e.g. a 0%-progress bar) is still an explicit width.

Returns

number

Set Signature

set width(value): void

Defined in: panel/GraphObject.ts:457

Parameters

value

number

Returns

void

Inherited from

Placeholder.width

wrap

Get Signature

get wrap(): "None" | "Wrap" | "Ellipsis"

Defined in: panel/TextBlock.ts:102

GoJS-compatible: The wrapping mode.

Returns

"None" | "Wrap" | "Ellipsis"

Set Signature

set wrap(value): void

Defined in: panel/TextBlock.ts:106

Parameters

value

"None" | "Wrap" | "Ellipsis"

Returns

void

Methods

addBinding()

addBinding(binding): this

Defined in: panel/GraphObject.ts:119

Add a binding to this graph object (keeps existing bindings).

Parameters

binding

Binding

Returns

this

Inherited from

GraphObject.addBinding

applyBindings()

applyBindings(nodeData): number

Defined in: panel/GraphObject.ts:185

Apply all bindings from model data to this graph object.

Parameters

nodeData

NodeData

Returns

number

Inherited from

GraphObject.applyBindings

clone()

clone(): this

Defined in: panel/TextBlock.ts:241

Deep copy of this text block.

Returns

this

Overrides

GraphObject.clone

containsPoint()

containsPoint(px, py): boolean

Defined in: panel/GraphObject.ts:675

Check if a point is inside this object’s area (for hit testing).

Parameters

px

number

py

number

Returns

boolean

Inherited from

GraphObject.containsPoint

draw()

draw(ctx, x, y, width, height): void

Defined in: panel/TextBlock.ts:293

Draw this object at its computed position and size.

Parameters

ctx

CanvasRenderingContext2D

x

number

y

number

width

number

height

number

Returns

void

Overrides

GraphObject.draw

getBounds()

getBounds(): Rect

Defined in: panel/GraphObject.ts:685

Get the bounds of this object within the panel coordinate space.

Returns

Rect

Inherited from

GraphObject.getBounds

measure()

measure(): Size

Defined in: panel/TextBlock.ts:255

Measure the natural size of this object. Returns the size this object would like to occupy.

Returns

Size

Overrides

GraphObject.measure

measureWithMargin()

measureWithMargin(): Size

Defined in: panel/GraphObject.ts:663

Compute the effective size after applying margin.

Returns

Size

Inherited from

GraphObject.measureWithMargin

removeBinding()

removeBinding(targetProperty): boolean

Defined in: panel/GraphObject.ts:125

Remove a binding by target property. Returns true if removed.

Parameters

targetProperty

string

Returns

boolean

Inherited from

GraphObject.removeBinding

setActualSize()

setActualSize(width, height): void

Defined in: panel/GraphObject.ts:486

Set the actual size during layout.

Parameters

width

number

height

number

Returns

void

Inherited from

GraphObject.setActualSize

setBinding()

setBinding(binding): this

Defined in: panel/GraphObject.ts:112

GoJS-compatible: Set a binding on this graph object, replacing any existing binding with the same target property.

Parameters

binding

Binding

Returns

this

Inherited from

GraphObject.setBinding

setColor()

setColor(value): this

Defined in: panel/TextBlock.ts:229

Fluent setter for color.

Parameters

value

string

Returns

this

setFont()

setFont(value): this

Defined in: panel/TextBlock.ts:235

Fluent setter for font.

Parameters

value

string

Returns

this

setPosition()

setPosition(x, y): void

Defined in: panel/GraphObject.ts:476

Set the position within the parent panel.

Parameters

x

number

y

number

Returns

void

Inherited from

GraphObject.setPosition

setText()

setText(value): this

Defined in: panel/TextBlock.ts:223

Fluent setter for text.

Parameters

value

string

Returns

this

theme()

theme(targetprop, sourceprop?, themeSource?, conv?, themeconv?): this

Defined in: panel/GraphObject.ts:137

GoJS-compatible: add a ThemeBinding from a literal Theme property name to targetprop, e.g. .theme("stroke", "text") assigns stroke to the current theme’s colors.text.

Parameters

targetprop

string

sourceprop?

string

themeSource?

string | null

conv?

(value, data) => unknown

themeconv?

(value, target) => unknown

Returns

this

Inherited from

GraphObject.theme

themeData()

themeData(targetprop, sourceprop?, themeSource?, conv?, themeconv?): this

Defined in: panel/GraphObject.ts:153

GoJS-compatible: add a ThemeBinding whose theme key comes from a data property’s value, e.g. .themeData("fill", "state") looks up data.state and uses that as the colors key.

Parameters

targetprop

string

sourceprop?

string

themeSource?

string | null

conv?

(value, data) => unknown

themeconv?

(value, target) => unknown

Returns

this

Inherited from

GraphObject.themeData

themeModel()

themeModel(targetprop, sourceprop?, themeSource?, conv?, themeconv?): this

Defined in: panel/GraphObject.ts:171

GoJS-compatible: like themeData, but sourced from model-wide data. graphojs has no Model.modelData, so this currently behaves exactly like themeData (resolved against the part’s own data instead).

Parameters

targetprop

string

sourceprop?

string

themeSource?

string | null

conv?

(value, data) => unknown

themeconv?

(value, target) => unknown

Returns

this

Inherited from

GraphObject.themeModel

make()

Call Signature

static make(builder, …args): Panel

Defined in: panel/GraphObject.ts:203

GoJS-compatible static factory method.

Usage: const $ = go.GraphObject.make; const shape = $(go.Shape, “RoundedRectangle”, { fill: “white”, stroke: “gray” }); const panel = $(go.Panel, “Auto”, shape, $(go.TextBlock, “Hello”));

Parameters

builder

string

args

…unknown[]

Returns

Panel

Inherited from

GraphObject.make

Call Signature

static make(ctor, …args): Panel

Defined in: panel/GraphObject.ts:204

GoJS-compatible static factory method.

Parameters

ctor

typeof Node | typeof Link | typeof Group

args

…unknown[]

Returns

Panel

Inherited from

GraphObject.make

Call Signature

static make<T>(ctor, …args): T

Defined in: panel/GraphObject.ts:205

GoJS-compatible static factory method.

Type Parameters

T

T

Parameters

ctor

(…args) => T

args

…unknown[]

Returns

T

Inherited from

GraphObject.make