Parent: PlotBase
The base class for the small icons (glyphs) that are plotted on the chart to represent events like dividends, splits, or candlestick chart patterns. They are the visual depiction of the EventDataPoint instances that are generated by Event Data Providers. The EventProviderBase class can override the GetBarGlyph method to assign custom BarGlyphs for its EventDataPoint instances.
Returns the BarHistory instance which represents the historical data currently being charted.
Returns an instance of the ChartPreferences class, which contains properties that describe the colors and styles to use when rendering the chart.
Specifies the color that should be used when plotting this plot object.
Returns the default Brush object that should be used when rendering this plot object.
Returns the default Pen object that should be used when rendering this plot object.
Returns the color that should be used to render the bar number corresponding to the the idx index.
Returns the highest y-axis value that the plot object requires within the specified start and end index range. The index range is based on the BarHistory instance being charted (the Bars property).
Returns the lowest y-axis value that the plot object requires within the specified start and end index range. The index range is based on the BarHistory instance being charted (the Bars property).
Returns whether the mouse position, contained in the pt parameter, is considered to be hovering over this plot object.
Contains the opacity value that should be used when rendering this plot object. When reading this property, the value is returned as a byte in the range of 0 to 255. When setting the value, the setter expects a byte value in the range of 0 to 100 (it internally converts this input value to the 0 to 255 scale).
The key that is used when WL8 saves this item's Configuration to the user's local file system. By default, ConfigKey is composed of Name + "_Configuration". You can override this property in case you want to have two or more Configurable objects share the same configuration.
Contains the configuration of the item expressed as a single string. By default, this string is composed by persisting the Parameter instances contained in the Parameters property.
Returns a short description of the item. If the user edits the item's Parameters, this text appears in the editor dialog.
The default implementation causes a parameter editor dialog to appear, allowing the user to modify the instance's Parameters. You can override this behavior to show your own editor interface. If you do so, pass the modified Configuration string back as the return value.
The default implementation returns true if the Parameters property contains one or more Parameter instances.
Returns the name of the instance.
Contains the Parameter instances that comprise the configuration for this instance. See the ParameterList entry for more details.
You can override this method to perform special processing after the instance's Configuration has changed. The default implementation parses the Configuration string and assigns the result to a new Parameters instance.
Converts the specified DateTime value in the dt parameter to an x-axis pixel location on the chart.
Converts an index value of the BarHistory instance being plotted (Bars property) to an x-axis pixel location.
Converts the specified double value to a y-axis pixel location on the chart.
Converts an x-axis pixel location to a DateTime value that represents where the x-axis location occurs within the BarHistory instance (Bars property) being charted.
Converts an x-axis pixel value to an index into the BarHistory instance (Bars property) being charted.
Converts the specified y-axis pixel location in the y parameter to a double value.
Determines if the BarGlyph is rendered above or below the bar on the chart. The default value is false. You can override and return true this in a derived class to cause the BarGlyph to be rendered above the chart bar.
In your implementation of RenderHighlight, you can call this method to render a tooltip for this BarGlyph when the mouse hovers over it.
In your implementation of RenderHighlight, you can call this method to render a multi-line tooltip for this BarGlyph when the mouse hovers over it. The tooltips parameter is a List of ChartTooltip instances that describe each line of the tooltip.
Assign the height of the BarGlyph, in pixels. WL8 uses this value to determine how to position the glyph in relation to its chart bar.
Assign the width of the BarGlyph, in pixels. WL8 uses this value to determine how to center the glyph in relation to its chart bar.
Returns whether or not the plot object renders a special state when the user moves the mouse over it. This handles effects like the mouse-over highlighting when you drag an indicator atop another indicator, or move the mouse over a drawing object.
WL8 calls this after completing the main rendering phase.
WL8 calls this prior to entering the main rendering phase.
WL8 calls this when the plot object should be rendered to the DrawingContext specified in dc.
WL8 calls this when a mouse-over effect should be rendered for this plot object to the DrawingContext specified in dc.
The WL8 chart renders in two passes. The first pass renders items, such as the chart bars and indicators, into a buffer. This first rendering pass occurs only when required, for example when the chart is scrolled or changes size. The second rendering pass copies this buffer to the display, and then renders items such as the crosshair cursor, indicator value labels, and mouse-over highlight effects. The RenderPass property returns either 1 or 2, instructing the chart on which rendering pass this plot object should take part in.