The BarGlyphBase class is the base class for small chart glyphs that appear above or below individual bars. BarGlyphs are commonly used to visually represent events such as dividends, splits, earnings, or chart patterns. BarGlyphBase derives from PlotBase, so it also inherits PlotBase's chart access, configuration, coordinate conversion, and rendering functionality.
Returns the ChartPreferences associated with the chart. ChartPreferences contains the colors, styles, spacing, and other settings used when rendering the chart.
Specifies the color associated with this plot object.
Returns the default WPF Brush used when rendering this plot object.
Returns the default WPF Pen used when rendering this plot object.
Returns the WLColor that should be used to render the chart item associated with the BarHistory index idx.
Returns the highest y-axis value required to render this BarGlyph within the supplied BarHistory index range. If the glyph falls within the range and AboveBar is true, the method accounts for the glyph's height and PixelOffset so the chart can allocate sufficient vertical space. Otherwise it returns Double.MinValue.
Returns the lowest y-axis value required to render this BarGlyph within the supplied BarHistory index range. If the glyph falls within the range and AboveBar is false, the method accounts for the glyph's height and PixelOffset so the chart can allocate sufficient vertical space. Otherwise it returns Double.MaxValue.
Returns true if the point in pt falls within the area occupied by the BarGlyph. BarGlyphBase determines the glyph's vertical position using the bar's High or Low, AboveBar, PixelOffset, and GlyphHeight.
Contains the opacity used when rendering this plot object. When reading the property, the value is represented internally on a scale from 0 to 255. When assigning the property, the input represents a percentage from 0 to 100.
The key WealthLab uses when saving the object's Configuration. The default implementation is based on Name followed by "_Configuration".
Contains the configuration of the object expressed as a string. By default, the Configuration is generated from the Parameter instances in Parameters.
Returns a short description of the object. WealthLab can display this text when the object's Parameters are edited.
Displays the standard configuration editor and returns the resulting Configuration string. Derived classes can override this method to provide a custom configuration interface.
Returns whether the object has configurable Parameters.
Returns the name of the plot object.
Contains the Parameter instances that comprise the object's configuration.
Processes a changed Configuration string. The default implementation updates the object's Parameters from the new Configuration.
Converts the DateTime in dt to an x-axis pixel coordinate on the chart.
Converts the BarHistory index in idx to an x-axis pixel coordinate.
Converts the data value in value to a y-axis pixel coordinate in the current chart pane.
Converts the x-axis pixel coordinate in x to the corresponding DateTime in the charted BarHistory.
Converts the x-axis pixel coordinate in x to an index in the charted BarHistory.
Converts the y-axis pixel coordinate in y to its corresponding data value.
Determines whether the BarGlyph is positioned above or below its chart bar. The default value is false, which places the glyph below the bar. Override this property and return true to position the glyph above the bar.
Returns the number of chart bars occupied by the glyph. The default value is 1.
Renders a single-line tooltip for the BarGlyph. This method is typically called from RenderHighlight when the user moves the mouse over the glyph. The tooltip is horizontally centered around the glyph and adjusted to remain within the chart pane.
Renders a multi-line tooltip for the BarGlyph using the supplied ChartTooltip instances. Each ChartTooltip controls the text and color of one line. The tooltip is positioned relative to the glyph and adjusted as necessary to remain inside the chart pane.
Specifies the height of the BarGlyph in pixels. The default value is 12.
Specifies the width of the BarGlyph in pixels. The default value is 12.
Specifies an additional vertical offset, in pixels, used when positioning the BarGlyph. WealthLab can use this value to separate multiple glyphs that occur on the same chart bar.
Returns whether the plot object renders a special state when the mouse is positioned over it.
WealthLab calls this method after the main rendering phase has completed.
WealthLab calls this method before the main rendering phase begins.
Override this method to render the plot object onto the supplied WPF DrawingContext.
WealthLab calls this method when the plot object's mouse-over state should be rendered. A BarGlyph implementation can override this method and call DrawTooltip or DrawTooltips to display information about the glyph.
Returns the chart rendering pass in which the plot object participates. WealthLab renders charts in multiple passes so that relatively static chart content can be buffered separately from transient elements such as cursors and mouse-over effects.