cee::ug::OverlayColorLegendPropertyHandler

class OverlayColorLegendPropertyHandler

Property handler for overlay color legend properties.

Public Types

enum PropertyKey

List of property keys for OverlayColorLegendPropertyHandler.

Values:

enumerator CONTEXT_RESULT_ID

Context result id.

enumerator TEXT_COLOR

Legend text color.

enumerator LINE_COLOR

Legend line color.

enumerator LINE_WIDTH

enumerator BAR_WIDTH

enumerator VISIBILITY_MODE

enumerator COLOR_MARKER_POSITIONS

enumerator COLOR_MARKER_COLORS

enumerator COLOR_MARKER_DESCRIPTIONS

enumerator CUSTOM_LEGEND_TITLE

enumerator NUMERIC_FORMAT

enumerator NUMERIC_PRECISION

enumerator USER_SCALING_FIRST_DEGREE

enumerator USER_SCALING_CONSTANT

enumerator FORCE_UNIFORM_LEVEL_SPACING

enumerator ABOVE_BELOW_RANGE_MARKER_MODE

enumerator COLOR_MARKER_BOX_HEIGHT

enumerator COLOR_MARKER_VERTICAL_MARGIN

enumerator FORCE_TICKMARKS_OVER_LEGEND

enumerator TICKMARKS_POSITION

enumerator DIRECTION

enumerator TICKMARKS_SKIP_OVERLAPPING_LABELS

enumerator TICKMARKS_MINIMUM_LABEL_DISTANCE

enumerator DRAW_BACKGROUND

enumerator BACKGROUND_COLOR

enumerator BACKGROUND_OPACITY

enumerator BACKGROUND_BORDER_COLOR

enumerator DEPRECATED_VISIBLE

Public Functions

OverlayColorLegendPropertyHandler(PropertySet *propSet)

Creates an overlay color legend 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.

bool decodeContext(int *resultId) const

Decodes the context from the properties.

void encodeContext(int resultId)

Encodes the context as properties.

void applyToScalarSettings(ScalarSettings *scalarSettings) const

Applies the properties in this property set to the specified scalar settings.

void buildProperties(const ScalarSettings &scalarSettings)

Sets the property keys and values for this property set from the scalar settings.

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 color legend property set.