### Get Pie Series Start Angle Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.PieDonutRenderableSeriesBase Retrieves the starting angle from which the pie series will be drawn. This is a float value representing degrees. ```Java public final float getStartAngle() ``` -------------------------------- ### XySeriesTooltip Constructor Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.XySeriesTooltip Initializes a new instance of the XySeriesTooltip class. ```APIDOC ## XySeriesTooltip Constructor ### Description Creates a new instance of XySeriesTooltip class. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A #### Parameters - **context** (android.content.Context) - Required - The context of application - **seriesInfo** (XySeriesInfo) - Required - The series info instance ``` -------------------------------- ### Get Heatmap Start Y Value (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.model.dataSeries.UniformHeatmapDataSeries Retrieves the starting Y value for a 2D heatmap. This property defines the heatmap's origin along the Y-axis. ```java public final TY getStartY() ``` -------------------------------- ### Configure Fifo DataSeries (Java, Java Builders, Kotlin) Source: https://www.scichart.com/documentation/android/current/articles/chart2d/DataSeries%20APIs Illustrates how to configure a DataSeries for First-In-First-Out (FIFO) behavior. This limits the data capacity, discarding old points as new ones are added, which is efficient for streaming charts. ```java final IXyDataSeries dataSeries = new XyDataSeries<>(Double.class, Double.class); dataSeries.setFifoCapacity(1000); ``` ```java final IXyDataSeries dataSeries = sciChartBuilder.newXyDataSeries(Double.class, Double.class) .withFifoCapacity(1000) .build(); ``` ```kotlin val dataSeries: IXyDataSeries = XyDataSeries(Double::class.java, Double::class.java) dataSeries.fifoCapacity = 1000 ``` -------------------------------- ### Get Heatmap Start X Value (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.model.dataSeries.UniformHeatmapDataSeries Retrieves the starting X value for a 2D heatmap. This is a fundamental property defining the heatmap's origin along the X-axis. ```java public final TX getStartX() ``` -------------------------------- ### SeriesTooltipCore Methods for Customization (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.SeriesTooltipCore Demonstrates key methods for customizing the appearance and behavior of SeriesTooltipCore. This includes applying theme providers, setting background and text colors, and managing the tooltip's attachment to services. ```Java public void applyThemeProvider(IThemeProvider themeProvider) { // Method implementation details } public final void setTooltipBackgroundColor(int color) { // Method implementation details } public final void setTooltipStroke(int color) { // Method implementation details } public final void setTooltipTextColor(int color) { // Method implementation details } public void attachTo(IServiceContainer services) { // Method implementation details } ``` -------------------------------- ### Create TooltipBase Instance (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.TooltipBase This snippet demonstrates how to create a new instance of the TooltipBase class. It requires an Android Context object as a parameter, which provides access to application-specific resources and classes. ```java public TooltipBase(Context context) { // Constructor implementation } ``` -------------------------------- ### Get Start Z Value for 3D Grid (Java) Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.model.dataSeries.grid.IUniformGridDataSeries3DValues This method retrieves the starting Z value of the 3D grid data series. It is an abstract method defined in the IUniformGridDataSeries3DValues interface. ```java public abstract TZ getStartZ(); ``` -------------------------------- ### Get Start X Value for 3D Grid (Java) Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.model.dataSeries.grid.IUniformGridDataSeries3DValues This method retrieves the starting X value of the 3D grid data series. It is an abstract method defined in the IUniformGridDataSeries3DValues interface. ```java public abstract TX getStartX(); ``` -------------------------------- ### BoundingBoxUtil Constructor Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.common.math.BoundingBoxUtil Initializes a new instance of the BoundingBoxUtil class. ```APIDOC ## BoundingBoxUtil() ### Description Initializes a new instance of the BoundingBoxUtil class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example ```java BoundingBoxUtil util = new BoundingBoxUtil(); ``` ### Response N/A ``` -------------------------------- ### LongValues Get and Set Methods Source: https://www.scichart.com/documentation/android/current/api/core/com.scichart.core.model.LongValues Provides examples of accessing and modifying values within the LongValues collection. 'get(int index)' retrieves the value at a specific index, while 'set(int location, long value)' updates the value at a given location. ```java public long get(int index) public void set(int location, long value) ``` -------------------------------- ### Initialize Annotation Placement Strategy (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.AnnotationBase Creates a new IAnnotationPlacementStrategy for a specified CoordinateSystem. This is an abstract method and must be implemented by subclasses. ```Java protected abstract IAnnotationPlacementStrategy initPlacementStrategy(strategyManager.CoordinateSystem newCoordinateSystem) ``` -------------------------------- ### SeriesTooltipCore State Management Methods (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.SeriesTooltipCore Illustrates methods for managing the state and attachment of the SeriesTooltipCore. This includes methods for detaching the tooltip, checking if it's attached, and setting the color of the series associated with the tooltip. ```Java public void detach() { // Method implementation details } public final boolean isAttached() { // Method implementation details return false; // Placeholder } protected final void setSeriesColor(int seriesColor) { // Method implementation details } ``` -------------------------------- ### Get Double Values by Range Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.IDoubleValuesProvider Retrieves a specified count of double values from the provider, starting at a given index. The values are added to a provided DoubleValues collection. ```csharp public abstract void getDoubleValues(DoubleValues doubleValues, int startIndex, int count) ``` -------------------------------- ### Set Axis AutoRange to Once (Java) Source: https://www.scichart.com/documentation/android/current/articles/chart2d/axisAPIs/Axis%20Ranging%20-%20AutoRange Sets the axis to autorange only once when the chart starts. This is the default behavior and will not adjust to subsequent data changes. Java code example. ```java final NumericAxis axis = new NumericAxis(getContext()); axis.setAutoRange(AutoRange.Once); ``` -------------------------------- ### SeriesTooltipBase Constructors and Methods Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.SeriesTooltipBase This snippet details the constructors and methods available in the SeriesTooltipBase class. It includes the protected constructor for creating instances and various public and protected methods for updating tooltip information, drawing overlays, and retrieving series data. The methods are essential for customizing tooltip behavior and appearance. ```Java public abstract class SeriesTooltipBase extends renderableSeriesSeriesTooltipCore implements renderableSeriesISeriesTooltip { protected SeriesTooltipBase(Context context, T seriesInfo) public boolean containsHitRenderableSeries(renderableSeries.IRenderableSeries renderableSeries) public final renderableSeries.IRenderableSeries getRenderableSeries() public final renderableSeries.hitTest.SeriesInfo getSeriesInfo() protected abstract void internalUpdate(T seriesInfo) public final void onDrawTooltipOverlay(Canvas canvas) public void onDrawTooltipOverlay(Canvas canvas, PointF xyCoordinate, int color) public void update(renderableSeries.hitTest.HitTestInfo hitTestInfo, boolean interpolate) } ``` -------------------------------- ### Get Internal Items Array with Index Normalization (Java) Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.ISciListFloat Retrieves the internal float array with an option to normalize the index. This is useful when dealing with data that might have offset start indices. ```java public abstract float[] getItemsArray(boolean normalizeIndex) ``` -------------------------------- ### Create PieSeriesTooltip Instance (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.PieSeriesTooltip Constructs a new instance of the PieSeriesTooltip class. This constructor requires the application context and a PieSeriesInfo object to initialize the tooltip with data specific to a pie series segment. ```java public PieSeriesTooltip(Context context, renderableSeries.hitTest.PieSeriesInfo pieSeriesInfo) ``` -------------------------------- ### BandSeriesTooltip Constructor with Series Info Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.BandSeriesTooltip Constructs a new BandSeriesTooltip instance. It requires the application context and series information for the band series. This is a primary way to initialize a tooltip for a band series. ```java public BandSeriesTooltip(Context context, renderableSeries.hitTest.BandSeriesInfo seriesInfo) ``` -------------------------------- ### getStartIndex() Method in ISciListDate Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.ISciListDate Gets the starting index within the internal items array. This method is defined in the ISciListDate interface for SciChart Android and is useful for understanding the data's position. ```java public abstract int getStartIndex() ``` -------------------------------- ### View Initialization and State Management Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.TextLabelContainer This section details methods related to the initialization and state management of a View, including methods for handling saved/restored instance states and detaching/attaching the view. ```APIDOC ## View Initialization and State Management ### Description This section details methods related to the initialization and state management of a View, including methods for handling saved/restored instance states and detaching/attaching the view. ### Methods - **onInitializeAccessibilityEvent**(android.view.accessibility.AccessibilityEvent event) - **onInitializeAccessibilityNodeInfo**(android.view.accessibility.AccessibilityNodeInfo info) - **onPopulateAccessibilityEvent**(android.view.accessibility.AccessibilityEvent event) - **onProvideAutofillStructure**(android.view.ViewStructure structure, int flags) - **onProvideAutofillVirtualStructure**(android.view.ViewStructure structure, int flags) - **onProvideContentCaptureStructure**(android.view.ViewStructure structure, int flags) - **onProvideStructure**(android.view.ViewStructure structure) - **onProvideVirtualStructure**(android.view.ViewStructure structure) ``` -------------------------------- ### Animate Series with AppendedPointTransformation (Kotlin) Source: https://www.scichart.com/documentation/android/current/articles/chart2d/animationsAPI/Animate%20Appended%20Point Animates a SciChart renderable series by appending new data points in real-time and applying a custom transformation. This example uses Kotlin and the AnimationsHelper API to create and start an animator. ```kotlin // Append new value to our dataSeries in real-time yValue = random.nextDouble() * MAX_Y_VALUE dataSeries.append(currentXValue, yValue) // Animate renderable series with our custom transformation AnimationsHelper.createAnimator( rSeries, AppendedPointTransformation(), ANIMATION_DURATION, 0, DecelerateInterpolator(), FloatEvaluator(), 0f, 1f ).start() ``` -------------------------------- ### beginSolidMesh Method Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.primitives.BaseSceneEntity Begins the creation of a solid mesh. The method accepts a boolean indicating whether to use triangle stripes for optimization. It returns an ISolidMesh object. ```java public final ISolidMesh beginSolidMesh(boolean isTriangleStripes) ``` -------------------------------- ### Animate Series with AppendedPointTransformation (Java) Source: https://www.scichart.com/documentation/android/current/articles/chart2d/animationsAPI/Animate%20Appended%20Point Animates a SciChart renderable series by appending new data points in real-time and applying a custom transformation. This example uses Java and the AnimationsHelper API to create and start an animator. ```java // Append new value to our dataSeries in real-time yValue = random.nextDouble() * MAX_Y_VALUE; dataSeries.append(currentXValue, yValue); // Animate renderable series with our custom transformation AnimationsHelper.createAnimator( rSeries, new AppendedPointTransformation(), ANIMATION_DURATION, 0, new DecelerateInterpolator(), new FloatEvaluator(), 0f, 1f ).start(); ``` ```java // Append new value to our dataSeries in real-time yValue = random.nextDouble() * MAX_Y_VALUE; dataSeries.append(currentXValue, yValue); // Animate renderable series with our custom transformation AnimationsHelper.createAnimator( rSeries, new AppendedPointTransformation(), ANIMATION_DURATION, 0, new DecelerateInterpolator(), new FloatEvaluator(), 0f, 1f ).start(); ``` -------------------------------- ### Get Event Group Tag (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.modifiers.ChartModifierCore Retrieves the string identifier used for propagating motion events from the master chart to this modifier. This is crucial for event routing in complex chart setups. ```Java public String getEventsGroupTag() ``` -------------------------------- ### Initialize FastOhlcRenderableSeries (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.FastOhlcRenderableSeries Provides two constructors for the FastOhlcRenderableSeries class. The default constructor creates a new instance without arguments. An overloaded constructor allows for the initialization with specific render pass data, hit provider, and nearest point provider instances. ```Java public FastOhlcRenderableSeries() public FastOhlcRenderableSeries(renderableSeriesOhlcRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider) ``` -------------------------------- ### Stopwatch Class Definition (Java) Source: https://www.scichart.com/documentation/android/current/api/core/com.scichart.core.utility.Stopwatch Defines the Stopwatch class in Java, which is used to measure the time elapsed between events. It provides methods to start, stop, reset, and get the elapsed time. ```java public final class Stopwatch ``` -------------------------------- ### DefaultOhlcSeriesInfoProvider Constructors Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.hitTest.DefaultOhlcSeriesInfoProvider Provides details on how to instantiate the DefaultOhlcSeriesInfoProvider class. ```APIDOC ## DefaultOhlcSeriesInfoProvider() ### Description Creates a new instance of the DefaultOhlcSeriesInfoProvider class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example ```java DefaultOhlcSeriesInfoProvider provider = new DefaultOhlcSeriesInfoProvider(); ``` ### Response N/A ## DefaultOhlcSeriesInfoProvider(Class renderableSeriesType) ### Description Creates a new instance of the DefaultOhlcSeriesInfoProvider class with a specified renderable series type. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters - **renderableSeriesType** (Class) - Required - The renderable series type to use. ### Request Example ```java DefaultOhlcSeriesInfoProvider provider = new DefaultOhlcSeriesInfoProvider(OhlcRenderableSeriesBase.class); ``` ### Response N/A ``` -------------------------------- ### Constructor for NotifiableSmartPropertyInteger with Listener and Default Value (Java) Source: https://www.scichart.com/documentation/android/current/api/core/com.scichart.core.framework.NotifiableSmartPropertyInteger This Java constructor initializes a NotifiableSmartPropertyInteger instance with both a listener and a default integer value. This allows for immediate setup with a starting value and the ability to track subsequent changes. ```java public NotifiableSmartPropertyInteger(IPropertyChangeListener listener, int defaultValue) ``` -------------------------------- ### SeriesTooltip3DBase Class Overview Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.renderableSeries.tooltips.SeriesTooltip3DBase Provides an overview of the SeriesTooltip3DBase class, its syntax, type parameters, constructors, and methods. ```APIDOC ## SeriesTooltip3DBase Class ### Description Abstract base class for 3D series tooltips in SciChart Android. It extends `renderableSeriesSeriesTooltipCore` and implements `renderableSeriesISeriesTooltip3D`. ### Syntax ```java public abstract class SeriesTooltip3DBase extends renderableSeriesSeriesTooltipCore implements renderableSeriesISeriesTooltip3D ``` ### Type Parameters - **T**: Represents the type of series info used by the tooltip. ### Constructors #### SeriesTooltip3DBase(Context context, T seriesInfo) Creates a new instance of the `SeriesTooltip3DBase` class. - **Parameters**: - **context** (android.content.Context) - Required - The context of the application. - **seriesInfo** (T) - Required - The series info used by the tooltip. ### Methods #### getRenderableSeries() Gets the `IRenderableSeries3D` associated with this tooltip. - **Returns**: - **renderableSeries.IRenderableSeries3D** - The renderable series. #### getSeriesInfo3D() Gets the `SeriesInfo3D` for the current tooltip. - **Returns**: - **SeriesInfo3D** - The series info. #### internalUpdate(T seriesInfo) Abstract method to update the tooltip with information provided by `seriesInfo`. - **Parameters**: - **seriesInfo** (T) - Required - The series info to update the tooltip with. #### update(renderableSeries.hitTest.HitTestInfo3D hitTestInfo) Updates the tooltip based on the provided `HitTestInfo3D`. - **Parameters**: - **hitTestInfo** (renderableSeries.hitTest.HitTestInfo3D) - Required - The hit test information. ### Implements - **ISeriesTooltip3D** ``` -------------------------------- ### Get Normalized Items Array - ISciListByte (Java) Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.ISciListByte Retrieves the internal byte array, with an option to normalize the index. This is useful when the list's starting index differs from zero, ensuring correct data access. ```java public abstract byte[] getItemsArray(boolean normalizeIndex) ``` -------------------------------- ### Initialize DataSeries and Variables (Java) Source: https://www.scichart.com/documentation/android/current/articles/quickStartGuide/tutorials2d/Tutorial%2004%20-%20Adding%20Realtime%20Updates Initializes variables and DataSeries for real-time updates in Java. This includes setting up a scheduled executor service for timer-based updates and creating DoubleValues objects for efficient data storage. ```java private int pointsCount = 200; private ScheduledExecutorService scheduledExecutorService = Executors.newSingleThreadScheduledExecutor(); private ScheduledFuture schedule; private SciChartSurface surface; private final DoubleValues lineData = new DoubleValues(); private XyDataSeries lineDataSeries; private DoubleValues scatterData = new DoubleValues(); private XyDataSeries scatterDataSeries; ``` -------------------------------- ### Get Camera Aspect Ratio Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.camera.Camera3D Retrieves the aspect ratio of the camera's viewport. The aspect ratio is calculated as the width divided by the height, and is returned as a float. For example, a value of 1.333 indicates the width is 1.333 times the height. ```java public final float getAspectRatio() ``` -------------------------------- ### ObservableCollection Constructors Source: https://www.scichart.com/documentation/android/current/api/core/com.scichart.core.observable.ObservableCollection Provides details on how to instantiate an ObservableCollection. ```APIDOC ## ObservableCollection Constructors ### ObservableCollection() Creates a new ObservableCollection instance. #### Declaration ```java public ObservableCollection() ``` ### ObservableCollection(int capacity) Creates a new ObservableCollection instance with a specified initial capacity. #### Declaration ```java public ObservableCollection(int capacity) ``` #### Parameters - **capacity** (int) - The initial capacity of the collection. ``` ```APIDOC ### ObservableCollection(Collection collection) Creates a new ObservableCollection instance containing the elements of the specified collection. #### Declaration ```java public ObservableCollection(Collection collection) ``` #### Parameters - **collection** (Collection) - The collection whose elements are to be placed into this ObservableCollection. ``` -------------------------------- ### RenderableSeriesSeriesTooltipCore Methods for Configuration Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.XyzSeriesTooltip Offers methods to configure and manage the core aspects of a series tooltip, such as applying theme providers, attaching/detaching from services, clearing tooltip data, and setting colors. Dependencies include IThemeProvider and IServiceContainer. ```java renderableSeriesSeriesTooltipCore.applyThemeProvider(IThemeProvider) renderableSeriesSeriesTooltipCore.attachTo(IServiceContainer) renderableSeriesSeriesTooltipCore.clear() renderableSeriesSeriesTooltipCore.detach() renderableSeriesSeriesTooltipCore.isAttached() renderableSeriesSeriesTooltipCore.setSeriesColor(int) renderableSeriesSeriesTooltipCore.setTooltipBackgroundColor(int) renderableSeriesSeriesTooltipCore.setTooltipStroke(int) renderableSeriesSeriesTooltipCore.setTooltipTextColor(int) ``` -------------------------------- ### Get Zero Line Y Value (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.BaseRenderableSeries Retrieves the double value that determines the zero line's position in the Y-direction. This value is used, for example, to set the bottom of columns or the zero line in mountain series. ```java public final double getZeroLineY() ``` -------------------------------- ### ViewGroup Window and Transition Methods Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.layout.RotationLayout Methods related to window inset animations and layout transitions. ```APIDOC ## ViewGroup Window and Transition Methods ### Description Methods for managing window inset animations and layout transitions within a ViewGroup. ### Method Various (e.g., `setWindowInsetsAnimationCallback`, `setLayoutTransition`) ### Endpoint N/A (Class methods) ### Parameters **Varies by method.** Examples: - `setWindowInsetsAnimationCallback(android.view.WindowInsetsAnimation.Callback callback)`: Takes a WindowInsetsAnimation.Callback. - `setLayoutTransition(android.animation.LayoutTransition transition)`: Takes a LayoutTransition object. ### Request Example N/A ### Response N/A #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Get Internal Items Array with Index Normalization (Java) Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.ISciListDouble Retrieves the internal double array, with an option to normalize the index. This is useful when the list's starting index differs from 0, ensuring correct data access. ```java public abstract double[] getItemsArray(boolean normalizeIndex) ``` -------------------------------- ### Get FIFO Start Index in C# Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.IFifoBuffer The getStartIndex() method, defined within the IFifoBuffer interface, returns the raw index of the very first item currently present in the FIFO buffer. This can be useful for understanding the internal state of the buffer. ```csharp public abstract int getStartIndex(); ``` -------------------------------- ### SmartPropertyDouble Constructors Source: https://www.scichart.com/documentation/android/current/api/core/com.scichart.core.framework.SmartPropertyDouble Provides details on how to instantiate the SmartPropertyDouble class. ```APIDOC ## SmartPropertyDouble() ### Description Creates a new instance of the SmartPropertyDouble class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example ```java SmartPropertyDouble myProp = new SmartPropertyDouble(); ``` ### Response N/A --- ## SmartPropertyDouble(double defaultValue) ### Description Creates a new instance of the SmartPropertyDouble class with a specified default value. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **defaultValue** (double) - Required - The default value for the property. ### Request Example ```java SmartPropertyDouble myProp = new SmartPropertyDouble(10.5); ``` ### Response N/A ``` -------------------------------- ### View Display Hint and Screen State Methods Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.AxisMarkerAnnotation This section covers methods related to display hints and screen state changes. ```APIDOC ## View Display Hint and Screen State Methods ### Description Details methods for handling display hints and responding to changes in the screen state. ### Methods - `onDisplayHint(int)`: Called when the view receives a display hint. - `onScreenStateChanged(int)`: Called when the screen state changes. ``` -------------------------------- ### Java: Get Min and Max Items from ISciList Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.ISciList Obtains the minimum and maximum items from the ISciList. There are two overloads: one for the entire list and another for a specified range defined by start and end indices. The results are stored in an provided IRange object. ```Java public abstract void getMinMax(IRange range); public abstract void getMinMax(int startIndex, int endIndex, IRange range); ``` -------------------------------- ### Complete MainActivity Setup with SciChartSurface Source: https://www.scichart.com/documentation/android/current/articles/quickStartGuide/projectSetup/Adding%20SciChart%20using%20xml This is a full example of an Android MainActivity using XML for layout. It initializes SciChartSurface, adds axes, and renders a line series with sample data. Requires Android AppCompatActivity and SciChart dependencies. ```kotlin import androidx.appcompat.app.AppCompatActivity import android.os.Bundle import com.scichart.charting.visuals.SciChartSurface import com.scichart.charting.visuals.axes.IAxis import com.scichart.charting.visuals.axes.NumericAxis import com.scichart.charting.visuals.renderableSeries.FastLineRenderableSeries import com.scichart.data.model.DoubleValues import com.scichart.drawing.utility.common.UpdateSuspender import com.example.scichartdemo.databinding.ActivityMainUsingXmlBinding // Assuming generated binding class import kotlin.math.sin class MainActivityUsingXml : AppCompatActivity() { private lateinit var binding: ActivityMainUsingXmlBinding override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) binding = ActivityMainUsingXmlBinding.inflate(layoutInflater) setContentView(binding.root) val surface = findViewById(R.id.surface) val xAxis: IAxis = NumericAxis(this) val yAxis: IAxis = NumericAxis(this) UpdateSuspender.using(surface) { surface.xAxes.add(xAxis) surface.yAxes.add(yAxis) } val count = 1000 val xValues = DoubleValues(count) val yValues = DoubleValues(count) for (i in 0 until count) { val x = 10.0 * i.toDouble() / count.toDouble() val y = sin(2 * x) xValues.add(x) yValues.add(y) } val dataSeries = XyDataSeries(Double::class.javaObjectType, Double::class.javaObjectType).apply { append(xValues, yValues) } val renderableSeries = FastLineRenderableSeries().apply { this.dataSeries = dataSeries } surface.renderableSeries.add(renderableSeries) } } ``` -------------------------------- ### View Insets and System Windows Methods Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.AxisMarkerAnnotation This section covers methods for requesting insets and handling system windows. ```APIDOC ## View Insets and System Windows Methods ### Description Details methods for requesting layout adjustments based on system window insets and fitting system windows. ### Methods - `requestApplyInsets()`: Requests that the view's insets be applied. - `requestFitSystemWindows()`: Requests that the view fit within the system windows. ``` -------------------------------- ### Wave Animation with Builders API (Java) Source: https://www.scichart.com/documentation/android/current/articles/chart2d/animationsAPI/Animations%20API Configures a Wave animation using SciChart's Builders API in Java. This approach simplifies animation setup by chaining method calls for series, transformation, interpolator, duration, and start delay. ```java sciChartBuilder.newAnimator(rSeries) .withWaveTransformation(0.5f) .withInterpolator(new DecelerateInterpolator()) .withDuration(3000) .withStartDelay(350) .start(); ``` -------------------------------- ### LineAnnotationBase Methods - Placement and Drawing Logic (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.LineAnnotationBase Details methods for initializing placement strategies and the core drawing logic within LineAnnotationBase. It includes the abstract 'internalDraw' method for custom drawing implementations. ```java protected IAnnotationPlacementStrategy initPlacementStrategy(strategyManager.CoordinateSystem newCoordinateSystem) protected abstract void internalDraw(Canvas canvas, PointF lineStart, PointF lineEnd) ``` -------------------------------- ### Get Positive Min/Max in Range (Java) Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.ISciList Retrieves the positive minimum and maximum values within a specified range of a list. This method is useful for analyzing positive data points in a dataset. It requires start and end indices and an IRange object to store the results. ```java public abstract void getMinMaxPositive(int startIndex, int endIndex, IRange range) ``` -------------------------------- ### RenderPassStateCore Constructors and Methods Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.rendering.RenderPassStateCore This section details the constructors and public methods available for the RenderPassStateCore class, including how to add errors/warnings, dispose of resources, retrieve error/warning lists, and notify about data range changes. ```APIDOC ## RenderPassStateCore Class Overview ### Description Provides functionality to manage the state of a render pass, including adding and retrieving error and warning messages, and scheduling data range change notifications. ### Methods #### `addError(String errorMessage)` ##### Description Adds an error message to be published at the end of the current render pass. ##### Method `public void addError(String errorMessage)` ##### Parameters - **errorMessage** (String) - Required - The error message to publish. #### `addWarning(String warningMessage)` ##### Description Adds a warning message to be published at the end of the current render pass. ##### Method `public void addWarning(String warningMessage)` ##### Parameters - **warningMessage** (String) - Required - The warning message to publish. #### `dispose()` ##### Description Disposes of the resources associated with the render pass state. ##### Method `public void dispose()` #### `getErrors()` ##### Description Gets the list of error messages collected during the current render pass. ##### Method `public final List getErrors()` ##### Returns - **List** - A list of error messages. #### `getWarnings()` ##### Description Gets the list of warning messages collected during the current render pass. ##### Method `public final List getWarnings()` ##### Returns - **List** - A list of warning messages. #### `notifyDataRangeChanged(IAxisCore axis)` ##### Description Schedules a notification for an `IAxisCore` object that its data range has changed. This notification will be processed at the end of the current render pass. ##### Method `public final void notifyDataRangeChanged(IAxisCore axis)` ##### Parameters - **axis** (IAxisCore) - Required - The axis to notify about the data range change. ``` -------------------------------- ### Initialize DataSeries and Variables (Kotlin) Source: https://www.scichart.com/documentation/android/current/articles/quickStartGuide/tutorials2d/Tutorial%2004%20-%20Adding%20Realtime%20Updates Initializes variables and DataSeries for real-time updates in Kotlin. This includes setting up a scheduled executor service for timer-based updates and creating DoubleValues objects for efficient data storage. ```kotlin private val pointsCount = 200 private val scheduledExecutorService = Executors.newSingleThreadScheduledExecutor() private lateinit var schedule: ScheduledFuture<*> private lateinit var surface: SciChartSurface private val lineData = DoubleValues() private val lineDataSeries = XyDataSeries(Int::class.javaObjectType, Double::class.javaObjectType) private val scatterData = DoubleValues() private val scatterDataSeries = XyDataSeries(Int::class.javaObjectType, Double::class.javaObjectType) ``` -------------------------------- ### Setup SciChartSurface with Axes and Modifiers (Kotlin) Source: https://www.scichart.com/documentation/android/current/articles/quickStartGuide/tutorials2d/Tutorial%2007%20-%20Linking%20Multiple%20Charts Sets up a SciChartSurface with two Y-axes and several chart modifiers using idiomatic Kotlin syntax. This example leverages Kotlin's property accessors and scope functions for concise configuration. ```kotlin private fun setupSurface(surface: SciChartSurface) { // Create another numeric axis, right-aligned val yAxisRight = NumericAxis(this) yAxisRight.axisTitle = "Primary Y-Axis" yAxisRight.axisId = "Primary Y-Axis" yAxisRight.axisAlignment = AxisAlignment.Right // Create another numeric axis, left-aligned val yAxisLeft = NumericAxis(this) yAxisLeft.axisTitle = "Secondary Y-Axis" yAxisLeft.axisId = "Secondary Y-Axis" yAxisLeft.axisAlignment = AxisAlignment.Left yAxisLeft.growBy = DoubleRange(0.2, 0.2) val rolloverModifier = RolloverModifier() rolloverModifier.receiveHandledEvents = true rolloverModifier.eventsGroupTag = "SharedEventGroup" UpdateSuspender.using(surface) { Collections.addAll(surface.xAxes, NumericAxis(this)) Collections.addAll(surface.yAxes, yAxisLeft, yAxisRight) Collections.addAll( surface.chartModifiers, ZoomExtentsModifier(), PinchZoomModifier(), rolloverModifier, XAxisDragModifier(), YAxisDragModifier() ) } } setupSurface(surface) setupSurface(surface2) ``` -------------------------------- ### Java: Create Point2DSeries Instance Source: https://www.scichart.com/documentation/android/current/api/data/com.scichart.data.model.Point2DSeries Demonstrates how to create a new instance of Point2DSeries. This can be done with default initialization, by providing collections of X and Y values along with indices, or by specifying an initial size. ```java public Point2DSeries() public Point2DSeries(DoubleValues xValues, DoubleValues yValues, IntegerValues indices) public Point2DSeries(int size) ``` -------------------------------- ### Getting Double Values from GridData (Java) Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.model.dataSeries.GridData Methods to extract double precision values from the grid data. 'getDoubleValue(int index)' retrieves a single value, while 'getDoubleValues' methods allow fetching multiple values into provided DoubleValues collections, optionally with specific start indices and counts. ```java public final double getDoubleValue(int index) public final void getDoubleValues(DoubleValues doubleValues, IntegerValues indices) public final void getDoubleValues(DoubleValues doubleValues, int startIndex, int count) ``` -------------------------------- ### Apply Theme Provider to Renderable Series Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.BaseBandRenderableSeries Demonstrates how to apply a theme provider to a renderable series. This method allows for centralized styling of chart elements. ```java public void applyThemeProvider(IThemeProvider themeProvider) { // ... implementation ... } ``` -------------------------------- ### Full MainActivity Example with SciChart Compose Source: https://www.scichart.com/documentation/android/current/articles/quickStartGuide/projectSetup/Adding%20SciChart%20from%20Compose Presents a complete `MainActivity` and a `SciChartView` composable function that integrates SciChartSurface into an Android application using Jetpack Compose. It demonstrates the complete setup, including adding axes, generating data, and rendering a line series within the `AndroidView` composable. ```kotlin class MainActivity : AppCompatActivity() { private lateinit var binding: ActivityMainBinding override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) binding = ActivityMainBinding.inflate(layoutInflater) setContentView(binding.root) binding.composeView.setContent { SciChartView() } } } @Composable fun SciChartView() { AndroidView(factory = { context -> SciChartSurface(context) }, update = { surface -> val xAxis: IAxis = NumericAxis(surface.context) val yAxis: IAxis = NumericAxis(surface.context) UpdateSuspender.using(surface) { surface.xAxes.add(xAxis) surface.yAxes.add(yAxis) } val count = 1000 val xValues = DoubleValues(count) val yValues = DoubleValues(count) for (i in 0 until count) { val x = 10.0 * i.toDouble() / count.toDouble() val y = sin(2 * x) xValues.add(x) yValues.add(y) } val dataSeries = XyDataSeries(Double::class.javaObjectType, Double::class.javaObjectType).apply { append(xValues, yValues) } val renderableSeries = FastLineRenderableSeries().apply { this.dataSeries = dataSeries } surface.renderableSeries.add(renderableSeries) }) } ``` -------------------------------- ### beginPoints Method Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.primitives.BaseSceneEntity Starts the process of drawing points. This method requires the size of the points and a BasePointMarker3D object to define their appearance. It returns an IPointsMesh object for rendering. ```java public final IPointsMesh beginPoints(float pointsSize, pointMarkers.BasePointMarker3D pointMarker) ``` -------------------------------- ### Create LineAnnotation using Kotlin Source: https://www.scichart.com/documentation/android/current/articles/chart2d/annotationsAPIs/LineAnnotation Shows how to instantiate and configure a LineAnnotation in Kotlin. This example covers setting interactive features, specifying axis identifiers for multi-axis charts, defining the line's start and end points, and applying a stroke style. Relies on the SciChart Android SDK. ```Kotlin val lineAnnotation = LineAnnotation(context) lineAnnotation.setIsEditable(true) lineAnnotation.xAxisId = "TopAxisId" lineAnnotation.yAxisId = "LeftAxisId" lineAnnotation.coordinateMode = AnnotationCoordinateMode.RelativeY lineAnnotation.x1 = 20 lineAnnotation.y1 = 0.2 lineAnnotation.x2 = 60 lineAnnotation.y2 = 0.8 lineAnnotation.stroke = SolidPenStyle(-0x66bd52be, true, 4f, null) surface.annotations.add(lineAnnotation); ``` -------------------------------- ### Create Cylindroid 3D Chart with Java Builders API Source: https://www.scichart.com/documentation/android/current/articles/chart3d/3dChartTypes/freeSurfaceSeries3D/Cylindroid This example demonstrates creating a Cylindroid 3D Chart using SciChart's Java Builders API. It follows a similar data setup as the standard API but uses a fluent, chained method approach for configuring the FreeSurfaceRenderableSeries3D. This can lead to more readable code for complex configurations. It requires the `sciChart3DBuilder` instance. ```Java final int sizeU = 40, sizeV = 20; final CylindroidDataSeries3D meshDataSeries = new CylindroidDataSeries3D<>(Double.class, Double.class, sizeU, sizeV); meshDataSeries.setA(3d); meshDataSeries.setB(3d); meshDataSeries.setH(7d); final Random random = new Random(); for (int u = 0; u < sizeU; u++) { for (int v = 0; v < sizeV; v++) { final double weight = 1d - Math.abs(2d * v / sizeV - 1d); final double offset = random.nextDouble(); meshDataSeries.setDisplacement(u, v, offset * weight); } } final int[] colors = new int[]{0xFF00008B, 0xFF0000FF, 0xFF00FFFF, 0xFFADFF2F, 0xFFFFFF00, 0xFFFF0000, 0xFF8B0000}; final float[] stops = new float[]{0, .1f, .3f, .5f, .7f, .9f, 1}; final GradientColorPalette palette = new GradientColorPalette(colors, stops); final FreeSurfaceRenderableSeries3D rs = sciChart3DBuilder.newFreeSurfaceSeries3D() .withDataSeries(meshDataSeries) .withDrawMeshAs(DrawMeshAs.SolidWireframe) .withStroke(0x77228B22) .withContourInterval(0.1f) .withContourStroke(0x77228B22) .withStrokeThicknes(2f) .withLightingFactor(0.8f) .withMeshColorPalette(palette) .withPaletteMinMaxMode(FreeSurfacePaletteMinMaxMode.Relative) .withPaletteMinimum(new Vector3(3f, 0f, 0f)) .withPaletteMaximum(new Vector3(4f, 0f, 0f)) .build(); ``` -------------------------------- ### LerpXySeriesInfo Constructor (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.hitTest.LerpXySeriesInfo Initializes a new instance of the LerpXySeriesInfo class, requiring a reference to the parent XyRenderableSeriesBase. ```java public LerpXySeriesInfo(renderableSeries.XyRenderableSeriesBase renderableSeries) ``` -------------------------------- ### Set Start Angle Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.PieDonutRenderableSeriesBase Sets the start angle value from which this series will be drawn. The method takes a float representing the start angle. ```java public final void setStartAngle(float startAngle) ``` -------------------------------- ### FastMountainRenderableSeries Constructors Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.FastMountainRenderableSeries Demonstrates the creation of a FastMountainRenderableSeries instance. It shows both the default constructor and a protected constructor that accepts specific render pass data, hit provider, and nearest point provider. ```Java public FastMountainRenderableSeries() protected FastMountainRenderableSeries(renderableSeriesMountainRenderPassData currentRenderPassData, renderableSeries.hitTest.IHitProvider hitProvider, renderableSeries.hitTest.INearestPointProvider nearestPointProvider) ``` -------------------------------- ### SciChartHeatmapColourMap Methods - Theme and Properties (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.SciChartHeatmapColourMap Provides methods for applying a theme and managing core properties of the SciChartHeatmapColourMap. This includes applying a theme provider, and getting/setting the color map, maximum value, minimum value, and text format. ```Java public void applyThemeProvider(IThemeProvider themeProvider) ``` ```Java public final renderableSeries.ColorMap getColorMap() ``` ```Java public final void setColorMap(renderableSeries.ColorMap colorMap) ``` ```Java public final double getMaximum() ``` ```Java public final void setMaximum(double maximum) ``` ```Java public final double getMinimum() ``` ```Java public final void setMinimum(double minimum) ``` ```Java public final Format getTextFormat() ``` ```Java public final void setTextFormat(Format textFormat) ``` -------------------------------- ### Get Y-Axis Associated with IRenderableSeries Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.IRenderableSeries Gets the YAxis instance that this IRenderableSeries is associated with. ```java public abstract IAxis getYAxis() /** * Gets the YAxis that this IRenderableSeries is associated with */ ``` -------------------------------- ### PieSeriesTooltipBase Class Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.PieSeriesTooltipBase Documentation for the PieSeriesTooltipBase abstract class, including its syntax, type parameters, constructors, and methods. ```APIDOC ## PieSeriesTooltipBase Class ### Description Provides a base implementation for pie series tooltips in SciChart Android. ### Syntax ``` public abstract class PieSeriesTooltipBase extends TooltipBase implements renderableSeriesIPieSeriesTooltip ``` ### Type Parameters - **T**: Represents the type of pie series info. ### Constructors #### PieSeriesTooltipBase(Context context, T pieSeriesInfo) Creates a new instance of the PieSeriesTooltipBase class. - **Parameters**: - **context** (android.content.Context) - Required - The context of the application. - **pieSeriesInfo** (T) - Required - The series info instance. ### Methods #### attachTo(IServiceContainer services) Attaches the tooltip to a service container. - **Parameters**: - **services** (IServiceContainer) - Required - The service container to attach to. #### clear() Clears the tooltip content. #### detach() Detaches the tooltip from its services. #### getRenderableSeries() Gets the parent renderable series. - **Returns**: - **renderableSeries.IPieRenderableSeries**: The parent renderable series. #### getSeriesInfo() Gets the associated PieSeriesInfo instance. - **Returns**: - **PieSeriesInfo**: The associated PieSeriesInfo instance. #### internalUpdate(T seriesInfo) Updates tooltips with information provided by `seriesInfo`. - **Parameters**: - **seriesInfo** (T) - Required - The series info. #### isAttached() Checks if the tooltip is attached. - **Returns**: - **boolean**: True if attached, false otherwise. #### setSegmentColor(int segmentColor) Sets the color for a specific segment. - **Parameters**: - **segmentColor** (int) - Required - The color to set. #### setTooltipBackgroundColor(int color) Sets the background color for this ISeriesTooltip instance. - **Parameters**: - **color** (int) - Required - The background color. #### setTooltipStroke(int color) Sets the stroke color for this ISeriesTooltip instance. - **Parameters**: - **color** (int) - Required - The stroke color. #### setTooltipTextColor(int color) Sets the text color for this ISeriesTooltip instance. - **Parameters**: - **color** (int) - Required - The text color. #### update(renderableSeries.hitTest.PieHitTestInfo pieHitTestInfo) Updates this instance with information provided by `pieHitTestInfo` instance. - **Parameters**: - **pieHitTestInfo** (renderableSeries.hitTest.PieHitTestInfo) - Required - The hit test info. #### updateTooltip(Action2 updateAction, PointF xyCoordinate) Updates tooltips with the specified updateAction. - **Parameters**: - **updateAction** (Action2) - Required - The action to update the tooltip. - **xyCoordinate** (PointF) - Required - The coordinate for the tooltip update. ``` -------------------------------- ### Notify on Drag Started (Android) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.AnnotationBase Notifies listeners about the start of a drag operation. This method is called when a drag event begins. ```java protected final void notifyOnDragStarted() ``` -------------------------------- ### ImageView Methods (Java) - Layout and Sizing Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.legend.LegendPointMarker Illustrates methods related to the layout and sizing of an ImageView, such as adjusting view bounds, setting maximum dimensions, and defining the drawing region. ```java public boolean getAdjustViewBounds() public boolean getBaselineAlignBottom() public boolean getCropToPadding() public int getMaxHeight() public int getMaxWidth() public void setAdjustViewBounds(boolean adjustViewBounds) public void setBaselineAlignBottom(boolean baselineAlignBottom) public void setCropToPadding(boolean cropToPadding) public void setFrame(int left, int top, int right, int bottom) public void setMaxHeight(int maxHeight) public void setMaxWidth(int maxWidth) ``` -------------------------------- ### Get Hole Radius (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.SciPieChartSurface Gets the current value of the hole radius. This property is specifically used for DonutRenderableSeries to define the radius of the central hole. ```Java public final float getHoleRadius() ``` -------------------------------- ### Set Pie Chart Series Start Angle Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.IPieRenderableSeries Specifies the starting angle from which the pie chart segments are drawn. This allows for rotation of the entire chart. ```java public abstract void setStartAngle(float startAngle) // Parameter: // startAngle: float - The new start angle in degrees. ``` -------------------------------- ### TooltipContainerBase Constructor with Context and Attributes Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.modifiers.behaviors.TooltipContainerBase Creates a new instance of the TooltipContainerBase class using the application context and attribute set. This allows for custom styling and attributes to be applied during initialization. ```java public TooltipContainerBase(Context context, AttributeSet attrs) ``` -------------------------------- ### Get Camera Target (Java) Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.camera.ICameraController Gets or sets the target point of the camera in world coordinates as a Vector3. This is the point in space that the camera is looking at. ```Java public abstract Vector3 getTarget() ``` -------------------------------- ### TooltipContainerBase Constructor with Context, Attributes, and Style Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.modifiers.behaviors.TooltipContainerBase Creates a new instance of the TooltipContainerBase class with context, attributes, and a default style attribute. This provides comprehensive control over the tooltip container's creation and appearance. ```java public TooltipContainerBase(Context context, AttributeSet attrs, int defStyleAttr) ``` -------------------------------- ### Get Renderable Series (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.ISciPieChartSurface Gets the collection of IPieRenderableSeries that are currently drawn on the ISciPieChartSurface. This is fundamental for managing the visual elements of the pie chart. ```java public abstract PieRenderableSeriesCollection getRenderableSeries() ``` -------------------------------- ### SeriesTooltipCore Implements Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.tooltips.SeriesTooltipCore Lists the interfaces implemented by the SeriesTooltipCore class. ```APIDOC ## Implements * **ISeriesTooltipCore** * **ICleanable** * **IAttachable** * **IThemeable** ``` -------------------------------- ### Start Stopwatch (Java) Source: https://www.scichart.com/documentation/android/current/api/core/com.scichart.core.utility.Stopwatch Starts the Stopwatch instance, beginning the time measurement. If the stopwatch is already running, this action may not have an effect. ```java public void start() ``` -------------------------------- ### BaseRenderableSeries3D Constructors Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.renderableSeries.XyzRenderableSeries3DBase Provides details on how to instantiate the BaseRenderableSeries3D class. ```APIDOC ## XyzRenderableSeries3DBase(renderableSeries.XyzRenderPassData3D, renderableSeries.BaseRenderableSeriesSceneEntity3D) ### Description Creates a new instance of XyzRenderableSeries3DBase class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (Constructor) Instance of XyzRenderableSeries3DBase #### Response Example N/A ## BaseRenderableSeries3DBase(renderableSeries.XyzRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity) ### Description Creates a new instance of XyzRenderableSeries3DBase class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (Constructor) Instance of XyzRenderableSeries3DBase #### Response Example N/A ``` -------------------------------- ### WaterfallSeriesTooltip3D Constructor Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.renderableSeries.tooltips.WaterfallSeriesTooltip3D Initializes a new instance of the WaterfallSeriesTooltip3D class. This constructor takes the application context and detailed information about the 3D waterfall series to be displayed in the tooltip. It is essential for setting up the tooltip's initial state and data. ```java public WaterfallSeriesTooltip3D(Context context, renderableSeries.hitTest.WaterfallSeriesInfo3D seriesInfo) ``` -------------------------------- ### Get Waterfall Chart Y Color Mapping (Java) Source: https://www.scichart.com/documentation/android/current/api/charting3d/com.scichart.charting3d.visuals.renderableSeries.waterfall.WaterfallRenderableSeries3D Gets the color mapping used for filling the slices of a waterfall chart based on Y-axis values. It returns a renderableSeriesMeshColorPalette object. ```java public final renderableSeriesMeshColorPalette getYColorMapping() // Returns: // renderableSeriesMeshColorPalette: The current Y mapping ``` -------------------------------- ### LineAnnotationBase Constructors (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.annotations.LineAnnotationBase Provides documentation for the different constructors of the LineAnnotationBase class, used for initializing line annotations with varying parameters including context, attributes, and style information. ```java protected LineAnnotationBase(Context context, AttributeSet attrs) protected LineAnnotationBase(Context context, AttributeSet attrs, int defStyleAttr) protected LineAnnotationBase(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) ``` -------------------------------- ### Get X Axis ID (Java) Source: https://www.scichart.com/documentation/android/current/api/charting/com.scichart.charting.visuals.renderableSeries.IRenderableSeries Gets the identifier string of the X-axis associated with this renderable series. This is useful when multiple axes are present in the chart. ```java public abstract String getXAxisId() ```