Click or drag to resize

LightningChart Methods

LightningChart .NET Help

The LightningChart type exposes the following members.

Methods
  NameDescription
Public methodAddHandler(RoutedEvent, Delegate)
Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element.
(Inherited from UIElement.)
Public methodAddHandler(RoutedEvent, Delegate, Boolean)
Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route.
(Inherited from UIElement.)
Public methodAddToEventRoute
Adds handlers to the specified EventRoute for the current UIElement event handler collection.
(Inherited from UIElement.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)
Applies an animation to a specified dependency property on this element. Any existing animations are stopped and replaced with the new animation.
(Inherited from UIElement.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)
Applies an animation to a specified dependency property on this element, with the ability to specify what happens if the property already has a running animation.
(Inherited from UIElement.)
Public methodApplyTemplate
Builds the current template's visual tree if necessary, and returns a value that indicates whether the visual tree was rebuilt by this call.
(Inherited from FrameworkElement.)
Public methodArrange
Positions child elements and determines a size for a UIElement. Parent elements call this method from their ArrangeCore(Rect) implementation (or a WPF framework-level equivalent) to form a recursive layout update. This method constitutes the second pass of a layout update.
(Inherited from UIElement.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline)
Starts an animation for a specified animated property on this element.
(Inherited from UIElement.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)
Starts a specific animation for a specified animated property on this element, with the option of specifying what happens if the property already has a running animation.
(Inherited from UIElement.)
Public methodBeginInit
Starts the initialization process for this element.
(Inherited from FrameworkElement.)
Public methodBeginStoryboard(Storyboard)
Begins the sequence of actions that are contained in the provided storyboard.
(Inherited from FrameworkElement.)
Public methodBeginStoryboard(Storyboard, HandoffBehavior)
Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated.
(Inherited from FrameworkElement.)
Public methodBeginStoryboard(Storyboard, HandoffBehavior, Boolean)
Begins the sequence of actions contained in the provided storyboard, with specified state for control of the animation after it is started.
(Inherited from FrameworkElement.)
Public methodBeginUpdate
Begin update. Disables control repaints when a property is changed. Handy when updating status of many properties or updating series points.
Public methodBringIntoView
Attempts to bring this element into view, within any scrollable regions it is contained within.
(Inherited from FrameworkElement.)
Public methodBringIntoView(Rect)
Attempts to bring the provided region size of this element into view, within any scrollable regions it is contained within.
(Inherited from FrameworkElement.)
Public methodCalculatePixelAlignmentOffset
Alignment offset in pixels (Not in DIP).
Public methodCaptureMouse
Attempts to force capture of the mouse to this element.
(Inherited from UIElement.)
Public methodCaptureStylus
Attempts to force capture of the stylus to this element.
(Inherited from UIElement.)
Public methodCaptureToBitmap
Get chart as bitmap.
Public methodCaptureToByteArray
Get the last frame rendered by the chart as byte array containing just pixel data four bytes per pixel.

To get the image data with headers, like in bpm or png format, use SaveToStream method

Public methodCaptureTouch
Attempts to force capture of a touch to this element.
(Inherited from UIElement.)
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodCopyToClipboard
Copy the chart to clipboard bitmap image.
Public methodCopyToClipboard(ClipboardImageFormat)
Copy the chart to clipboard image by given format.
Public methodCopyToClipboard(ClipboardImageFormat, BitmapAntialiasOptions)
Copy the chart to clipboard image.
Public methodCopyToClipboard(Int32, Int32)
Copy the chart to clipboard bitmap image.
Public methodCopyToClipboard(ClipboardImageFormat, Int32, Int32, Boolean)
Copy the chart to clipboard image by given format.
Public methodCopyToClipboard(ClipboardImageFormat, BitmapAntialiasOptions, Int32, Int32, Boolean)
Copy the chart to clipboard image.
Public methodCopyToClipboardAsEmf
Copy chart to clipboard as emf.
Public methodDispose
Clean up any resources being used.
Public methodEnableObjectTreeTimer
Enables/disables internal timer which keeps control of the object tree when the chart is being manipulated by property grid, like in Visual Studio forms designer.
Public methodEndInit
Indicates that the initialization process for the element is complete.
(Inherited from FrameworkElement.)
Public methodEndUpdate
End update. Enables control repainting, and refreshes the control.
Public methodStatic memberEngineInitResultsToString
Used to convert GetLastEngineInitResults to string to help reporting of it's contents.
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFindCommonVisualAncestor
Returns the common ancestor of two visual objects.
(Inherited from Visual.)
Public methodFindName
Finds an element that has the provided identifier name.
(Inherited from FrameworkElement.)
Public methodFindResource
Searches for a resource with the specified key, and throws an exception if the requested resource is not found.
(Inherited from FrameworkElement.)
Public methodFocus
Attempts to set focus to this element.
(Inherited from UIElement.)
Public methodFullRepaint
Destroy all buffered draw data and repaint the chart This is slower than Refresh(), but thorough.
Public methodGetActiveUserInteractiveDeviceOverObject
Get the chart object that is activated by mouse. Note that this information is not correct if we do not have proper device set.
Public methodGetAnimationBaseValue
Returns the base property value for the specified property on this element, disregarding any possible animated value from a running or stopped animation.
(Inherited from UIElement.)
Public methodGetBeginUpdateCount
Get effectively used BeginUpdate/EndUpdate counter. Use for debugging, if seems that chart does not render.

The value must be 0 in order for the chart to render. If value is larger, some BeginUpdate call has not been closed by matching EndUpdate call.

This indicates total value. Use GetBeginUpdateCountPublic to see difference of public - user called - BeginUpdate / EndUpdate methods.

Public methodGetBeginUpdateCountPublic
Get public BeginUpdate/EndUpdate counter. Use for debugging, if seems that chart does not render. Must be zero after EndUpdate(), if one wants chart to render.
Public methodGetBindingExpression
Returns the BindingExpression that represents the binding on the specified property.
(Inherited from FrameworkElement.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLastEngineInitResults
returns a list of EngineInitResult objects of which each defines a tried engine, if its initialization was successful or not and the reasons why its initialization failed.

This method is intended for debugging purposes.

The information applies to the last time the engine was tried to be initialized. The list is recreated each time engine initialization is tried and the old information is lost.

Public methodGetLastOutputStreamFormat
Getter of the pixel format of the last written data to the OutputStream.
Public methodGetLastOutputStreamSize
Getter of the image size of the last image written to OutputStream as pixels (not DIP's).
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetParentWindow
Get parent window handle (HWND). Needed when using the control from other systems than .NET.
Public methodGetRenderDeviceInfo
Get render device information. Gives information about your graphics adapter. Tells if there is something that prevents the control to run at optimal performance.
Public methodGetThemeAuroras
Get Predefined theme Auroras
Public methodGetThemeBrushedMetal
Get Predefined theme Brushed metal
Public methodGetThemeMagma
Get predefined theme magma.
Public methodGetThemePaper
Get Predefined theme Paper
Public methodGetThemeRedCarbon
Get Predefined theme Red carbon
Public methodGetThemeTurquoiseHexagon
Get predefined theme TurgouiseHexagon.
Public methodGetThemeWorldCyberSpace
Get Predefined theme Wolrd cyber space
Public methodStatic memberGetTotalChartCount
Gets total count of chart instances in application context.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodGetVersion
Version and revision.
Public methodHighqualityFontConflictCheck
Checks if high quality font and transparency background is used with DX11 and gives warning of this conflict combination.
Public methodInitializeRenderingDevice
Tries to force the engine initialization in a synchronous fashion. Should have no use in WinForms. This method allows user to force the rendering device initialization. Note! Do not force during chart events callbacks, except at AfterRendering event! Causes chart to malfunction, if engine is changed during event handler.
Public methodInputHitTest
Returns the input element within the current element that is at the specified coordinates, relative to the current element's origin.
(Inherited from UIElement.)
Public methodInvalidateArrange
Invalidates the arrange state (layout) for the element. After the invalidation, the element will have its layout updated, which will occur asynchronously unless subsequently forced by UpdateLayout.
(Inherited from UIElement.)
Public methodInvalidateMeasure
Invalidates the measurement state (layout) for the element.
(Inherited from UIElement.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodInvalidateVisual
Invalidates the rendering of the element, and forces a complete new layout pass. OnRender(DrawingContext) is called after the layout cycle is completed.
(Inherited from UIElement.)
Public methodStatic memberInvert
Opposite color
Public methodIsAncestorOf
Determines whether the visual object is an ancestor of the descendant visual object.
(Inherited from Visual.)
Public methodIsDescendantOf
Determines whether the visual object is a descendant of the ancestor visual object.
(Inherited from Visual.)
Public methodStatic memberIsHardwareRenderingSupported
Check if hardware rendering is supported.
Public methodStatic memberIsHardwareRenderingSupported(Boolean, Boolean, DeviceTypeFlags)
Check if hardware rendering is supported.
Public methodIsPixelAlignmentOK
Check pixel alignment. This is quite costly operation. It's faster just to update the value.
Public methodIsPositionOver
Finds out if the given coordinate is over the chart control with pixels.
Public methodIsUsingHardwareRendering
Check if chart is using hardware rendering.
Public methodMeasure
Updates the DesiredSize of a UIElement. Parent elements call this method from their own MeasureCore(Size) implementations to form a recursive layout update. Calling this method constitutes the first pass (the "Measure" pass) of a layout update.
(Inherited from UIElement.)
Public methodMeasureText
Measure text with given font [in DIP units]
Public methodMoveFocus
Moves the keyboard focus away from this element and to another element in a provided traversal direction.
(Inherited from FrameworkElement.)
Public methodOnApplyTemplate
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.
(Inherited from FrameworkElement.)
Public methodPixelAlignmentOffset
Getter of the currently used pixel alignment offset. Call UpdatePixelAlignment to update / recalculate this value.
Public methodPointFromScreen
Converts a Point in screen coordinates into a Point that represents the current coordinate system of the Visual.
(Inherited from Visual.)
Public methodPointToScreen
Converts a Point that represents the current coordinate system of the Visual into a Point in screen coordinates.
(Inherited from Visual.)
Public methodPredictFocus
Determines the next element that would receive focus relative to this element for a provided focus movement direction, but does not actually move the focus.
(Inherited from FrameworkElement.)
Public methodPrint
Print chart to default printer with default settings using raster output. No header nor footer.
Public methodPrint(ImageType, Boolean, Boolean, Boolean, String, String, Boolean, Thickness)
Print chart to default printer with given settings.
Public methodPrintPreview
Print preview of chart.
Public methodPrintPreview(String, String, Boolean)
Print preview of chart.
Public methodPrintWithPageSetup
Show page setup dialog and print if ok clicked and allowed.
Public methodPrintWithPrinterSelection
Show printer selection dialog and print if allowed.
Public methodRaiseEvent
Raises a specific routed event. The RoutedEvent to be raised is identified within the RoutedEventArgs instance that is provided (as the RoutedEvent property of that event data).
(Inherited from UIElement.)
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRegisterName
Provides an accessor that simplifies access to the NameScope registration method.
(Inherited from FrameworkElement.)
Public methodReleaseAllTouchCaptures
Releases all captured touch devices from this element.
(Inherited from UIElement.)
Public methodReleaseMouseCapture
Releases the mouse capture, if this element held the capture.
(Inherited from UIElement.)
Public methodReleaseStylusCapture
Releases the stylus device capture, if this element held the capture.
(Inherited from UIElement.)
Public methodReleaseTouchCapture
Attempts to release the specified touch device from this element.
(Inherited from UIElement.)
Public methodRemoveHandler
Removes the specified routed event handler from this element.
(Inherited from UIElement.)
Public methodResetBeginUpdateCount
Reset BeginUpdate/EndUpdate counter. Usually not required to call.
Public methodResetPageSettings
Reset page settings.
Public methodRTK
Read Trader Key
Public methodSaveToFile(String)
Save the chart into a image file with no extra anti-aliasing applied.
Public methodSaveToFile(String, BitmapAntialiasOptions)
Save the chart into a image file by using given anti-aliasing options.
Public methodSaveToFile(String, Int32, Int32, Boolean)
Save to file as given size.
Public methodSaveToFile(String, BitmapAntialiasOptions, Int32, Int32, Boolean)
Save the chart into a image file by using given anti-aliasing options.
Public methodSaveToStream(Stream)
Save the chart into stream in bitmap format.
Public methodSaveToStream(Stream, TargetImageFormat)
Save the chart into stream in given format and anti-aliasing options.
Public methodSaveToStream(Stream, TargetImageFormat, BitmapAntialiasOptions)
Save the chart into stream in given format and anti-aliasing options.

Note that the stream's position is at the end. In order to read it to some other variable, rewind it first using seek.

Public methodSaveToStream(Stream, Int32, Int32)
Save the chart into stream in given size.
Public methodSaveToStream(Stream, TargetImageFormat, Int32, Int32, Boolean)
Save the chart into stream in given format and anti-aliasing options.
Public methodSaveToStream(Stream, TargetImageFormat, BitmapAntialiasOptions, Int32, Int32, Boolean)
Save the chart into stream in given format and anti-aliasing options.
Public methodSetBinding(DependencyProperty, String)
Attaches a binding to this element, based on the provided source property name as a path qualification to the data source.
(Inherited from FrameworkElement.)
Public methodSetBinding(DependencyProperty, BindingBase)
Attaches a binding to this element, based on the provided binding object.
(Inherited from FrameworkElement.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodStatic memberSetDeploymentKey
Set Deployment Key
Public methodSetParentWindow
Set parent window handle (HWND). Needed when using the control from other systems than .NET. Parent window handle.
Public methodSetResourceReference
Searches for a resource with the specified name and sets up a resource reference to it for the specified property.
(Inherited from FrameworkElement.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Public methodToString
Convert class description to string
(Overrides ControlToString.)
Public methodTransformToAncestor(Visual)
Returns a transform that can be used to transform coordinates from the Visual to the specified Visual ancestor of the visual object.
(Inherited from Visual.)
Public methodTransformToAncestor(Visual3D)
Returns a transform that can be used to transform coordinates from the Visual to the specified Visual3D ancestor of the visual object.
(Inherited from Visual.)
Public methodTransformToDescendant
Returns a transform that can be used to transform coordinates from the Visual to the specified visual object descendant.
(Inherited from Visual.)
Public methodTransformToVisual
Returns a transform that can be used to transform coordinates from the Visual to the specified visual object.
(Inherited from Visual.)
Public methodTranslatePoint
Translates a point relative to this element to coordinates that are relative to the specified element.
(Inherited from UIElement.)
Public methodTryFindResource
Searches for a resource with the specified key, and returns that resource if found.
(Inherited from FrameworkElement.)
Public methodTweakDisablePresent
Disable DirectX present calls, but let the rendering routines run otherwise
Public methodTweakEnablePresent
Enable DirectX present calls again
Public methodUnregisterName
Simplifies access to the NameScope de-registration method.
(Inherited from FrameworkElement.)
Public methodUpdateCustomTheme
Update custom themes.
Public methodUpdateDefaultStyle
Reapplies the default style to the current FrameworkElement.
(Inherited from FrameworkElement.)
Public methodUpdateLayout
Ensures that all visual child elements of this element are properly updated for layout.
(Inherited from UIElement.)
Public methodUpdatePixelAlignment
Forces update of WPF pixel alignment. Calling this should not be required normally.
Top
Extension Methods
  NameDescription
Public Extension MethodGatherApplicationInformation
Gathers various information from the current chart for debugging purposes as a string by calling GatherApplicationInformation(ChartToolsGatherDataOptions, LightningChart, String, String) Optionally saves the output to a text file if file path and file name are specified. Gathered data (if ChartToolsGatherDataOptions is set to All): system information, chart information, list of running processes, DxDiag output, installed Windows hotfixes.
(Defined by ExtensionsClass.)
Top
See Also