API Reference
ChartSeries
Represents one named series of points in a chart.
Inheritance
- Object
- ChartSeries
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method RadialValueScale.Create
Constructors
ChartSeries(System.String name, ChartForgeX.Core.ChartSeriesKind kind, System.Collections.Generic.IEnumerable{ChartForgeX.Primitives.ChartPoint} points) #Initializes a new instance of the ChartSeries class.
Parameters
- name System.String
- The display name shown in legends.
- kind ChartForgeX.Core.ChartSeriesKind
- The series rendering kind.
- points System.Collections.Generic.IEnumerable{ChartForgeX.Primitives.ChartPoint}
- The ordered data points.
Methods
UseAutomaticInteractionKey() #Uses the series name as the automatic interactive synchronization key.
Returns
The current series.
UseChartDataLabelPlacement() #Clears the series-specific data-label placement and uses the chart-level placement.
Returns
The current series.
UseChartDataLabels() #Clears the series-specific data-label visibility override and uses the chart-level setting.
Returns
The current series.
UseDefaultSliceOffset(System.Int32 pointIndex) #Clears the pie/donut slice offset ratio for one point.
Parameters
- pointIndex System.Int32
- The zero-based point index.
Returns
The current series.
UseFormattedPointLabel(System.Int32 pointIndex) #Clears the data label for one point so the formatted point value is used.
Parameters
- pointIndex System.Int32
- The zero-based point index.
Returns
The current series.
UseSeriesColor(System.Int32 pointIndex) #Clears the color for one point so the series color or theme palette is used.
Parameters
- pointIndex System.Int32
- The zero-based point index.
Returns
The current series.
UseSeriesDataLabelStyle(System.Int32 pointIndex) #Clears point-specific data-label styling for one point.
Parameters
- pointIndex System.Int32
- The zero-based point index.
Returns
The current series.
UseSeriesFillPattern(System.Int32 pointIndex) #Clears the texture overlay for one point so the series fill pattern is used.
Parameters
- pointIndex System.Int32
- The zero-based point index.
Returns
The current series.
UseThemeColor() #Clears the series color so the chart theme palette is used.
Returns
The current series.
UseThemeMarkerRadius() #Clears the series marker override and uses the chart theme marker radius.
WithColor(System.Nullable{ChartForgeX.Primitives.ChartColor} color) #Sets the series color. Pass null to use the chart theme palette.
Parameters
- color System.Nullable{ChartForgeX.Primitives.ChartColor}
- The series color, or null to use the theme palette.
Returns
The current series.
WithDataLabelPlacement(ChartForgeX.Core.ChartDataLabelPlacement placement) #Sets a series-specific data-label placement.
Parameters
- placement ChartForgeX.Core.ChartDataLabelPlacement
- The preferred placement.
Returns
The current series.
WithDataLabels(System.Boolean visible) #Sets a series-specific data-label visibility override.
Parameters
- visible System.Boolean
- A value indicating whether labels should render for this series.
Returns
The current series.
WithDataLabelStyle(System.Action{ChartForgeX.Typography.TextStyleOverride} configure) #Configures series-specific data-label styling.
Parameters
- configure System.Action{ChartForgeX.Typography.TextStyleOverride}
- The style configuration callback.
Returns
The current series.
WithFillPattern(ChartForgeX.Core.ChartFillPattern pattern) #Sets the texture overlay applied to filled marks in this series.
Parameters
- pattern ChartForgeX.Core.ChartFillPattern
- The fill pattern.
Returns
The current series.
WithInteractionKey(System.String key) #Sets the stable semantic key used to synchronize this series across interactive charts.
Parameters
- key System.String
- The semantic key, or null to use the series name.
Returns
The current series.
WithLegendEntry(System.Boolean visible) #Sets whether the series should appear in the chart legend.
Parameters
- visible System.Boolean
- True to show the series in legends; otherwise false.
Returns
The current series.
WithMarkerRadius(System.Double arg1) #Overrides the marker radius for this series. Use zero to suppress optional line and area markers.
Parameters
- arg1 System.Double
WithPointColor(System.Int32 pointIndex, System.Nullable{ChartForgeX.Primitives.ChartColor} color) #Sets the color for one point. Pass null to use the series color or theme palette.
Parameters
- pointIndex System.Int32
- The zero-based point index.
- color System.Nullable{ChartForgeX.Primitives.ChartColor}
- The point color, or null to use the series color.
Returns
The current series.
WithPointColor(System.Int32 pointIndex, System.String hex) #Sets the color for one point from hex notation.
Parameters
- pointIndex System.Int32
- The zero-based point index.
- hex System.String
- The point color in #RGB, #RGBA, #RRGGBB, or #RRGGBBAA notation.
Returns
The current series.
WithPointColorRange(System.Int32 startPointIndex, System.Int32 count, System.Nullable{ChartForgeX.Primitives.ChartColor} color) #Sets the same color for a contiguous point range.
Parameters
- startPointIndex System.Int32
- The zero-based first point index.
- count System.Int32
- The number of points to color.
- color System.Nullable{ChartForgeX.Primitives.ChartColor}
- The point color, or null to use the series color.
Returns
The current series.
WithPointColorRange(System.Int32 startPointIndex, System.Int32 count, System.String hex) #Sets the same color for a contiguous point range from hex notation.
Parameters
- startPointIndex System.Int32
- The zero-based first point index.
- count System.Int32
- The number of points to color.
- hex System.String
- The point color in #RGB, #RGBA, #RRGGBB, or #RRGGBBAA notation.
Returns
The current series.
WithPointDataLabelStyle(System.Int32 pointIndex, System.Action{ChartForgeX.Typography.TextStyleOverride} configure) #Configures data-label styling for one point.
Parameters
- pointIndex System.Int32
- The zero-based point index.
- configure System.Action{ChartForgeX.Typography.TextStyleOverride}
- The style configuration callback.
Returns
The current series.
WithPointFillPattern(System.Int32 pointIndex, System.Nullable{ChartForgeX.Core.ChartFillPattern} pattern) #Sets the texture overlay for one point. Pass null to use the series fill pattern.
Parameters
- pointIndex System.Int32
- The zero-based point index.
- pattern System.Nullable{ChartForgeX.Core.ChartFillPattern}
- The point fill pattern, or null to use the series fill pattern.
Returns
The current series.
WithPointLabel(System.Int32 pointIndex, System.String label) #Sets the data label for one point.
Parameters
- pointIndex System.Int32
- The zero-based point index.
- label System.String
- The data label text.
Returns
The current series.
WithPointSliceOffset(System.Int32 pointIndex, System.Double ratio) #Sets the pie/donut slice offset ratio for one point.
Parameters
- pointIndex System.Int32
- The zero-based point index.
- ratio System.Double
- The offset ratio from zero to 0.35 of the outer radius.
Returns
The current series.
WithSemanticRole(System.String role) #Sets an optional semantic role emitted by capable renderers.
Parameters
- role System.String
- The semantic role, or null to use the renderer default.
Returns
The current series.
WithSmooth(System.Boolean smooth) #Sets whether capable renderers should smooth connected line segments.
Parameters
- smooth System.Boolean
- True to smooth connected segments; otherwise false.
Returns
The current series.
WithStrokeWidth(System.Double width) #Sets the stroke width for line and area series.
Parameters
- width System.Double
- The stroke width in pixels.
Returns
The current series.
Properties
Name #Gets the display name shown in legends.
InteractionKey #Gets or sets the stable semantic key used to synchronize this series across interactive charts. When unset, capable adapters use Name. Digits-only values are reserved for local series ordinals.
Kind #Gets the series rendering kind.
Points #Gets the ordered data points in the series.
SourcePointCount #Gets the number of source points supplied before explicit decimation.
DecimationMode #Gets the explicit decimation algorithm, or null when the series was not created through a decimating API.
SourcePointIndices #Gets the source index represented by each retained point after explicit decimation.
IsDecimated #Gets whether this series renders fewer points than its source sequence.
Color #Gets or sets the series color. When null, the chart theme palette is used.
PointColors #Gets optional point-level colors. Null entries fall back to the series color or theme palette.
FillPattern #Gets or sets the texture overlay applied to filled marks in this series.
PointFillPatterns #Gets optional point-level fill patterns. Null entries fall back to the series fill pattern.
PointValues #Gets optional point-level numeric values for specialized renderers that need per-point metadata.
HeatmapColumnCount #Gets or sets the full heatmap column span for masked matrix rows.
HistogramBinLayout #Gets or sets the shared histogram layout whose numeric bounds determine this bar series geometry.
PointLabels #Gets optional point-level data labels. Null entries use the formatted point value.
PointDataLabelStyles #Gets optional point-level data-label styles. Null entries fall back to the series or chart data-label style.
PointSliceOffsets #Gets optional point-level pie/donut slice offset ratios. Zero entries use the default slice position.
RadialLayers #Gets radial arc layer definitions for layered radial charts.
Smooth #Gets or sets a value indicating whether capable renderers should smooth connected line segments.
ShowInLegend #Gets or sets a value indicating whether the series should appear in the chart legend.
SemanticRole #Gets or sets an optional semantic role emitted by capable renderers.
ShowDataLabels #Gets or sets a series-specific data-label override. When null, the chart-level setting is used.
DataLabelPlacement #Gets or sets the series-specific data-label placement. When null, the chart-level placement is used.
DataLabelStyle #Gets the series-specific data-label style. When empty, the chart-level data-label style is used.
YAxis #Gets or sets the vertical axis used for cartesian rendering.
StrokeWidth #Gets or sets the stroke width for line and area series.
MarkerRadius #Gets or sets the optional marker-radius override for this series. Null uses the chart theme; zero suppresses optional line and area markers without affecting specialized mark types.