Click or drag to resize

XYPlotLayer Methods

The XYPlotLayer type exposes the following members.

Methods
 NameDescription
Protected methodAccumulateChangeData
(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
Protected methodAccumulatedChangeData_SetBackAfterResumeAndSuspend
(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
Protected methodAccumulatedEventData_Clear Clears the accumulated event data.
(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
Protected methodAccumulatedEventData_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)
Protected methodCalculateCachedSizeAndPosition 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)
Protected methodCalculateMatrix
(Inherited from HostLayer)
Public methodCanCreateGridForLocation 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)
Protected methodChildCloneFromT 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)
Protected methodChildCloneToMemberT 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)
Protected methodChildCloneToMemberAltT 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)
Protected methodChildCopyToMemberT 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)
Protected methodChildCopyToMemberOrCreateNewT 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)
Protected methodChildDisposeMemberT 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)
Protected methodChildSetMemberT 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)
Protected methodChildSetMemberAltT 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)
Public methodClearLegends Clears all legends from this layer.
Public methodClone
(Overrides HostLayerClone)
Public methodCopyFrom(Object)
(Inherited from HostLayer)
Public methodCopyFrom(HostLayer, GraphCopyOptions)
(Inherited from HostLayer)
Public methodCountEvent 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)
Public methodCreateDefaultAxes This will create the default axes styles that are given by the coordinate system.
Public methodCreateDefaultGrid 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)
Public methodCreateGridForLocation 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)
Public methodCreateGridIfNullOrEmpty If the Grid is null, then create a grid that represents the boundaries of the child layers.
(Inherited from HostLayer)
Public methodCreateNewLayerLegend Creates a new legend, removing the old one.
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SuspendableDocumentNodeBase)
Protected methodDispose(Boolean)
(Overrides HostLayerDispose(Boolean))
Protected methodEhBoundaryChangedEventFromPlotItem 
Public methodEhChildChanged Used by childs of this object to inform us about a change in their state.
(Inherited from SuspendableDocumentNode)
Protected methodEhDeserializationFinished 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.
Public methodEhParentTunnelingEventHappened Is called by the parent when a tunneling event happened in the parent.
(Inherited from SuspendableDocumentNode)
Protected methodEhSelfChanged Called if some (simple) member or property of this instance itself has changed.
(Inherited from SuspendableDocumentNode)
Public methodEhSelfTunnelingEventHappened(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)
Public methodEhSelfTunnelingEventHappened(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)
Protected methodEhXBoundaryChangedEventFromPlotItem 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.
Protected methodEhYBoundaryChangedEventFromPlotItem 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.
Public methodEnumerateFromHereToLeaves Enumerates all document node including this node, its child nodes, its child-child nodes up to the leaf nodes.
(Inherited from SuspendableDocumentNode)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExecuteFromTopmostChildToRoot 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)
Protected methodFinalize Finalizes an instance of the SuspendableDocumentNodeBase class.
(Inherited from SuspendableDocumentNodeBase)
Public methodFixAndTestParentChildRelationShipOfLayers
(Inherited from HostLayer)
Public methodFixupInternalDataStructures Adjusts the internal data structures to ensure its validity.
(Overrides HostLayerFixupInternalDataStructures)
Protected methodForwardTransform
(Inherited from HostLayer)
Public methodGetChildObjectNamed retrieves the object with the name
C#
name
.
(Overrides SuspendableDocumentNodeGetChildObjectNamed(String))
Protected methodGetDocumentNodeChildrenWithName
(Overrides HostLayerGetDocumentNodeChildrenWithName)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLogical3D(AltaxoVariant, AltaxoVariant) 
Public methodGetLogical3D(I3DPhysicalVariantAccessor, Int32) 
Public methodGetNameOfChildObject Retrieves the name of the provided object.
(Overrides SuspendableDocumentNodeGetNameOfChildObject(IDocumentLeafNode))
Public methodGetScale 
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGraphToLayerCoordinates
(Inherited from HostLayer)
Protected methodHandleHighPriorityChildChangeCases
(Overrides HostLayerHandleHighPriorityChildChangeCases(Object, EventArgs))
Protected methodHandleLowPriorityChildChangeCases 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)
Public methodHitTest(HitTestPointData)
(Inherited from HostLayer)
Public methodHitTest(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)
Public methodHitTest(HitTestPointData, Boolean)
(Overrides HostLayerHitTest(HitTestPointData, Boolean))
Public methodHitTest(HitTestRectangularData, ListIHitTestObject) Collects all sub-objects of this layer that are selected by a rectangular selection area into a list.
(Inherited from HostLayer)
Protected methodInitializeXScaleDataBounds Initializes the x scale data bounds, for instance if the scale instance has changed or was deserialized.
Protected methodInitializeYScaleDataBounds Initializes the y scale data bounds, for instance if the scale instance has changed or was deserialized.
Protected methodInternalCopyFrom 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))
Protected methodInternalCopyGraphItems(HostLayer, GraphCopyOptions)
(Overrides HostLayerInternalCopyGraphItems(HostLayer, GraphCopyOptions))
Protected methodInternalCopyGraphItems(HostLayer, GraphCopyOptions, FuncIGraphicBase, Boolean)
(Inherited from HostLayer)
Public methodIsCompatibleWithParent
(Inherited from HostLayer)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodNotifyChildrenTunnelingEventHappened Notifies the child nodes of this instance that a tunneling event has happened.
(Inherited from SuspendableDocumentNode)
Protected methodOnAboutToBeResumed 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)
Protected methodOnCachedResultingPositionChanged 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)
Protected methodOnCachedResultingSizeChanged
(Overrides HostLayerOnCachedResultingSizeChanged)
Protected methodOnChanged
(Overrides SuspendableDocumentNodeBaseOnChanged(EventArgs))
Protected methodOnCoordinateSystemChanged 
Protected methodOnGraphObjectsCollectionInstanceInitialized
(Overrides HostLayerOnGraphObjectsCollectionInstanceInitialized)
Protected methodOnLayerNumberChanged Is called by the parent layer if the index of this layer has changed.
(Inherited from HostLayer)
Protected methodOnResume 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)
Protected methodOnResumeSilently 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)
Protected methodOnSuspended Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended.
(Inherited from SuspendableDocumentNode)
Protected methodOnTunnelingEvent Fires the TunneledEvent event.
(Inherited from SuspendableDocumentNodeBase)
Public methodOnUserRescaledAxes Called when the user pressed the rescale button.
Public methodPaint
(Inherited from HostLayer)
Protected methodPaintInternal
(Overrides HostLayerPaintInternal(Graphics, IPaintContext))
Public methodPaintPostprocessing This function is called when painting is finished. Can be used to release the resources not neccessary any more.
(Overrides HostLayerPaintPostprocessing)
Public methodPaintPreprocessing
(Overrides HostLayerPaintPreprocessing(IPaintContext))
Public methodPrependTransformationTo Appends the transformation matrix of this instance to the matrix given in matrix.
(Inherited from HostLayer)
Public methodRemove
(Overrides HostLayerRemove(GraphicBase))
Public methodResume(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)
Public methodResume(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)
Public methodResumeCompleteTemporarily 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)
Public methodResumeCompleteTemporarilyGetToken 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)
Public methodResumeSilently 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)
Public methodSetDisposeInProgress Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from SuspendableDocumentNode)
Protected methodSetMemberAndRaiseSelfChangedT(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)
Protected methodSetMemberAndRaiseSelfChangedT(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)
Protected methodSetMemberEnumAndRaiseSelfChangedT 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)
Public methodSetParentSize
(Inherited from HostLayer)
Public methodSetPositionSize
(Inherited from HostLayer)
Public methodSizeToDefault Set this layer to the default size and position.
(Inherited from HostLayer)
Public methodSuspendGetToken Suspend will increase the SuspendLevel.
(Inherited from SuspendableDocumentNode)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTransformationFromRootToHere
(Inherited from HostLayer)
Public methodTransformCoordinateDifferencesFromParentToHere Converts X,Y differences in page units to X,Y differences in layer units
(Inherited from HostLayer)
Public methodTransformCoordinatesFromHereToParent(GraphicsPath) Transforms a graphics path from layer coordinates to graph (page) coordinates
(Inherited from HostLayer)
Public methodTransformCoordinatesFromHereToParent(PointD2D) Transforms a PointD2D from layer coordinates to graph (=printable area) coordinates
(Inherited from HostLayer)
Public methodTransformCoordinatesFromHereToRoot
(Inherited from HostLayer)
Public methodTransformCoordinatesFromParentToHere(Graphics) This switches the graphics context from printable area coordinates to layer coordinates.
(Inherited from HostLayer)
Public methodTransformCoordinatesFromParentToHere(PointD2D)
(Inherited from HostLayer)
Public methodTransformCoordinatesFromRootToHere
(Inherited from HostLayer)
Public methodTryGetName Test if this item already has a name.
(Inherited from SuspendableDocumentNodeBase)
Public methodUpdateCSPlaneID Updates the logical value of a plane id in case it uses a physical value.
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.
(Overrides HostLayerVisitDocumentReferences(DocNodeProxyReporter))
Top
Extension Methods
 NameDescription
Public Extension MethodArrangeLayers Arranges the layers according to the provided options.
(Defined by GraphDocumentLayerArrangement)
Top
See Also