### Get StrideX Property Value (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Data~SciChart.Data.Model.IVertexBuffer~StrideX Retrieves the StrideX property from the IVertexBuffer interface in C#. This property indicates the stride (in bytes) between the start of one vertex and the start of the next in the vertex buffer. It is a read-only property. ```csharp int StrideX {get;} ``` -------------------------------- ### Initialization and Resource Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.ChartModifiers.VerticalSliceModifierBase_members Documentation for methods related to element initialization and resource management. ```APIDOC ## Initialization and Resource Methods ### Description This section covers methods related to the initialization lifecycle of UI elements and how to find resources within the framework. ### Method Various (Methods listed below) ### Endpoint N/A (These are class methods, not REST endpoints) ### Parameters N/A (These are methods within a class) ### Request Example N/A ### Response N/A **Methods:** - **EndInit**: Indicates that the initialization process for the element is complete (Inherited from System.Windows.FrameworkElement) - **FindCommonVisualAncestor**: Returns the common ancestor of two visual objects (Inherited from System.Windows.Media.Visual) - **FindName**: Finds an element by its name (Inherited from System.Windows.FrameworkElement) - **FindResource**: Searches for a resource with the specified key (Inherited from System.Windows.FrameworkElement) ``` -------------------------------- ### Install SciChart Package using Package Manager Console Source: https://www.scichart.com/documentation/win/current/Getting_Nightly_Builds_with_NuGet Installs the SciChart package from a specified NuGet source using the Package Manager Console in Visual Studio. This command fetches the latest version of SciChart available from the provided feed URL. ```powershell Install-Package SciChart –Source https://www.myget.org/F/abtsoftware-bleeding-edge/api/v3/index.json ``` -------------------------------- ### Initialization and Focus Event Handling Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.RadarLegendPlaceHolder_members Documentation for methods related to element initialization and keyboard/mouse focus changes. ```APIDOC ## OnInitialized ### Description Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsKeyboardFocusedChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsKeyboardFocusedChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsKeyboardFocusWithinChanged ### Description Invoked just before the System.Windows.UIElement.IsKeyboardFocusWithinChanged event is raised by this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsMouseCapturedChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsMouseCapturedChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsMouseCaptureWithinChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsMouseCaptureWithinChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsMouseDirectlyOverChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsMouseDirectlyOverChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsStylusCapturedChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsStylusCapturedChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsStylusCaptureWithinChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsStylusCaptureWithinChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnIsStylusDirectlyOverChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsStylusDirectlyOverChanged event is raised on this element. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnLostFocus ### Description Raises the System.Windows.UIElement.LostFocus routed event by using the event data that is provided. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ## OnLostKeyboardFocus ### Description Invoked when an unhandled System.Windows.Input.Keyboard.LostKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. ### Method *This is a class method, not an endpoint.* ### Endpoint *N/A* ### Parameters *None specified.* ### Request Example *N/A* ### Response *N/A* ``` -------------------------------- ### Get and Set XStart Property in C# Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Model.DataSeries.UniformXyDataSeries%601~XStart This C# code snippet demonstrates how to get and set the XStart property for a UniformXyDataSeries object. This property defines the starting X-coordinate for the data series. No specific dependencies are mentioned beyond the SciChart.Charting assembly. ```csharp public double XStart {get; set;} ``` -------------------------------- ### Initialization and DPI Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.HistogramBar_members Documentation for methods related to element initialization and DPI changes. ```APIDOC ## OnInitialized ### Description Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. (Inherited from System.Windows.FrameworkElement) ### Method Not Applicable (Method signature not provided) ### Endpoint Not Applicable ### Parameters None ### Request Example None ### Response None ## OnDpiChanged ### Description Called when the DPI at which this View is rendered changes. (Inherited from System.Windows.Media.Visual) ### Method Not Applicable (Method signature not provided) ### Endpoint Not Applicable ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### ITickProvider Interface - Init Method Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Numerics.TickProviders.ITickProvider~Init Provides documentation for the Init method within the ITickProvider interface, including its C# syntax and parameters. ```APIDOC ## Init Method (ITickProvider) ### Description Initializes the ITickProvider with the provided axis core. ### Method void ### Endpoint N/A (Interface Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp void Init( IAxisCore _axis_ ) ``` ### Response #### Success Response (void) This method does not return a value. #### Response Example None ``` -------------------------------- ### Get XStart Property of IUniformHeatmapDataSeries Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IUniformHeatmapDataSeries~XStart Retrieves the starting X-coordinate value for a uniform heatmap data series. This property is read-only and returns an IComparable type. ```csharp IComparable XStart {get;} ``` -------------------------------- ### Initialization and Surface Event Handler Source: https://www.scichart.com/documentation/win/current/SciChart.Charting.DrawingTools~SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineBase_members Documentation for initialization and surface-related events. ```APIDOC ## Initialization and Surface Event Handler ### Description Handles events related to the initialization of UI elements and surface updates. ### OnInitialized - **Description**: Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. - **Inherited from**: System.Windows.FrameworkElement ### OnInvalidateParentSurface - **Description**: (Inherited from SciChart.Charting.ChartModifiers.ApiElementBase) - **Inherited from**: SciChart.Charting.ChartModifiers.ApiElementBase ``` -------------------------------- ### AxisAngleOffset Property C# Example Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.ISciChartRadarSurface~AxisAngleOffset This code snippet demonstrates the syntax for the AxisAngleOffset property in C#. It indicates that this property is of type double and supports both getting and setting its value. No specific dependencies are mentioned beyond the SciChart.Charting assembly. ```csharp double AxisAngleOffset {get; set;} ``` -------------------------------- ### Enable Verbose Console Logging in SciChart Source: https://www.scichart.com/documentation/win/current/SciChart_2D_Troubleshooting This example shows how to enable detailed console logging for the SciChart rendering pipeline by implementing the ISciChartLoggerFacade interface and setting a custom logger. Use this for in-depth debugging, but be aware of potential performance impacts. ```csharp private class OutputWindowLogger : ISciChartLoggerFacade { public void Log(string formatString, params object[] args) { Debug.WriteLine(formatString, args); } } // To enable verbose console logging use this code // WARNING: This will come at a considerable performance cost SciChartDebugLogger.Instance.SetLogger(new OutputWindowLogger()); SciChartDebugLogger.Instance.WriteLine("Hellow World!"); ``` -------------------------------- ### Event Handling - Initialization and Focus Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Themes.TernaryAxisContainer_members This section details methods related to the initialization of UI elements and changes in focus states, including keyboard and mouse focus. ```APIDOC ## OnInitialized ### Description Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. ### Method Protected virtual ### Endpoint N/A (Method within a class) ## OnIsKeyboardFocusedChanged ### Description Invoked when an unhandled System.Windows.UIElement.IsKeyboardFocusedChanged event is raised on this element. Implement this method to add class handling for this event. ### Method Protected virtual ### Endpoint N/A (Method within a class) ## OnIsKeyboardFocusWithinChanged ### Description Invoked just before the System.Windows.UIElement.IsKeyboardFocusWithinChanged event is raised by this element. Implement this method to add class handling for this event. ### Method Protected virtual ### Endpoint N/A (Method within a class) ## OnLostFocus ### Description Raises the System.Windows.UIElement.LostFocus routed event by using the event data that is provided. ### Method Protected virtual ### Endpoint N/A (Method within a class) ## OnLostKeyboardFocus ### Description Invoked when an unhandled System.Windows.Input.Keyboard.LostKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. ### Method Protected virtual ### Endpoint N/A (Method within a class) ``` -------------------------------- ### Enable Chart Render Debugging in C# Source: https://www.scichart.com/documentation/win/current/SciChart_2D_Troubleshooting This C# code snippet demonstrates how to enable detailed debug output for chart rendering issues in SciChart. By setting the `DebugWhySciChartDoesntRender` property to `true`, developers can get insights into why a chart might not be drawing correctly. ```csharp var sciChartSurface = new SciChartSurface(); // Default is false. Turn debug output on here sciChartSurface.DebugWhySciChartDoesntRender = true; ``` -------------------------------- ### Initialization and Input Event Handlers Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.CursorLabelControl_members Methods for handling initialization events and keyboard input events. ```APIDOC ## Initialization and Input Event Handlers ### Description This section covers methods for handling the initialization state of an element and responding to keyboard input events. ### Endpoints - **OnInitialized** - **OnKeyDown** ### Details - **OnInitialized**: Called when the `IsInitialized` property is set to true, signaling that the element has been initialized. Inherited from `System.Windows.FrameworkElement`. - **OnKeyDown**: Invoked when an unhandled `Keyboard.KeyDown` event occurs. Allows for class handling of key press events. Inherited from `System.Windows.UIElement`. ### Request Example N/A (These are event handlers, not API endpoints with requests) ### Response Example N/A (These are event handlers, not API endpoints with responses) ``` -------------------------------- ### Initialization and Resource Management Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis_members Documentation for methods related to element initialization and resource handling. ```APIDOC ## Initialization and Resource Management ### Description This section covers methods for initializing elements and managing resources within the UI framework. ### Methods - **EndInit**: Indicates that the initialization process for the element is complete. - **FindResource**: Searches for a resource with the specified key, and throws an exception if the requested resource is not found. ### Inheritance These methods are inherited from `System.Windows.FrameworkElement`. ``` -------------------------------- ### Get/Set XStart Property in C# Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Model.DataSeries.IUniformXyDataSeries~XStart The XStart property represents the starting X-value for a uniform data series in SciChart. It is accessible for both getting and setting the value. This property is relevant for WPF charting applications targeting various Windows platforms. ```csharp double XStart {get; set;} ``` -------------------------------- ### Update SciChart Package using Package Manager Console Source: https://www.scichart.com/documentation/win/current/Getting_Nightly_Builds_with_NuGet Updates the SciChart package to the latest available version from a specified NuGet source using the Package Manager Console in Visual Studio. This ensures you have the most recent nightly build installed. ```powershell Update-Package SciChart –Source https://www.myget.org/F/abtsoftware-bleeding-edge/api/v3/index.json ``` -------------------------------- ### Initialization and Key Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries_members Handles initialization events and keyboard input events for UI elements. ```APIDOC ## Initialization and Key Events ### Description These methods manage the initialization process and handle keyboard input events for UI elements. ### Methods - **OnInitialized**: Raises the `Initialized` event when `IsInitialized` is set to true. - **OnKeyDown**: Handles the `KeyDown` event when a key is pressed. ### Inheritance These methods are inherited from `System.Windows.FrameworkElement` and `System.Windows.UIElement`. ``` -------------------------------- ### IPaletteProvider Interface Definition for SciChart WPF Source: https://www.scichart.com/documentation/win/current/RenderableSeries%20APIs%20-%20Paletted%20Serie The IPaletteProvider interface is a base interface for all palette providers in SciChart WPF. It defines the OnBeginSeriesDraw method, which is called at the start of a renderable series rendering operation. This method can be used for initialization or setup before drawing begins. ```csharp /// /// Defines the most common interface to a PaletteProvider. /// public interface IPaletteProvider { /// /// Called at the start of an renderable series rendering, before the /// current draw operation. /// /// void OnBeginSeriesDraw(IRenderableSeries series); } ``` -------------------------------- ### Initialization and Resource Management Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Annotations.CompositeAnnotationForMvvm_members Methods for managing the initialization process and accessing resources. ```APIDOC ## Initialization and Resource Management ### Description Methods for controlling the initialization lifecycle of elements and finding resources. ### Methods - **BeginInit** - **Description**: Starts the initialization process for this element. - **Inherited From**: System.Windows.FrameworkElement - **EndInit** - **Description**: Indicates that the initialization process for the element is complete. - **Inherited From**: System.Windows.FrameworkElement - **FindResource** - **Description**: Searches for a resource with the specified key, throwing an exception if not found. - **Inherited From**: System.Windows.FrameworkElement ### Request Example ```json { "method": "FindResource", "parameters": { "key": "MyStyle" } } ``` ### Response Example ```json { "status": "success", "resource": { "type": "Style", "name": "MyStyle" } } ``` ``` -------------------------------- ### Declare StackedMountainRenderableSeries in XAML Source: https://www.scichart.com/documentation/win/current/The%20Stacked%20Mountains%20Type Defines a SciChartSurface with two StackedMountainRenderableSeries in XAML. It includes resource definitions for LinearGradientBrushes used for series fills and configures basic NumericAxis for X and Y axes. This setup is suitable for visualizing stacked mountain data directly in the UI definition. ```xml ``` -------------------------------- ### Initialization and Utility Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Axes.PolarYAxisForMvvm_members Methods for initializing internal components and providing utility functions. ```APIDOC ## InitializeLabelsPool /api/websites/scichart_win_current ### Description Initializes the pool for tick labels. ### Method protected virtual void InitializeLabelsPool ### Endpoint /api/websites/scichart_win_current ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## InvalidateParentSurface /api/websites/scichart_win_current ### Description Invalidates the parent surface to trigger a redraw. ### Method protected virtual void InvalidateParentSurface ### Endpoint /api/websites/scichart_win_current ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## IsShown /api/websites/scichart_win_current ### Description Checks if the axis is currently shown. ### Method protected virtual bool IsShown ### Endpoint /api/websites/scichart_win_current ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Shown** (bool) - True if the axis is shown, false otherwise. #### Response Example ```json { "isShown": true } ``` ## IsValidForDrawing /api/websites/scichart_win_current ### Description Checks if the axis is valid for drawing. ### Method protected virtual bool IsValidForDrawing ### Endpoint /api/websites/scichart_win_current ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Valid** (bool) - True if the axis is valid for drawing, false otherwise. #### Response Example ```json { "isValid": true } ``` ``` -------------------------------- ### Initialization, Layout, and Loading Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.PointMarkers.CrossPointMarker_members Documentation for events related to element initialization, layout updates, and the loading process. ```APIDOC ## Initialization, Layout, and Loading Events ### Description This section covers events triggered during the element's lifecycle, including initialization, layout changes, and when the element is loaded and ready for use. ### Events * **Initialized** (Inherited from System.Windows.FrameworkElement) Occurs when this System.Windows.FrameworkElement is initialized. This event coincides with cases where the value of the System.Windows.FrameworkElement.IsInitialized property changes from **false** (or undefined) to **true**. * **IsEnabledChanged** (Inherited from System.Windows.UIElement) Occurs when the value of the System.Windows.UIElement.IsEnabled property on this element changes. * **IsHitTestVisibleChanged** (Inherited from System.Windows.UIElement) Occurs when the value of the System.Windows.UIElement.IsHitTestVisible dependency property changes on this element. * **LayoutUpdated** (Inherited from System.Windows.UIElement) Occurs when the layout of the various visual elements associated with the current System.Windows.Threading.Dispatcher changes. * **Loaded** (Inherited from System.Windows.FrameworkElement) Occurs when the element is laid out, rendered, and ready for interaction. ``` -------------------------------- ### C# PieSegment StartRotationAngle Property Syntax Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Shapes.PieSegment~StartRotationAngle This code snippet shows the C# syntax for the StartRotationAngle property of the PieSegment class. This property defines the starting rotation angle for a pie segment. It is a public double property with get and set accessors. ```csharp public double StartRotationAngle {get; set;} ``` -------------------------------- ### Get Peak Z Value for Heatmap - C# Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.IHeatmapPeakDetector~GetPeakZValue The GetPeakZValue method calculates the peak Z-value within a specified region of a heatmap. It requires parameters defining the start, step, and count for both X and Y axes, and returns the indices of the peak X and Y values. This method is part of the IHeatmapPeakDetector interface. ```csharp double GetPeakZValue( int _xStart_, int _xStep_, int _xCount_, int _yStart_, int _yStep_, int _yCount_, out int _peakXIndex_, out int _peakYIndex_ ) ``` -------------------------------- ### Initialization and Keyboard Event Handlers Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.TradeChart.SciChartGroupPane_members This section details event handlers for initialization and keyboard input events. ```APIDOC ## Initialization and Keyboard Event Handlers ### Description Provides class handling for initialization events and keyboard-related routed events. ### Events - **OnInitialized**: Raises the `System.Windows.FrameworkElement.Initialized` event. This method is invoked whenever `System.Windows.FrameworkElement.IsInitialized` is set to true internally. - **OnKeyDown**: Invoked when an unhandled `System.Windows.Input.Keyboard.KeyDown` attached event reaches an element in its route. ``` -------------------------------- ### Get DateTime Value by Offset in C# Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase~GetValueByOffset The GetValueByOffset method in C# calculates a DateTime value by adding a specified double offset to a starting DateTime. It is part of the DiscontinuousDateTimeCalendarBase class and is used for date calculations within the SciChart WPF charting library. No specific dependencies beyond the SciChart assembly are mentioned. ```csharp public DateTime GetValueByOffset( DateTime _start_, double _offset_ ) ``` -------------------------------- ### Initialization and Key Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl_members Methods related to element initialization and keyboard input. ```APIDOC ## Initialization and Key Events ### OnInitialized **Description**: Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. ### OnKeyDown **Description**: Invoked when an unhandled System.Windows.Input.Keyboard.KeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. ``` -------------------------------- ### AnnotationBase DragStartedCommand Property Syntax (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Annotations.AnnotationBase~DragStartedCommand This C# code snippet shows the syntax for the DragStartedCommand property within the AnnotationBase class. It allows you to get or set an ICommand interface, enabling command binding for drag start events on chart annotations. No external dependencies are required beyond the SciChart framework. ```csharp public ICommand DragStartedCommand {get; set;} ``` -------------------------------- ### Initialization and Touch Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Annotations.TextAnnotationForMvvm_members Handles initialization events and touch capture events. ```APIDOC ## OnGotTouchCapture ### Description Provides class handling for the System.Windows.UIElement.GotTouchCapture routed event that occurs when a touch is captured to this element. (Inherited from System.Windows.UIElement) ### Method Method ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` ```APIDOC ## OnInitialized ### Description Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. (Inherited from System.Windows.FrameworkElement) ### Method Method ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` ```APIDOC ## OnInvalidateParentSurface ### Description (Inherited from SciChart.Charting.ChartModifiers.ApiElementBase) ### Method Method ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### Install SciChart WPF 3D using NuGet Package Manager Console Source: https://www.scichart.com/documentation/win/current/Installing%20and%20Uninstalling%20SciChart Installs the SciChart WPF 3D package, which includes the SciChart.Charting3D.dll. This requires the Visual C++ 2013 Redistributable to be installed on development and end-user machines. ```csharp Install-Package SciChart3D ``` -------------------------------- ### System.Windows.FrameworkElement Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Charting3D~SciChart.Charting3D.SciChart3DRenderSurface_members Documentation for methods inherited from System.Windows.FrameworkElement, including EndInit, FindName, FindResource, MoveFocus, OnApplyTemplate. ```APIDOC ## Methods from System.Windows.FrameworkElement ### EndInit **Description**: Indicates that the initialization process for the element is complete. **Method**: N/A (Inherited) **Endpoint**: N/A ### FindName **Description**: Finds an element by its name. **Method**: N/A (Inherited) **Endpoint**: N/A ### FindResource **Description**: Searches for a resource with the specified key, and throws an exception if the requested resource is not found. **Method**: N/A (Inherited) **Endpoint**: N/A ### MoveFocus **Description**: Moves the keyboard focus away from this element and to another element in a provided traversal direction. **Method**: N/A (Inherited) **Endpoint**: N/A ### OnApplyTemplate **Description**: When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate. **Method**: N/A (Inherited) **Endpoint**: N/A ``` -------------------------------- ### Get Peak Z-Value in C# - UniformHeatmapYPeakDetector Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.UniformHeatmapYPeakDetector~GetPeakZValue The GetPeakZValue method of the UniformHeatmapYPeakDetector class calculates and returns the peak Z-value within a specified region of a heatmap. It requires parameters defining the data region to search (start, step, and count for both X and Y axes) and outputs the indices of the peak X and Y values. This method is useful for analyzing heatmap data to find extreme values. ```csharp public double GetPeakZValue( int _xStart_, int _xStep_, int _xCount_, int _yStart_, int _yStep_, int _yCount_, out int _peakXIndex_, out int _peakYIndex_ ) ``` -------------------------------- ### Initialization and Rendering Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Annotations.CustomAnnotationForMvvm_members Documentation for methods related to element initialization and rendering. ```APIDOC ## OnInitialized ### Description Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally. ### Method (Implicitly invoked by the framework) ### Endpoint N/A (Event Handler) ### Parameters None ### Request Example N/A ### Response N/A ## OnInvalidateParentSurface ### Description Method to invalidate the parent surface for rendering updates. ### Method (Implicitly invoked by the framework) ### Endpoint N/A (Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### Manipulation Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting.DrawingTools~SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotationForMvvm_members Handles various manipulation events such as BoundaryFeedback, Completed, Delta, InertiaStarting, Started, and Starting. ```APIDOC ## OnManipulationBoundaryFeedback /api/manipulation/boundaryfeedback ### Description Called when the System.Windows.UIElement.ManipulationBoundaryFeedback event occurs. ### Method N/A (Event Handler) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## OnManipulationCompleted /api/manipulation/completed ### Description Called when the System.Windows.UIElement.ManipulationCompleted event occurs. ### Method N/A (Event Handler) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## OnManipulationDelta /api/manipulation/delta ### Description Called when the System.Windows.UIElement.ManipulationDelta event occurs. ### Method N/A (Event Handler) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## OnManipulationInertiaStarting /api/manipulation/inertiastarting ### Description Called when the System.Windows.UIElement.ManipulationInertiaStarting event occurs. ### Method N/A (Event Handler) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## OnManipulationStarted /api/manipulation/started ### Description Called when the System.Windows.UIElement.ManipulationStarted event occurs. ### Method N/A (Event Handler) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## OnManipulationStarting /api/manipulation/starting ### Description Provides class handling for the System.Windows.UIElement.ManipulationStarting routed event that occurs when the manipulation processor is first created. ### Method N/A (Event Handler) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Keyboard and Mouse Preview Event Handlers Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Axes.PolarXAxisForMvvm_members Provides documentation for methods handling preview keyboard and mouse events. ```APIDOC ## Preview Keyboard and Mouse Events ### Description These methods are invoked when unhandled preview keyboard and mouse events reach an element in their route. They allow for class handling of these events. ### Method * OnPreviewLostKeyboardFocus * OnPreviewMouseDoubleClick * OnPreviewMouseDown * OnPreviewMouseLeftButtonDown * OnPreviewMouseLeftButtonUp * OnPreviewMouseMove * OnPreviewMouseRightButtonDown * OnPreviewMouseRightButtonUp * OnPreviewMouseUp * OnPreviewMouseWheel ### Endpoint N/A (These are event handlers within a class) ### Parameters N/A (These are event handlers, parameters are event-specific) ### Request Example N/A ### Response N/A ``` -------------------------------- ### Initialization and Key Down Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries_members Details for the initialization event and the key down event handler. ```APIDOC ## UIElement Initialization and Key Down Events ### Description Handles the initialization event for FrameworkElements and the key down event for UI elements. ### Method - OnInitialized - OnKeyDown ### Endpoint N/A (These are event handlers within a class) ### Parameters N/A (These are event handlers, parameters are event-specific) ### Request Example N/A ### Response N/A ``` -------------------------------- ### Start Path Drawing Context - C# Source: https://www.scichart.com/documentation/win/current/SciChart.Drawing~SciChart.Drawing.Common.IPathDrawingContext~Begin The Begin method is used to start a new path drawing context with specified color and starting coordinates. It requires the SciChart.Drawing.Common namespace. ```csharp IPathDrawingContext Begin( IPathColor _color_, double _x_, double _y_ ) ``` -------------------------------- ### UI Element Layout and Initialization Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeriesForMvvm_members Documentation for methods related to layout, template application, and initialization of UI elements. ```APIDOC ## UI Element Layout and Initialization ### Description Methods for managing element layout, applying templates, and controlling the initialization process. ### Methods #### ApplyTemplate - **Description**: 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**: System.Windows.FrameworkElement #### Arrange - **Description**: Positions child elements and determines a size for a System.Windows.UIElement. Parent elements call this method from their System.Windows.UIElement.ArrangeCore(System.Windows.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**: System.Windows.UIElement #### BeginInit - **Description**: Starts the initialization process for this element. - **Inherited from**: System.Windows.FrameworkElement #### EndInit - **Description**: Indicates that the initialization process for the element is complete. - **Inherited from**: System.Windows.FrameworkElement ``` -------------------------------- ### Manipulation Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Themes.ModifierAxisCanvas_members Handles events related to user manipulation gestures like inertia, starting, and starting points. ```APIDOC ## Manipulation Events ### Description Handles events related to user manipulation gestures such as inertia, starting, and starting points. ### Endpoints These are not traditional HTTP endpoints but rather methods called upon specific UI events. #### OnManipulationInertiaStarting - **Description**: Called when the System.Windows.UIElement.ManipulationInertiaStarting event occurs. - **Inherited from**: System.Windows.UIElement #### OnManipulationStarted - **Description**: Called when the System.Windows.UIElement.ManipulationStarted event occurs. - **Inherited from**: System.Windows.UIElement #### OnManipulationStarting - **Description**: Provides class handling for the System.Windows.UIElement.ManipulationStarting routed event that occurs when the manipulation processor is first created. - **Inherited from**: System.Windows.UIElement ``` -------------------------------- ### Install SciChart WPF 2D using NuGet Package Manager Console Source: https://www.scichart.com/documentation/win/current/Installing%20and%20Uninstalling%20SciChart Installs the SciChart WPF 2D package, which includes core DLLs for charting functionality. Ensure Visual Studio 2015 or later is used. ```csharp Install-Package SciChart ``` -------------------------------- ### FrameworkElement Initialization and Layout Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.ScrollbarViewport_members Documentation for events specific to FrameworkElement, such as initialization and loading, and layout-related events. ```APIDOC ## FrameworkElement Initialization and Layout Events ### Description This section covers events related to the initialization, loading, and layout processes of a FrameworkElement. ### Method N/A (These are event handlers) ### Endpoint N/A (These are event definitions within a component) ### Parameters N/A (These are event definitions) ### Request Example N/A ### Response N/A #### Event Details - **Initialized**: Occurs when this System.Windows.FrameworkElement is initialized. This event coincides with cases where the value of the System.Windows.FrameworkElement.IsInitialized property changes from **false** (or undefined) to **true**. (Inherited from System.Windows.FrameworkElement) - **LayoutUpdated**: Occurs when the layout of the various visual elements associated with the current System.Windows.Threading.Dispatcher changes. (Inherited from System.Windows.UIElement) - **Loaded**: Occurs when the element is laid out, rendered, and ready for interaction. (Inherited from System.Windows.FrameworkElement) ``` -------------------------------- ### Get and Set TextColor Property in C# Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries~TextColor This C# code snippet demonstrates how to get and set the TextColor property for a BaseHeatmapRenderableSeries object. This property controls the color of text rendered on the heatmap. It is a public property with a get and set accessor. ```csharp public Color TextColor {get; set;} ``` -------------------------------- ### Initialization and General Events Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisVertexLabel_members Handles initialization events and general UI element events. ```APIDOC ## Initialization and General Event Handling ### Description Handles initialization events and general UI element events. ### Endpoints - **OnInitialized** ### Method This is a method within a class that handles the Initialization event. It is typically invoked by the UI framework when the element is initialized. ### Parameters This method does not typically take direct parameters in the context of an API call. It is part of an event handling mechanism and receives event arguments provided by the framework. ### Request Example This is not applicable as this is an event handler within a class, not an API endpoint. ### Response This method is part of event handling and does not return values in the conventional API sense. Its purpose is to provide class-specific handling for the Initialization event. ``` -------------------------------- ### Get VerticalOffset Property (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation~VerticalOffset This code snippet demonstrates how to get the VerticalOffset property from an IAnchorPointAnnotation object. This property indicates the vertical position of an anchor point and is read-only. ```csharp double VerticalOffset {get;} ``` -------------------------------- ### Animation and Initialization Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Charting3D~SciChart.Charting3D.Visuals.RenderableSeries.WaterfallRenderableSeries3DForMvvm_members This section details methods related to starting and ending animations, initialization processes, and managing storyboard sequences. ```APIDOC ## Animation and Initialization Methods ### Description Methods for controlling animations, starting and ending initialization, and managing storyboard sequences. ### Methods - **BeginAnimation** - **Description**: Starts an animation for a specified animated property on this element. - **Inherited From**: System.Windows.UIElement - **BeginInit** - **Description**: Starts the initialization process for this element. - **Inherited From**: System.Windows.FrameworkElement - **BeginStoryboard** - **Description**: Begins the sequence of actions that are contained in the provided storyboard. - **Inherited From**: System.Windows.FrameworkElement - **EndInit** - **Description**: Indicates that the initialization process for the element is complete. - **Inherited From**: System.Windows.FrameworkElement ``` -------------------------------- ### C# Method Signature: IPathContextFactory.Begin Source: https://www.scichart.com/documentation/win/current/SciChart.Drawing~SciChart.Drawing.Common.IPathContextFactory~Begin Defines the C# signature for the Begin method of the IPathContextFactory interface. This method is used to start a path drawing context with specified color and starting coordinates. ```csharp IPathDrawingContext Begin( IPathColor _color_, double _startX_, double _startY_ ) ``` -------------------------------- ### Storyboard and Initialization Methods Source: https://www.scichart.com/documentation/win/current/SciChart.Core~SciChart.Core.AttachedProperties.Device_members Methods related to starting animations and completing element initialization. ```APIDOC ## BeginStoryboard / EndInit ### Description `BeginStoryboard` starts a sequence of actions defined in a storyboard. `EndInit` signals that the element's initialization is complete. ### Method Various (Inherited) ### Endpoint N/A ### Parameters None directly for these methods, they operate on the element instance. ### Request Example ``` // Example usage (conceptual) myElement.BeginStoryboard(myStoryboard); // ... initialization code ... myElement.EndInit(); ``` ### Response #### Success Response (N/A) These are procedural methods, not typically returning data. #### Response Example N/A ``` -------------------------------- ### VxRenderSettings Constructor Source: https://www.scichart.com/documentation/win/current/SciChart.Drawing~SciChart.Drawing.VisualXcceleratorRasterizer.VxRenderSettings_members Initializes a new instance of the VxRenderSettings class. ```APIDOC ## VxRenderSettings Constructor ### Description Initializes a new instance of the VxRenderSettings class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response (200) Initializes the VxRenderSettings object. #### Response Example None ``` -------------------------------- ### Get and Set StrokeThickness for BrushAnnotation (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Charting.DrawingTools~SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation~StrokeThickness The StrokeThickness property allows you to get or set the thickness of the stroke for a BrushAnnotation. This property is of type double and is available in C#. ```csharp public double StrokeThickness {get; set;} ``` -------------------------------- ### Get IsCategoryAxisCalculator Property (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Data~SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator%601~IsCategoryAxisCalculator This code snippet shows how to get the value of the IsCategoryAxisCalculator property in C#. This read-only property returns a boolean value indicating if the ICoordinateCalculator is designed for a category axis. ```csharp bool IsCategoryAxisCalculator {get;} ``` -------------------------------- ### Initialization and Automation Peers Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Themes.TabControlCompatible_members Covers methods related to the initialization of UI elements and the creation of automation peers for accessibility. ```APIDOC ## Initialization and Automation Peer Methods ### Description Includes methods for handling the initialization of UI elements (`OnInitialized`) and for providing automation peer implementations (`OnCreateAutomationPeer`), crucial for WPF automation infrastructure. ### Method OnInitialized, OnCreateAutomationPeer ### Endpoint N/A (These are class methods) ### Parameters - `InitializeComponent` (void): Called during the initialization process. - `CreateAutomationPeer` (AutomationPeer): Returns the appropriate automation peer for the control. ### Request Body N/A ### Response N/A ### Example ```csharp protected override AutomationPeer OnCreateAutomationPeer() { return new TabControlAutomationPeer(this); } ``` ``` -------------------------------- ### Initialization and Resource Management Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeriesForMvvm_members Methods for controlling the initialization process and finding resources. ```APIDOC ## BeginInit ### Description Starts the initialization process for this element. ### Method POST ### Endpoint /websites/scichart_win_current/BeginInit ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ```json { "message": "Start initialization" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates success. #### Response Example ```json { "status": "Initialization started" } ``` ## EndInit ### Description Indicates that the initialization process for the element is complete. ### Method POST ### Endpoint /websites/scichart_win_current/EndInit ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ```json { "message": "End initialization" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates success. #### Response Example ```json { "status": "Initialization ended" } ``` ## FindResource ### Description Searches for a resource with the specified key, and throws an exception if the requested resource is not found. ### Method GET ### Endpoint /websites/scichart_win_current/FindResource ### Parameters #### Path Parameters None #### Query Parameters - **resourceKey** (string) - Required - The key of the resource to find. ### Request Example ``` GET /websites/scichart_win_current/FindResource?resourceKey=MyStyle ``` ### Response #### Success Response (200) - **resource** (any) - The found resource. #### Response Example ```json { "resource": { ... } } ``` ``` -------------------------------- ### Get and Set ScrollbarStyle in C# Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.SciChartOverview~ScrollbarStyle This snippet shows how to get and set the ScrollbarStyle property for the SciChartOverview class. This property allows customization of the scrollbar's appearance. ```csharp public Style ScrollbarStyle {get; set;} ``` -------------------------------- ### Initialization and State Change Handlers Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries_members Methods for initialization and handling changes in keyboard focus and mouse capture states. ```APIDOC ## Initialization and State Change Handlers ### Description Methods related to element initialization and tracking changes in keyboard focus and mouse capture states. ### Method Various (Inherited/Overridden) ### Endpoint N/A (Class Methods) ### Parameters N/A ### Request Example N/A ### Response N/A #### OnInitialized Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to %[LangWord]true %internally. (Inherited from System.Windows.FrameworkElement) #### OnIsKeyboardFocusedChanged Invoked when an unhandled System.Windows.UIElement.IsKeyboardFocusedChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from System.Windows.UIElement) #### OnIsKeyboardFocusWithinChanged Invoked just before the System.Windows.UIElement.IsKeyboardFocusWithinChanged event is raised by this element. Implement this method to add class handling for this event. (Inherited from System.Windows.UIElement) #### OnIsMouseCapturedChanged Invoked when an unhandled System.Windows.UIElement.IsMouseCapturedChanged event is raised on this element. Implement this method to add class handling for this event. (Inherited from System.Windows.UIElement) ``` -------------------------------- ### Get AxisLabel Property (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Axes.ParallelDateTimeAxis~AxisLabel This snippet shows how to get or set the AxisLabel property for a ParallelDateTimeAxis object in C#. This property is of type string and represents the label displayed on the axis. ```csharp public string AxisLabel {get; set;} ``` -------------------------------- ### UI Element Initialization and Resource Management Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Themes.TernaryAxisCanvas_members Methods for managing the initialization process and accessing resources. ```APIDOC ## BeginInit /api/initialization/BeginInit ### Description Starts the initialization process for this element. ### Method POST ### Endpoint /api/initialization/BeginInit ### Parameters None ### Response #### Success Response (200) - **message** (string) - Indicates that the initialization process has started. #### Response Example ```json { "message": "Initialization started." } ``` ## EndInit /api/initialization/EndInit ### Description Indicates that the initialization process for the element is complete. ### Method POST ### Endpoint /api/initialization/EndInit ### Parameters None ### Response #### Success Response (200) - **message** (string) - Indicates that the initialization process is complete. #### Response Example ```json { "message": "Initialization complete." } ``` ## FindResource /api/resources/FindResource ### Description Searches for a resource with the specified key, and throws an exception if the requested resource is not found. ### Method GET ### Endpoint /api/resources/FindResource ### Parameters #### Query Parameters - **key** (string) - Required - The key of the resource to find. ### Response #### Success Response (200) - **resource** (object) - The found resource. #### Response Example ```json { "resource": { "value": "someResourceData" } } ``` ``` -------------------------------- ### Get IsAxisFlipped Property (C#) Source: https://www.scichart.com/documentation/win/current/SciChart.Charting~SciChart.Charting.Visuals.Axes.IAxis~IsAxisFlipped This C# code snippet shows how to get the value of the IsAxisFlipped property from an IAxis object. This property is a boolean value indicating if the axis is flipped. It is a read-only property. ```csharp bool IsAxisFlipped {get;} ```