Click or drag to resize

IGPlotItem Interface

Interface for a plottable item.

Namespace: Altaxo.Graph.Graph3D.Plot
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
Copy
public interface IGPlotItem : IGPlotItem, 
	ICopyFrom, ICloneable, IChangedEventSource, IDocumentLeafNode, INamedObject, 
	ISuspendableByToken, ITunnelingEventSource, IDisposable, ITreeNodeWithParent<IDocumentLeafNode>, 
	ITreeNode<IDocumentLeafNode>, INodeWithParentNode<IDocumentLeafNode>, ITreeListNodeWithParent<IGPlotItem>, 
	ITreeListNode<IGPlotItem>, ITreeNode<IGPlotItem>, INodeWithParentNode<IGPlotItem>

The IGPlotItem type exposes the following members.

Properties
 NameDescription
Public propertyChildNodes Gets the child nodes.
(Inherited from ITreeNodeT)
Public propertyDataObject Gets an object that holds the data used for plotting. If not applicable for this kind of plot item, null is returned.
(Inherited from IGPlotItem)
Public propertyIsDisposed Gets a value indicating whether this instance is disposed.
(Inherited from IDocumentLeafNode)
Public propertyIsDisposeInProgress Gets a value indicating whether this instance is dispose in progress, or the instance is already disposed.
(Inherited from IDocumentLeafNode)
Public propertyIsSuspended Gets a value indicating whether this instance is suspended.
(Inherited from ISuspendableByToken)
Public propertyName Gets the name of this instance. An InvalidOperationException will be thrown if the name is not yet set or can not be retrieved.
(Inherited from INamedObject)
Public propertyParentCollection The collection where this plot item belongs to. Can be null for the root item.
Public propertyParentNode Gets the parent node of this node.
(Inherited from INodeWithParentNodeT)
Public propertyParentObject Retrieves the parent object.
(Inherited from IDocumentLeafNode)
Public propertyStyleObject Gets an object that holds the style(s) used for plotting. If not applicable for this kind of plot item, null is returned.
(Inherited from IGPlotItem)
Top
Methods
 NameDescription
Public methodApplyGroupStyles Applies the group styles to this plot item. This function is called for all plot items in a group before the next function (for instance PreparePainting) is called.
Public methodCloneCreates a new object that is a copy of the current instance.
(Inherited from ICloneable)
Public methodCollectStyles Collects all possible group styles that can be applied to this plot item in styles. The styles collected here should be only external styles, i.e. such styles that are indended to be share between different plot items.
Public methodCopyFrom Try to copy from another object. Should try to copy even if the object to copy from is not of the same type, but a base type. In this case only the base properties should be copied.
(Inherited from ICopyFrom)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodEhParentTunnelingEventHappened
(Inherited from IDocumentLeafNode)
Public methodGetName The name of the plot. It can be of different length. An argument of zero or less returns the shortest possible name, higher values return more verbose names.
(Inherited from IGPlotItem)
Public methodHitTest Test wether the mouse hits a plot item. The default implementation returns null. If you want to have a reaction on mouse click on a curve, return a IHitTestObject.
Public methodPaint This paints the plot to the layer.
Public methodPaintPostprocessing Called after painting has finished. Can be used to release resources.
Public methodPaintPreprocessing Called before painting takes place.
Public methodPaintSymbol Paints a symbol for this plot item for use in a legend.
Public methodPrepareGroupStyles Prepare the group styles before applying them. This function is called for all plot items in a group before the ApplyStyle function is called.
Public methodPrepareScales This routine ensures that the plot item updates all its cached data and send the appropriate events if something has changed. Called before the layer paint routine paints the axes because it must be ensured that the axes scales are scaled correctly before the plots are painted. This function is called before the call to PrepareStyles.
Public methodSetDisposeInProgress Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from IDocumentLeafNode)
Public methodSetPlotStyleFromTemplate Sets the plot style (or sub plot styles) in this item according to a template provided by the plot item in the template argument.
Public methodSuspendGetToken Suspends the event handling of the object by getting a suspend token. The event handling of the object is resumed when the suspend token is disposed.
(Inherited from ISuspendableByToken)
Public methodTryGetName Test if this item already has a name.
(Inherited from INamedObject)
Public methodVisitDocumentReferences Replaces path of items (intended for data items like tables and columns) by other paths. Thus it is possible to change a plot so that the plot items refer to another table.
(Inherited from IGPlotItem)
Top
Events
 NameDescription
Public eventChangedFired when something in the object has changed.
(Inherited from IChangedEventSource)
Public eventTunneledEvent The event that is fired when the object is disposed. First argument is the sender, second argument is the original source, and third argument is the event arg.
(Inherited from ITunnelingEventSource)
Top
Extension Methods
 NameDescription
Public Extension MethodGetPropertyContext Gets the property context of the document node. If the provided node is not implementing IPropertyBagOwner, the parent nodes of this node are searched, until a node which implements IPropertyBagOwner is found.
(Defined by PropertyExtensions)
Top
See Also