Plot |
The PlotItemCollection type exposes the following members.
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) |
 | Add(IGPlotItem) | |
| Add(IPlotGroupStyle) | Add the PlotGroupStyle. |
| AddRange | |
| ApplyGroupStyles | |
| ApplyGroupStylesForward_HierarchyUpOnly | Apply plot group styles forward, from the first to the last item. The function is called recursively for child PlotItemCollections, but only up in the hierarchy. This function therefore has no influence on items down in hierarchie, i.e. parental PlotItemCollections. |
| ApplyStylesBackward_HierarchyUpOnly | Apply styles backward from the last item to the first, but only upwards in the hierarchy. |
| ApplyStylesIterativeBackward | Apply styles, beginning at item 'pivotidx' in this collection, iterative backwards up and down the hierarchy. It stops at the first item of a collection here or down the hierarchy that do not inherit from it's parent collection. |
| 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) |
| ClearPlotItems | |
| ClearPlotItemsAndGroupStyles | |
| Clone | |
| CollectStyles | Collects all possible group styles that can be applied to this plot item in styles. |
| CopyFrom(Object) | |
| CopyFrom(PlotItemCollection, GraphCopyOptions) | |
| 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) |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SuspendableDocumentNodeBase) |
| Dispose(Boolean) | (Overrides SuspendableDocumentNodeDispose(Boolean)) |
| DistributeChanges | Distribute the changes made to the plotitem 'pivotitem' to all other items in the collection and if neccessary, also up and down the plot item tree. |
| DistributePlotStyleFromTemplate | Sets the plot style (or sub plot styles) of all plot items in this collection according to a template provided by the plot item in the template argument. |
| EhChildChanged |
Used by childs of this object to inform us about a change in their state.
(Inherited from SuspendableDocumentNode) |
| EhHitTestObject_Remove | Handles the remove of a plot item. |
| EhParentTunnelingEventHappened |
Is called by the parent when a tunneling event happened in the parent.
(Inherited from SuspendableDocumentNode) |
| EhPlotGroups_Changed | |
| 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) |
| 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) |
| FillPlotItemList | This method must be called, if plot item members are added or removed to this collection. |
| Finalize |
Finalizes an instance of the SuspendableDocumentNodeBase class.
(Inherited from SuspendableDocumentNodeBase) |
| GetChildObjectNamed |
retrieves the object with the name C# name (Overrides SuspendableDocumentNodeGetChildObjectNamed(String)) |
| GetDocumentNodeChildrenWithName | (Overrides SuspendableDocumentNodeGetDocumentNodeChildrenWithName) |
| GetEnumerator | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetName(Int32) | |
| GetName(String) | |
| GetNameOfChildObject |
Retrieves the name of the provided object.
(Overrides SuspendableDocumentNodeGetNameOfChildObject(IDocumentLeafNode)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HandleHighPriorityChildChangeCases | (Overrides SuspendableDocumentNodeHandleHighPriorityChildChangeCases(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 | |
| IndexOf | |
| ListPossiblePlotGroupStyles | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MergeXBoundsInto | |
| MergeYBoundsInto | |
| 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) |
| OnChanged |
Fires the change event with the EventArgs provided in the argument.
(Inherited from SuspendableDocumentNodeBase) |
| OnCollectionChanged | |
| OnDeserialization | Finale measures after deserialization. |
| 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) |
| Paint | |
| PaintChild | |
| PaintPostprocessing | Called after painting has finished. Can be used to release resources. |
| PaintPreprocessing | |
| PaintSymbol | Paints a symbol for this plot item for use in a legend. |
| PrepareGroupStyles | |
| PrepareGroupStylesForward_HierarchyUpOnly | Prepare group styles forward, from the first to the last item. The function is called recursively for child PlotItemCollections, but only up in the hierarchy. This function therefore has no influence on items down in hierarchie, i.e. parental PlotItemCollections. |
| PrepareScales | |
| PrepareStylesBackward_HierarchyUpOnly | Apply styles backward from the last item to the first, but only upwards in the hierarchy. |
| PrepareStylesIterativeBackward | Prepare styles, beginning at item 'pivotidx' in this collection, iterative backwards up and down the hierarchy. It stops at the first item of a collection here or down the hierarchy that do not inherit from it's parent collection. |
| Remove | Removes an plot item from the list. |
| Replace | Replaces one plot item, which must be part of this collection, by another plot item. |
| 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) |
| SetPlotStyleFromTemplate | Does nothing because a plot item collection doesn't distibute item styles from members of the outer group into it's own members. |
| SuspendGetToken |
Suspend will increase the SuspendLevel.
(Inherited from SuspendableDocumentNode) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetName |
Test if this item already has a name.
(Inherited from SuspendableDocumentNodeBase) |
| 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. |
Extension Methods| Name | Description | |
|---|---|---|
 | AreAllNodesFromSameLevelIGPlotItem |
Determines whether all nodes in the provided enumeration have the same level (see LevelT(T) for an explanation of level).
(Defined by TreeNodeExtensions) |
| FirstOrIGPlotItem |
Returns the first value of the enumeration, or, if the enumeration is empty, the other value provided in the arguments.
(Defined by EnumerableExtensions) |
| FlattenFromRootToLeavesIGPlotItem |
Converts a recursive data structure into a flat list. The root element is enumerated before its corresponding child element(s).
(Defined by EnumerableExtensions) |
| ForEachDoIGPlotItem |
Executes an action for each element of the sequence.
(Defined by EnumerableExtensions) |
| GetPropertyContext |
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) |
| HasSingleElementIGPlotItem |
Determines whether the specified enumeration has exactly one element.
(Defined by EnumerableExtensions) |
| IndexOfIGPlotItem |
Gets the index of an item in a enumeration or list.
(Defined by ListExtensions) |
| IndexOfFirstIGPlotItem |
Gets the index the of first item in list that fulfills the predicate predicate (Defined by ListExtensions) |
| IndexOfFirstIGPlotItem |
Gets the index the of first item in list that fulfills the predicate predicate (Defined by ListExtensions) |
| IndexOfMaxIGPlotItem | Return the index of the element with the maximum value in an enumerable.
If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned. (Defined by EnumerableExtensions) |
| IndexOfMinIGPlotItem | Return the index of the element with the minimum value in an enumerable.
If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned. (Defined by EnumerableExtensions) |
| IndicesInt32AndValuesWhereIGPlotItem |
Returns tuples of index and element of all elements in an enumeration which fullfill a given condition, given by the element's value.
(Defined by EnumerableExtensions) |
| IndicesInt32AndValuesWhereIGPlotItem |
Returns tuples of index and element of all elements in an enumeration which fullfill a given condition, given by the element's value and its index.
(Defined by EnumerableExtensions) |
| IndicesInt32WhereIGPlotItem |
Returns the indices of the elements which fullfill a given condition, given by the element's value.
(Defined by EnumerableExtensions) |
| IndicesInt32WhereIGPlotItem |
Returns the indices of the elements which fullfill a given condition, given by the element's value and its index.
(Defined by EnumerableExtensions) |
| IndicesOfMinMaxIGPlotItem | Return the index of the element with the minimum value in an enumerable.
If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned. (Defined by EnumerableExtensions) |
| IsEmptyIGPlotItem |
Determines whether the specified enumeration is empty.
(Defined by EnumerableExtensions) |
| JoinConditionalIGPlotItem, T2 |
Takes a join of two sequences, but only takes into account those pair, which fulfill a given condition.
(Defined by EnumerableExtensions) |
| JoinConditionalIGPlotItem, T2, TResult |
Takes a join of two sequences, but only takes into account those pair, which fulfill a given condition.
(Defined by EnumerableExtensions) |
| LastOrIGPlotItem |
Returns the last value of the enumeration, or, if the enumeration is empty, the other value provided in the arguments.
(Defined by EnumerableExtensions) |
| MaxElementIGPlotItem, M |
Gets the element of a IEnumerabe that evaluates by means of a conversion function to the maximal value.
This is different from Select(x => conversion(x)).Max() insofar as it not returns the maximum value, but the original element x which converts to the maximum value.
(Defined by EnumerableExtensions) |
| MaxOrDefaultIGPlotItem, M |
Evaluates the maximum of a enumeration of elements, or returns a default value if the series is empty.
(Defined by EnumerableExtensions) |
| SelectCombinationIGPlotItem |
Select a random combination, without repetition, from a data sequence by selecting k elements in original order.
(Defined by Combinatorics) |
| SelectCombinationWithRepetitionIGPlotItem |
Select a random combination, with repetition, from a data sequence by selecting k elements in original order.
(Defined by Combinatorics) |
| SelectPermutationIGPlotItem |
Select a random permutation from a data sequence by returning the provided data in random order.
Implemented using Fisher-Yates Shuffling.
(Defined by Combinatorics) |
| SelectVariationIGPlotItem |
Select a random variation, without repetition, from a data sequence by randomly selecting k elements in random order.
Implemented using partial Fisher-Yates Shuffling.
(Defined by Combinatorics) |
| SelectVariationWithRepetitionIGPlotItem |
Select a random variation, with repetition, from a data sequence by randomly selecting k elements in random order.
(Defined by Combinatorics) |
| TakeAllButLastIGPlotItem |
Takes all elements of the enumeration except the last element.
(Defined by EnumerableExtensions) |
| ThisOrEmptyIGPlotItem |
Returns either the provided enumeration, or if it is null, an empty enumeration.
(Defined by EnumerableExtensions) |
| TryGetFirstAndLastIGPlotItem |
Returns true and the first and last value of the enumeration, or, if the enumeration is empty, returns false.
(Defined by EnumerableExtensions) |
| TryGetSingleElementIGPlotItem |
Try to get the one and only element of the collection.
(Defined by EnumerableExtensions) |
See Also