Future<T>

A helper holder class that can contain a value of a specific type.

Inheritance Hierarchy

Future

Implemented Interfaces

Remarks

Typically hasValue will be false until at a later point in time onValueDetermined is called and the value and hasValue properties are being updated and the PropertyChanged event is triggered.

Type Parameters

T: The type of the

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.graphml.Future

Properties

hasValue

: boolean

Gets a value indicating whether this instance has been assigned a value.

value

: T

Gets the value of this future, which may only be queried if hasValue yields true.

Throws

Exception({ name: 'InvalidOperationError' }): If this property is queried although returns false.

Methods

onValueDetermined

(value: T)

Called when the value property of this future has been determined.

Remarks

This will set the hasValue property to true and assign the value property. Also the corresponding PropertyChanged events will be triggered if necessary.

Parameters

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

value - T: The value.

Events

PropertyChanged

Occurs when a property value changes.

Remarks

This event will be triggered for hasValue changes and changes of the value property. Note that if the determined future value is the same as the default, the event will only be triggered for the hasValue property.

Overrides

IPropertyObservable.PropertyChanged

Event Registration

addPropertyChangedListener(function(this, PropertyChangedEventArgs):void)

Event Deregistration

removePropertyChangedListener(function(this, PropertyChangedEventArgs):void)

Signature Details

function(sender: any, args: PropertyChangedEventArgs)

Defines the handler for a PropertyChanged event.

Parameters

sender - any: The object which dispatched the event.
args - PropertyChangedEventArgs: The arguments which define the change.