cee::ug::OverlayPlotCurvePropertyHandler

class OverlayPlotCurvePropertyHandler

Property handler for overlay plot curve properties.

Public Types

enum PropertyKey

List of property keys for OverlayPlotCurvePropertyHandler.

Values:

enumerator CONTEXT_OVERLAY_PLOT_ID

Unique id for identifying a plot.

enumerator VTFX_PLOT_DATA_INDEX

Index of VTFx data block containing the plot data.

enumerator VTFX_PLOT_VARIABLE_INDEX_X

Index of variable in VTFx data block containing curve values for x axis.

enumerator VTFX_PLOT_VARIABLE_INDEX_Y

Index of variable in VTFx data block containing curve values for y axis.

enumerator TITLE

Curve title

enumerator COLOR

Curve color

Public Functions

OverlayPlotCurvePropertyHandler(PropertySet *propSet)

Creates an overlay plot curve property handler from a given property set propSet.

Variant propertyValue(PropertyKey key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void setPropertyValue(PropertyKey key, Variant data)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.

Public Static Functions

static Str propertySetClassType()

Returns the class type of the property set.

static bool isValidPropertySet(const PropertySet &propSet)

Returns true if the specified property set is a valid overlay plot property set.