# cee::ug::OverlayPlotPropertyHandler

class `OverlayPlotPropertyHandler`

  Property handler for overlay plot properties.

  Public Types

  enum `PropertyKey`

    List of property keys for OverlayPlotPropertyHandler.

    Values:

    enumerator `CONTEXT_OVERLAY_PLOT_ID`

      Unique id for identifying a plot.

    enumerator `HEIGHT`

      Overlay plot height

    enumerator `WIDTH`

      Overlay plot width

    enumerator `TITLE`

      Plot title.

    enumerator `DRAW_BACKGROUND`

      Draw background.

    enumerator `BACKGROUND_COLOR`

      Background color

    enumerator `BACKGROUND_OPACITY`

      Background opacity

    enumerator `BORDER_COLOR`

      Border color.

    enumerator `BORDER_WIDTH`

      Border width.

    enumerator `DRAW_BORDER`

      Draw border.

    enumerator `X_AXIS_TITLE`

      The title of the x axis.

    enumerator `Y_AXIS_TITLE`

      The title of the y axis.

    enumerator `X_AXIS_RANGE_MIN`

      Minimum x axis range value.

    enumerator `X_AXIS_RANGE_MAX`

      Maximum x axis range value.

    enumerator `Y_AXIS_RANGE_MIN`

      Minimum y axis range value.

    enumerator `Y_AXIS_RANGE_MAX`

      Maximum y axis range value.

    enumerator `DRAW_LEGEND`

      Draw the curve legend.

    enumerator `TEXT_COLOR`

      Color of text in the plot (labels/titles)

    enumerator `DRAW_GRID_LINES`

      Draw grid lines.

    enumerator `DRAW_MARKER_LINE`

      Draw marker line.

    enumerator `MARKER_LINE_VALUE`

      Marker line value.

    enumerator `MARKER_LINE_COLOR`

      Marker line color.

    enumerator `AXIS_COLOR`

      Axis color.

    enumerator `AXIS_GRID_LINES_COLOR`

      Axis grid lines color.

    enumerator `LOGARITHMIC_SCALE_X`

      Use logarithmic scaling.

    enumerator `LOGARITHMIC_SCALE_Y`

      Use logarithmic scaling.

  Public Functions

  `OverlayPlotPropertyHandler`(PropertySet *propSet)

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

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...