XYPlotLayer Class

XYPlotLayer represents a rectangular area on the graph, which holds plot curves, axes and graphical elements.

Inheritance Hierarchy

SystemObject
  Altaxo.MainSuspendableDocumentNodeBase
    Altaxo.MainSuspendableDocumentNode
      Altaxo.MainSuspendableDocumentNodeWithSetOfEventArgs
        Altaxo.Graph.GdiHostLayer
          Altaxo.Graph.GdiXYPlotLayer

Namespace: Altaxo.Graph.Gdi
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

Copy

public class XYPlotLayer : HostLayer, 
	IPlotArea

The XYPlotLayer type exposes the following members.

Constructors

	Name	Description
	XYPlotLayer(HostLayer)	Initializes a new instance of the XYPlotLayer class
	XYPlotLayer(IXmlDeserializationInfo)	Constructor for deserialization purposes only.
	XYPlotLayer(XYPlotLayer)	The copy constructor.
	XYPlotLayer(HostLayer, G2DCoordinateSystem)	Initializes a new instance of the XYPlotLayer class
	XYPlotLayer(HostLayer, IItemLocation)	Creates a layer at the designated location
	XYPlotLayer(HostLayer, IItemLocation, G2DCoordinateSystem)	Creates a layer at the provided location.

Top

Properties

	Name	Description
	AccumulatedEventData	Gets the accumulated event data. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AxisStyleIDs	Returns a list of the used axis style ids for this layer.
	AxisStyles	Collection of the axis styles for the left, bottom, right, and top axis.
	ClipDataToFrame
	CoordinateSystem
	Debug_AbsolutePath	Gets the absolute path of the node for debugging purposes. (Inherited from SuspendableDocumentNodeBase)
	DefaultChildLayerPosition	Gets the default child layer position in points (1/72 inch). (Inherited from HostLayer)
	DefaultChildLayerSize	Gets the default child layer size in points (1/72 inch). (Inherited from HostLayer)
	DefaultXAxisTitleString
	DefaultYAxisTitleString
	GraphObjects	(Inherited from HostLayer)
	Grid	(Inherited from HostLayer)
	GridPlanes
	Is3D
	IsDisposed	Gets a value indicating whether this instance is disposed. (Inherited from SuspendableDocumentNodeBase)
	IsDisposeInProgress	Gets a value indicating whether for this instance dispose is in progress, or the instance is already disposed. (Inherited from SuspendableDocumentNodeBase)
	IsLinear
	IsResumeInProgress	Gets a value indicating whether this instance is currently resuming the events. (Inherited from SuspendableDocumentNode)
	IsSomeoneListeningToChanges	Gets a value indicating whether someone is listening to changes. For this, either the ParentObject or the Changed event must be set. (Inherited from SuspendableDocumentNodeBase)
	IsSuspended	Gets a value indicating whether this instance is suspended. (Inherited from SuspendableDocumentNode)
	IsSuspendedOrResumeInProgress	Gets a value indicating whether this instance is suspended or resume is currently in progress. (Inherited from SuspendableDocumentNode)
	IsXAxisLinked	Indicates if x axis is linked to the linked layer x axis.
	IsYAxisLinked	Indicates if y axis is linked to the linked layer y axis.
	LayerNumber	Get the index of this layer in the parent's layer collection. (Inherited from HostLayer)
	Layers	Gets the child layers of this layer. (Inherited from HostLayer)
	Legend
	Location	(Inherited from HostLayer)
	Name	Gets the name of this document node. Null is returned if the name is not set or unknown. The set accessor will for most nodes throw a InvalidOperationException, since the name can only be set on IProjectItems. (Inherited from SuspendableDocumentNodeBase)
	Number	The layer number. (Inherited from HostLayer)
	ParentLayer	(Inherited from HostLayer)
	ParentLayerSize	The boundaries of the printable area of the page in points (1/72 inch). (Inherited from HostLayer)
	ParentObject	(Inherited from HostLayer)
	PlotItems
	Position	(Inherited from HostLayer)
	Rotation	(Inherited from HostLayer)
	Scales
	ScaleX	(Inherited from HostLayer)
	ScaleY	(Inherited from HostLayer)
	ShearX	(Inherited from HostLayer)
	SiblingLayers	Gets the sibling layers of this layer including this layer itself. (Inherited from HostLayer)
	Size	(Inherited from HostLayer)
	XAxis	Gets or sets the x axis of this layer.
	XTicks
	YAxis	Gets or sets the y axis of this layer.
	YTicks
	ZAxis

Top

Methods

	Name	Description
	AccumulateChangeData	(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AccumulatedChangeData_SetBackAfterResumeAndSuspend	(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AccumulatedEventData_Clear	Clears the accumulated event data. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AccumulatedEventData_HasZeroOrOneEventArg	Determines whether there is no or only one single event arg accumulated. If this is the case, the return value is true. If there is one event arg accumulated, it is returned in the argument singleEventArg. The return value is false if there is more than one event arg accumulated. In this case the singleEventArg is null on return, and the calling function should use AccumulatedEventData to enumerate all accumulated event args. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	CalculateCachedSizeAndPosition	Sets the cached size value in _cachedLayerSize by calculating it from the position values (_location.Width and .Height) and the size types (_location.WidthType and .HeightType). (Inherited from HostLayer)
	CalculateMatrix	(Inherited from HostLayer)
	CanCreateGridForLocation	Determines whether this layer is able to create a grid, so that a child layer with a given location fits into a grid cell. (Inherited from HostLayer)
	ChildCloneFromT	Clones a node that is intended to use as child node of this instance (e.g. in collections). Consider using ChildCloneToMemberT(T, T) instead if the child node is stored in a member of this instance. (Inherited from SuspendableDocumentNode)
	ChildCloneToMemberT	Sets a member variable that holds a child with a cloned instance of another variable. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then cloned using System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildCloneToMemberAltT	Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. The value to set may or may not implement ICloneable. If it implements ICloneable, then the member variable is set to a clone of the value. Otherwise, the member variable is set directly with the value. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ChildCopyToMemberT	Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then copied using either Main.ICopyFrom or System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildCopyToMemberOrCreateNewT	Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. If the node is not null, the node is then copied using either Main.ICopyFrom or System.ICloneable. If the node is null, a new node is created using the provided generation function. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildDisposeMemberT	Helper function to dispose a child node of this instance. It helps to ensure the correct order: first, the child node is set to null and only then the child node is disposed. (Inherited from SuspendableDocumentNodeBase)
	ChildSetMemberT	Set a member variable that holds a child node of this instance. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ChildSetMemberAltT	Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ClearLegends	Clears all legends from this layer.
	Clone	(Overrides HostLayerClone)
	CopyFrom(Object)	(Inherited from HostLayer)
	CopyFrom(HostLayer, GraphCopyOptions)	(Inherited from HostLayer)
	CountEvent	Counts the number of events during the suspend state. Every call to this function will increment the event counter by 1 (but only in the suspended state). The event counter will be reset to zero when the object is resumed. (Inherited from SuspendableDocumentNode)
	CreateDefaultAxes	This will create the default axes styles that are given by the coordinate system.
	CreateDefaultGrid	Creates the default grid. It consists of three rows and three columns. Columns 0 and 2 are the left and right margin, respectively. Rows 0 and 2 are the top and bottom margin. The cell column 1 / row 1 is intended to hold the child layer. (Inherited from HostLayer)
	CreateGridForLocation	Creates the grid, so that a child layer with the location given by the argument itemLocation fits into the grid at the same position as before. You should check with CanCreateGridForLocation(ItemLocationDirect) whether it is possible to create a grid for the given item location. (Inherited from HostLayer)
	CreateGridIfNullOrEmpty	If the Grid is null, then create a grid that represents the boundaries of the child layers. (Inherited from HostLayer)
	CreateNewLayerLegend	Creates a new legend, removing the old one.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from SuspendableDocumentNodeBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the XYPlotLayer and optionally releases the managed resources (Overrides HostLayerDispose(Boolean))
	EhBoundaryChangedEventFromPlotItem
	EhChildChanged	Used by childs of this object to inform us about a change in their state. (Inherited from SuspendableDocumentNode)
	EhDeserializationFinished	Takes final measures after the deserialization has finished, but before the dirty flag is cleared. Here, the scale bounds are updated with the data from the project.
	EhParentTunnelingEventHappened	Is called by the parent when a tunneling event happened in the parent. (Inherited from SuspendableDocumentNode)
	EhSelfChanged	Called if some (simple) member or property of this instance itself has changed. (Inherited from SuspendableDocumentNode)
	EhSelfTunnelingEventHappened(TunnelingEventArgs)	Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is additionally distributed to all childs of this instance. (Inherited from SuspendableDocumentNodeBase)
	EhSelfTunnelingEventHappened(TunnelingEventArgs, Boolean)	Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is - depending on the provided parameter - also distributed to all childs of this instance. (Inherited from SuspendableDocumentNode)
	EhXBoundaryChangedEventFromPlotItem	This handler is called if a x-boundary from any of the plotassociations of this layer has changed. We then have to recalculate the boundaries.
	EhYBoundaryChangedEventFromPlotItem	This handler is called if a y-boundary from any of the plotassociations of this layer has changed. We then have to recalculate the boundaries.
	EnumerateFromHereToLeaves	Enumerates all document node including this node, its child nodes, its child-child nodes up to the leaf nodes. (Inherited from SuspendableDocumentNode)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteFromTopmostChildToRoot	Executes an action on each child layer, including this layer, beginning with the topmost child (the first child of the first child of...). (Inherited from HostLayer)
	Finalize	Finalizes an instance of the SuspendableDocumentNodeBase class. (Inherited from SuspendableDocumentNodeBase)
	FixAndTestParentChildRelationShipOfLayers	(Inherited from HostLayer)
	FixupInternalDataStructures	Adjusts the internal data structures to ensure its validity. (Overrides HostLayerFixupInternalDataStructures)
	ForwardTransform	(Inherited from HostLayer)
	GetChildObjectNamed	retrieves the object with the name C# Copy name . (Overrides SuspendableDocumentNodeGetChildObjectNamed(String))
	GetDocumentNodeChildrenWithName	(Overrides HostLayerGetDocumentNodeChildrenWithName)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLogical3D(AltaxoVariant, AltaxoVariant)
	GetLogical3D(I3DPhysicalVariantAccessor, Int32)
	GetNameOfChildObject	Retrieves the name of the provided object. (Overrides SuspendableDocumentNodeGetNameOfChildObject(IDocumentLeafNode))
	GetScale
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GraphToLayerCoordinates	(Inherited from HostLayer)
	HandleHighPriorityChildChangeCases	(Overrides HostLayerHandleHighPriorityChildChangeCases(Object, EventArgs))
	HandleLowPriorityChildChangeCases	Processes the event args e when this object is not suspended. This function serves two purposes: i) updating some cached data of this object by processing the event args of the child, and ii) optional transforming the event args, for instance to a new type, which afterwards is send to the parent and is used as event args in the [E:Changed] event of this object. The transformed event args is not used if this object is suspended (in this case the original event args is used). (Inherited from SuspendableDocumentNode)
	HitTest(HitTestPointData)	(Inherited from HostLayer)
	HitTest(HitTestRectangularData)	Hit test of retangular hit test data against the layer (here treated as IGraphicBase object). Decision is here not to allow the layer itself to be selected by rectangular selection, instead we allow all subobjects to be selected. (Inherited from HostLayer)
	HitTest(HitTestPointData, Boolean)	(Overrides HostLayerHitTest(HitTestPointData, Boolean))
	HitTest(HitTestRectangularData, ListIHitTestObject)	Collects all sub-objects of this layer that are selected by a rectangular selection area into a list. (Inherited from HostLayer)
	InitializeXScaleDataBounds	Initializes the x scale data bounds, for instance if the scale instance has changed or was deserialized.
	InitializeYScaleDataBounds	Initializes the y scale data bounds, for instance if the scale instance has changed or was deserialized.
	InternalCopyFrom	Internal copy from operation. It is presumed, that the events are already suspended. Additionally, it is not neccessary to call the OnChanged event, since this is called in the calling routine. (Overrides HostLayerInternalCopyFrom(HostLayer, GraphCopyOptions))
	InternalCopyGraphItems(HostLayer, GraphCopyOptions)	(Overrides HostLayerInternalCopyGraphItems(HostLayer, GraphCopyOptions))
	InternalCopyGraphItems(HostLayer, GraphCopyOptions, FuncIGraphicBase, Boolean)	(Inherited from HostLayer)
	IsCompatibleWithParent	(Inherited from HostLayer)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NotifyChildrenTunnelingEventHappened	Notifies the child nodes of this instance that a tunneling event has happened. (Inherited from SuspendableDocumentNode)
	OnAboutToBeResumed	Is called when the suspend level is still 1 (one), but is about to fall to zero, i.e. shortly before the call to OnResume(Int32). This function is not called before OnResumeSilently(Int32)! (Inherited from SuspendableDocumentNode)
	OnCachedResultingPositionChanged	Called when the resulting position of this layer has changed. Is intended to inform child layers and own dependend objects of the position change. Because it is only the cached position, it will not raise changed events. Those events must be raised in the function that caused the change of the resulting position. (Inherited from HostLayer)
	OnCachedResultingSizeChanged	(Overrides HostLayerOnCachedResultingSizeChanged)
	OnChanged	(Overrides SuspendableDocumentNodeBaseOnChanged(EventArgs))
	OnCoordinateSystemChanged
	OnGraphObjectsCollectionInstanceInitialized	(Overrides HostLayerOnGraphObjectsCollectionInstanceInitialized)
	OnLayerNumberChanged	Is called by the parent layer if the index of this layer has changed. (Inherited from HostLayer)
	OnResume	Is called when the object is resumed, i.e. change notifications are allowed again. During the execution of this function, the [P:IsResumeInProgress] property will return true to indicate that the resume is currently in progress. (Inherited from SuspendableDocumentNode)
	OnResumeSilently	Is called when the suspend level falls down from 1 to zero by a call to ResumeSilently. This implementation disarma the suspendTokens of the childs of this object, deletes any accumulated events, and does not send any change event to the parent or the listeners of the Change event. (Inherited from SuspendableDocumentNode)
	OnSuspended	Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended. (Inherited from SuspendableDocumentNode)
	OnTunnelingEvent	Fires the TunneledEvent event. (Inherited from SuspendableDocumentNodeBase)
	OnUserRescaledAxes	Called when the user pressed the rescale button.
	Paint	(Inherited from HostLayer)
	PaintInternal	(Overrides HostLayerPaintInternal(Graphics, IPaintContext))
	PaintPostprocessing	This function is called when painting is finished. Can be used to release the resources not neccessary any more. (Overrides HostLayerPaintPostprocessing)
	PaintPreprocessing	(Overrides HostLayerPaintPreprocessing(IPaintContext))
	PrependTransformationTo	Appends the transformation matrix of this instance to the matrix given in matrix. (Inherited from HostLayer)
	Remove	(Overrides HostLayerRemove(GraphicBase))
	Resume(ISuspendToken)	Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. If Event data were accumulated during the suspended state, a changed event is triggered for each event data. (Inherited from SuspendableDocumentNodeBase)
	Resume(ISuspendToken, EventFiring)	Resumes changed events, either with taking the accumulated event data into account (see Resume(ISuspendToken)) or discarding the accumulated event data (see ResumeSilently(ISuspendToken), depending on the provided argument eventFiring. (Inherited from SuspendableDocumentNodeBase)
	ResumeCompleteTemporarily	Resumes the object completely for only a short time. Thus, if object was suspended before, it will be suspended again when the function returns. (Inherited from SuspendableDocumentNode)
	ResumeCompleteTemporarilyGetToken	Resumes the object completely for the time the returned token is referenced and not disposed. The return value is a token that had 'absorbed' the suspend count of the object, resulting in the suspend count of the object dropped to 0 (zero). When the returned token is finally disposed, the suspend count of the object is increased again by the 'absorbed' suspend count. (Inherited from SuspendableDocumentNode)
	ResumeSilently	Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. All event data accumulated during the suspended state are discarded, and thus no change event is triggered even if the instance has changed during the suspended state. (Inherited from SuspendableDocumentNodeBase)
	SetDisposeInProgress	Sets the flag that dispose is in progress for this node and all child nodes recursively. (Inherited from SuspendableDocumentNode)
	SetMemberAndRaiseSelfChangedT(NullableT, NullableT)	Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetMemberAndRaiseSelfChangedT(T, T)	Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetMemberEnumAndRaiseSelfChangedT	Sets a member variable (which is an Enum) of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetParentSize	(Inherited from HostLayer)
	SetPositionSize	(Inherited from HostLayer)
	SizeToDefault	Set this layer to the default size and position. (Inherited from HostLayer)
	SuspendGetToken	Suspend will increase the SuspendLevel. (Inherited from SuspendableDocumentNode)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TransformationFromRootToHere	(Inherited from HostLayer)
	TransformCoordinateDifferencesFromParentToHere	Converts X,Y differences in page units to X,Y differences in layer units (Inherited from HostLayer)
	TransformCoordinatesFromHereToParent(GraphicsPath)	Transforms a graphics path from layer coordinates to graph (page) coordinates (Inherited from HostLayer)
	TransformCoordinatesFromHereToParent(PointD2D)	Transforms a PointD2D from layer coordinates to graph (=printable area) coordinates (Inherited from HostLayer)
	TransformCoordinatesFromHereToRoot	(Inherited from HostLayer)
	TransformCoordinatesFromParentToHere(Graphics)	This switches the graphics context from printable area coordinates to layer coordinates. (Inherited from HostLayer)
	TransformCoordinatesFromParentToHere(PointD2D)	(Inherited from HostLayer)
	TransformCoordinatesFromRootToHere	(Inherited from HostLayer)
	TryGetName	Test if this item already has a name. (Inherited from SuspendableDocumentNodeBase)
	UpdateCSPlaneID	Updates the logical value of a plane id in case it uses a physical value.
	VisitDocumentReferences	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. (Overrides HostLayerVisitDocumentReferences(DocNodeProxyReporter))

Top

Events

	Name	Description
	Changed	Fired when something in the object has changed, and the object is not suspended. (Inherited from SuspendableDocumentNodeBase)
	LayerCollectionChanged	Fired when the child layer collection changed. (Inherited from HostLayer)
	PositionChanged	Fired when the position of the layer changed. (Inherited from HostLayer)
	SizeChanged	Fired when the size of the layer changed. (Inherited from HostLayer)
	TunneledEvent	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 SuspendableDocumentNodeBase)

Top

Fields

	Name	Description
	_accumulatedEventData	The accumulated event data. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	_axisStyles
	_cachedLayerNumber	The number of this layer in the parent's layer collection. (Inherited from HostLayer)
	_cachedLayerPosition	The cached layer position in points (1/72 inch) relative to the upper left corner of the parent layer (upper left corner of the printable area). (Inherited from HostLayer)
	_cachedLayerSize	The absolute size of the layer in points (1/72 inch). (Inherited from HostLayer)
	_cachedParentLayerSize	The cached size of the parent layer. If this here is the root layer, and hence no parent layer exist, the cached size is set to 100 x 100 mm². (Inherited from HostLayer)
	_childLayers	The child layers of this layers (this is a partial view of the _graphObjects collection). (Inherited from HostLayer)
	_coordinateSystem
	_dataClipping	If true, the data are clipped to the frame.
	_graphObjects	(Inherited from HostLayer)
	_gridPlanes
	_location	(Inherited from HostLayer)
	_parent	The parent object this instance belongs to. (Inherited from SuspendableDocumentNodeBase)
	_plotItems
	_suspendTokensOfChilds	Stores the suspend tokens of the suspended childs of this object. (Inherited from SuspendableDocumentNode)
	_transformation	(Inherited from HostLayer)
	AxisLabelMajorStyleEditorMethod
	AxisLabelMinorStyleEditorMethod
	AxisScaleEditorMethod
	AxisStyleEditorMethod
	PlotItemEditorMethod

Top

Extension Methods

	Name	Description
	ArrangeLayers	Arranges the layers according to the provided options. (Defined by GraphDocumentLayerArrangement)

Top

Reference

Altaxo.Graph.Gdi Namespace