TTMSFNCChartSerie Class
Represents a single chart series, defining its type, data points, and all visual and behavioral settings.
API unit family: TMSFNCChart
Inherits from: TCollectionItem
Syntax
TTMSFNCChartSerie = class(TCollectionItem)
Properties
| Name | Description |
|---|---|
| AnimationFactor | Controls the speed of the entry animation; higher values produce slower animation. |
| AnimationFlow | When True, the animation flows continuously; when False, it steps discretely. |
| AutoXRange | Controls how the x-axis range is calculated for this series. |
| AutoYRange | Controls how the y-axis range is calculated for this series. |
| Bar | Bar width and spacing settings for bar chart types. |
| ChartType | Determines the visual presentation type of this series. |
| Crosshair | Per-series crosshair appearance settings including line strokes and value label styles. |
| DataInteger | Arbitrary integer value for associating application data with this series. |
| DataObject | Arbitrary object reference for associating application data with this series. |
| DataString | Arbitrary string value for associating application data with this series. |
| Enable3D | When True, the series is rendered with a 3D offset effect using Offset3DX and Offset3DY. |
| Fill | Fill settings for the series area, bars, and markers. |
| GroupIndex | Group index used to combine this series with others into a stacked bar or area group; series sharing the same index are stacked together. |
| Labels | Point label display settings, including format, font, and visibility. |
| Legend | Per-series legend overlay settings, which can be positioned independently from the chart legend. |
| LegendText | Text shown in the chart legend for this series. |
| LogarithmicX | When True, the x-axis uses a logarithmic scale for this series. |
| LogarithmicXBase | Logarithmic base for the x-axis scale; default is 10. |
| LogarithmicY | When True, the y-axis uses a logarithmic scale for this series. |
| LogarithmicYBase | Logarithmic base for the y-axis scale; default is 10. |
| Markers | Data point marker settings, including shape, size, fill, and stroke. |
| MaxX | Fixed maximum x-value when AutoXRange is arDisabled. |
| MaxXOffsetPercentage | Additional percentage added above the auto-calculated x maximum to create padding. |
| MaxY | Fixed maximum y-value when AutoYRange is arDisabled. |
| MaxYOffsetPercentage | Additional percentage added above the auto-calculated y maximum to create padding. |
| MinX | Fixed minimum x-value when AutoXRange is arDisabled. |
| MinXOffsetPercentage | Additional percentage subtracted below the auto-calculated x minimum to create padding. |
| MinY | Fixed minimum y-value when AutoYRange is arDisabled. |
| MinYOffsetPercentage | Additional percentage subtracted below the auto-calculated y minimum to create padding. |
| Mode | Determines how the series interprets its x-values; statistical distributes points evenly, mathematical uses numeric coordinates. |
| MultiPoint | OHLC and candlestick appearance settings including increase and decrease colors. |
| Offset3DX | Horizontal pixel offset for the 3D depth effect when Enable3D is True. |
| Offset3DY | Vertical pixel offset for the 3D depth effect when Enable3D is True. |
| Pie | Pie layout and sweep settings for pie, donut, and sized-pie chart types. |
| Points | Collection of data points for this series. |
| Revert | When True, the series data is displayed in reverse point order. |
| ShowInLegend | When True, this series appears as an item in the chart legend. |
| Stroke | Stroke settings for lines, bar borders, and marker outlines. |
| Tag | User-defined integer tag for identifying the series in event handlers. |
| Visible | When True, the series is drawn; when False, it is hidden and excluded from auto-range calculation. |
| XGrid | X-axis grid line settings for this series. |
| XValues | X-axis tick value, label, and smart label configuration for this series. |
| YGrid | Y-axis grid line settings for this series. |
| YValues | Y-axis tick value, label, and smart label configuration for this series. |
| ZeroReferenceValue | Y-value at which the series baseline is drawn; default 0 means bars and areas extend from the x-axis. |
Methods
| Name | Description |
|---|---|
| AddMultiPoint | Adds an OHLC or candlestick point with open, high, low, close values; returns the new point. |
| AddPoint | Adds a point with a primary y-value and optional color and legend text; returns the new point. |
| AddSecondPoint | Adds a band point with primary and secondary y-values; returns the new point. |
| AddVariablePoint | Adds a point with a primary y-value and a variable radius value for ctVariableRadiusPie; returns the new point. |
| AddXYPoint | Adds a scatter point with explicit x and y coordinates; returns the new point. |
| Animate | Starts the built-in entry animation for this series. |
| AppendFromDataArray | Appends points from a y-values array without removing existing points. |
| AppendFromDataArrayEx | Appends points from y and optional secondary/variable value arrays without removing existing points. |
| AppendFromMultiPointDataArray | Appends OHLC or box plot data from separate value arrays without removing existing points. |
| Chart | Returns the owning TTMSFNCChart instance. Returns the owning chart instance. |
| DrawLines | Returns the list of line draw descriptors calculated for the last render pass. |
| DrawMultiPoints | Returns the list of multi-point draw descriptors calculated for the last render pass. |
| DrawPoints | Returns the list of marker draw descriptors calculated for the last render pass. |
| DrawRects | Returns the list of bar/rect draw descriptors calculated for the last render pass. |
| DrawSlices | Returns the list of pie/spider slice draw descriptors calculated for the last render pass. |
| GetEffectiveXAngle | Returns the effective x-axis label rotation angle in degrees, accounting for smart label auto-rotate. |
| GetEffectiveYAngle | Returns the effective y-axis label rotation angle in degrees, accounting for smart label auto-rotate. |
| GetPoint | Returns the point data at the specified zero-based index as a TTMSFNCChartPointVirtual snapshot. |
| GetPointsCount | Returns the number of data points in this series, including virtual points when in virtual mode. |
| GetXOffset | Returns the canvas x-offset of this series' plot area within the chart control. |
| LoadFromDataArray | Replaces all points with data from a y-values array; optional x-values and x-labels arrays. |
| LoadFromDataArrayEx | Replaces all points with data from y and optional secondary/variable value arrays. |
| LoadFromMultiPointDataArray | Replaces all points with OHLC or box plot data from separate value arrays. |
| ValueToX | Converts a data value to a canvas x-coordinate using this series' x-scale. |
| ValueToY | Converts a data value to a canvas y-coordinate using this series' y-scale. |
| XMax | Returns the maximum x data value after applying auto-range calculation. |
| XMin | Returns the minimum x data value after applying auto-range calculation. |
| XScale | Returns the horizontal pixel-per-unit scale factor calculated for the last render pass. |
| XToValue | Converts a canvas x-coordinate to a data value using this series' x-scale. |
| XYToArea | Returns True if canvas coordinates (X, Y) fall within the filled area of this series. |
| XYToBar | Returns the chart point whose bar rectangle contains canvas coordinates (X, Y), or nil when not found. |
| XYToBarVirtual | Finds the bar under canvas coordinates in virtual mode; returns True and populates APoint on success. |
| XYToClosestDrawPoint | Finds the nearest drawn point marker to canvas coordinates (X, Y); returns True and populates ADrawPoint on success. |
| XYToLegendItem | Returns the index of the legend item at canvas coordinates (X, Y), or -1 when not found. |
| XYToPoint | Returns the chart point whose marker is under canvas coordinates (X, Y), or nil when not found. |
| XYToPointVirtual | Finds the virtual point at canvas coordinates in virtual mode; returns True and populates APoint on success. |
| XYToSlice | Returns the chart point whose pie slice contains canvas coordinates (X, Y), or nil when not found. |
| XYToSliceVirtual | Finds the pie slice under canvas coordinates in virtual mode; returns True and populates APoint on success. |
| YMax | Returns the maximum y data value after applying auto-range calculation. |
| YMin | Returns the minimum y data value after applying auto-range calculation. |
| YScale | Returns the vertical pixel-per-unit scale factor calculated for the last render pass. |
| YToValue | Converts a canvas y-coordinate to a data value using this series' y-scale. |