Property

Show usages

Wraps a property together with default values and metadata.

Inheritance Hierarchy

Property

Remarks

This class cannot be instantiated

Type Details

yFiles module: view

Properties

canRead

: boolean

Gets whether or not the property has a public getter.

canWrite

: boolean

Gets whether or not the property has a public setter.

hasDefaultValue

: boolean

Gets a value indicating whether this instance has a default value.

Property Value

true if this instance has a default value; false otherwise.

isContentProperty

: boolean

Gets a value indicating whether this instance is the one defined to be the type's content property.

Property Value

true if this property is the one defined as the type's content property; false otherwise.

isStatic

: boolean

Gets whether or not this is a static property.

name

: string

Gets the name of the property, as it will appear in GraphML.

Property Value

The name.

ownerType

: Constructor

Gets the type of the owner.

Property Value

The type of the owner.

serializationVisibility

: GraphMLMemberVisibility

Gets the serialization visibility.

Property Value

The serialization visibility.

type

: Constructor

Gets the type of the property.

Property Value

The type of the property.

valueSerializer

: ValueSerializer?

Gets the valueSerializer.

Methods

getValue

(ownerInstance: any) : any

Gets the value the wrapped property has on the given instance.

Parameters

options - Object
A map of options to pass to the method.

ownerInstance - any: The instance to get the property value from.

Returns

↪any?: The value the wrapped property has on the given instance.

setValue

(ownerInstance: any, value: any)

Sets the value to the wrapped property on the given instance.

Parameters

options - Object
A map of options to pass to the method.

ownerInstance - any: The instance to set the property value on.
value - any: The value to set.