com.github.gwtd3.api.functions

Class PropertyValueFunction<T>

java.lang.Object

com.github.gwtd3.api.functions.PropertyValueFunction<T>

Type Parameters:

T -

All Implemented Interfaces:

DatumFunction<T>

public class PropertyValueFunction<T>
extends Object
implements DatumFunction<T>

A convenient DatumFunction which returns the value of a specified property for each datum.

Author:

Anthony Schiochet

Constructor Summary

Constructors

Constructor and Description
PropertyValueFunction(String propertyName)

Method Summary

Methods

Modifier and Type	Method and Description
T	apply(com.google.gwt.dom.client.Element context, Value d, int index) Apply the function for the given Element at the specified index of the Selection mapped to the given Datum.
static <X> PropertyValueFunction<X>	forProperty(String propertyName) Create a PropertyValueFunction which returns the value of the property with the given name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyValueFunction

public PropertyValueFunction(String propertyName)

Method Detail

forProperty

public static <X> PropertyValueFunction<X> forProperty(String propertyName)

Create a PropertyValueFunction which returns the value of the property with the given name

Parameters:

propertyName - the name of the property the value should be returned of

Returns:

the new function

apply

public T apply(com.google.gwt.dom.client.Element context,
      Value d,
      int index)

Description copied from interface: DatumFunction

Apply the function for the given Element at the specified index of the Selection mapped to the given Datum.

Note that if no datum is mapped to the element, Datum#isUndefined() will return true.

Specified by:

apply in interface DatumFunction<T>

Parameters:

context - the current element, may be irrelevant or null in some context.

d - the datum

index - the index of the element in the selection

Returns:

a result to be applied