ThemeBinding

Defined in: binding/ThemeBinding.ts:18

GoJS-compatible: a Binding whose source value comes from the target’s Diagram’s ThemeManager instead of the model data — created by GraphObject.theme() (a literal theme key), themeData() (a data property’s value names the theme key), or themeModel(). Always one-way (theme → target); applyToModel is a no-op.

graphojs has no Model.modelData (a shared, model-wide data object) — themeModel() falls back to the same per-part data lookup themeData() uses, rather than real GoJS’s model-wide source.

Extends

• Binding

Constructors

Constructor

new ThemeBinding(targetprop?, sourceprop?, themeSource?, conv?, themeConverter?): ThemeBinding

Defined in: binding/ThemeBinding.ts:23

Parameters

targetprop?

string = ''

sourceprop?

string

themeSource?

string | null

conv?

(value, data) => unknown

themeConverter?

(value, target) => unknown

Returns

ThemeBinding

Overrides

Binding.constructor

Accessors

mode

Get Signature

get mode(): number

Defined in: binding/Binding.ts:73

GoJS-compatible: Get the mode (BindingMode.OneWay or BindingMode.TwoWay).

Returns

number

Set Signature

set mode(value): void

Defined in: binding/Binding.ts:68

GoJS-compatible: Set the mode to BindingMode.OneWay or BindingMode.TwoWay.

Parameters

value

number

Returns

void

Inherited from

Binding.mode

---

sourceObjectName

Get Signature

get sourceObjectName(): string

Defined in: binding/Binding.ts:48

The name of the source object (default “data”).

Returns

string

Inherited from

Binding.sourceObjectName

---

sourceProperty

Get Signature

get sourceProperty(): string

Defined in: binding/Binding.ts:58

The model data property name to read.

Returns

string

Inherited from

Binding.sourceProperty

---

targetProperty

Get Signature

get targetProperty(): string

Defined in: binding/Binding.ts:53

The target property name to set.

Returns

string

Inherited from

Binding.targetProperty

---

themeConverter

Get Signature

get themeConverter(): ((value, target) => unknown) | null

Defined in: binding/ThemeBinding.ts:55

Returns

((value, target) => unknown) | null

Set Signature

set themeConverter(value): void

Defined in: binding/ThemeBinding.ts:59

Parameters

value

((value, target) => unknown) | null

Returns

void

---

themeSource

Get Signature

get themeSource(): string

Defined in: binding/ThemeBinding.ts:47

Returns

string

Set Signature

set themeSource(value): void

Defined in: binding/ThemeBinding.ts:51

Parameters

value

string

Returns

void

---

twoWay

Get Signature

get twoWay(): boolean

Defined in: binding/Binding.ts:63

Whether this is a TwoWay binding.

Returns

boolean

Inherited from

Binding.twoWay

Methods

applyToModel()

applyToModel(): boolean

Defined in: binding/ThemeBinding.ts:82

Apply TwoWay: read target property and write back to model data. Returns true if the property was set on the model.

Returns

boolean

Overrides

Binding.applyToModel

---

applyToPart()

applyToPart(part, nodeData): boolean

Defined in: binding/Binding.ts:235

Deprecated

Use applyToTarget instead.

Parameters

part

Part

nodeData

NodeData

Returns

boolean

Inherited from

Binding.applyToPart

---

applyToTarget()

applyToTarget(target, nodeData): boolean

Defined in: binding/Binding.ts:100

Apply this binding: read from model data and set on the target. Returns true if the property was set.

Parameters

target

BindingTarget

nodeData

NodeData

Returns

boolean

Inherited from

Binding.applyToTarget

---

copy()

copy(): ThemeBinding

Defined in: binding/ThemeBinding.ts:86

Create a deep copy of this binding.

Returns

ThemeBinding

Overrides

Binding.copy

---

equals()

equals(other): boolean

Defined in: binding/Binding.ts:226

Check if two bindings are equivalent.

Parameters

other

Binding

Returns

boolean

Inherited from

Binding.equals

---

getSourceValue()

getSourceValue(nodeData, target?): unknown

Defined in: binding/ThemeBinding.ts:63

Read the source property from model data, applying the converter if present. Supports dot paths (e.g. “data.name”, “meta.color”). Resolves the source object per ofObject(): “data” (default), “parent”, or a named GraphObject in the visual tree.

Parameters

nodeData

NodeData

target?

BindingTarget

Returns

unknown

Overrides

Binding.getSourceValue

---

getSourceValueFromPart()

getSourceValueFromPart(part): unknown

Defined in: binding/Binding.ts:240

Deprecated

Use getSourceValueFromTarget instead.

Parameters

part

Part

Returns

unknown

Inherited from

Binding.getSourceValueFromPart

---

getSourceValueFromTarget()

getSourceValueFromTarget(target): unknown

Defined in: binding/Binding.ts:217

Read the target property and write to model data, applying back-converter if present.

Parameters

target

BindingTarget

Returns

unknown

Inherited from

Binding.getSourceValueFromTarget

---

makeTwoWay()

makeTwoWay(): this

Defined in: binding/Binding.ts:84

Make this a TwoWay binding so target property changes flow back to the model.

Returns

this

Inherited from

Binding.makeTwoWay

---

ofBackConverter()

ofBackConverter(backConverter): this

Defined in: binding/Binding.ts:90

Set a back-converter for TwoWay bindings that transforms target property → model data.

Parameters

backConverter

(value, target) => unknown

Returns

this

Inherited from

Binding.ofBackConverter

---

ofConverter()

ofConverter(converter): this

Defined in: binding/Binding.ts:78

Set a converter function that transforms model data → target property.

Parameters

converter

(value, data) => unknown

Returns

this

Inherited from

Binding.ofConverter

---

ofData()

ofData(): this

Defined in: binding/ThemeBinding.ts:36

Switch this binding to resolve its theme key from a data property’s value (used by GraphObject.themeData).

Returns

this

---

ofModel()

ofModel(): this

Defined in: binding/ThemeBinding.ts:42

Switch this binding to resolve its theme key from model-wide data (used by GraphObject.themeModel).

Returns

this

---

ofObject()

ofObject(name): this

Defined in: binding/Binding.ts:42

GoJS-compatible: Specify which object is the source of the binding. Common values: “data” (the part’s model data, the default), “parent” (the parent panel’s data). Named GraphObjects are resolved when possible.

Parameters

name

string

Returns

this

Inherited from

Binding.ofObject

---

setTargetValue()

setTargetValue(target, value): void

Defined in: binding/Binding.ts:210

Write a value to the target, applying the back-converter if present.

Parameters

target

BindingTarget

value

unknown

Returns

void

Inherited from

Binding.setTargetValue