Skip to content
ChartForgeX

API Reference

Struct

ChartSeriesId

Edit on GitHub
Namespace ChartForgeX.Core
Assembly ChartForgeX
Source ChartSeriesId.cs:14
Base ValueType
Implements
IEquatable<ChartSeriesId>
Modifiers sealed

A stable series identity independent of its display name and position in a chart.

Inheritance

  • ValueType
  • ChartSeriesId

Remarks

Explicit IDs can identify equivalent series across charts. Automatic IDs belong to one chart and are never synchronization keys.

Usage

Explore 62 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Accepted by parameters 59

Constructors

public ChartSeriesId(String value) #
ChartSeriesId.cs:14

Creates an explicit identity. The cfx:auto: namespace is reserved for chart-owned IDs.

Parameters

value System.String requiredposition: 0
A nonempty, case-sensitive identifier. Leading and trailing whitespace is removed.

Methods

Equals 2 overloads
public Boolean Equals(ChartSeriesId other) #
ChartSeriesId.cs:34
Returns: Boolean

Compares two series identities ordinally.

Parameters

other ChartForgeX.Core.ChartSeriesId requiredposition: 0
public override Boolean Equals(Object? obj) #
ChartSeriesId.cs:36
Returns: Boolean

Compares identities ordinally when obj is a ChartSeriesId.

Parameters

obj System.Object? requiredposition: 0
public override Int32 GetHashCode() #
ChartSeriesId.cs:38
Returns: Int32

Returns an ordinal hash code of the identity value.

public static Boolean op_Equality(ChartSeriesId left, ChartSeriesId right) #
ChartSeriesId.cs:42
Returns: Boolean

Compares two case-sensitive series identities.

Parameters

left ChartForgeX.Core.ChartSeriesId requiredposition: 0
right ChartForgeX.Core.ChartSeriesId requiredposition: 1
public static Boolean op_Inequality(ChartSeriesId left, ChartSeriesId right) #
ChartSeriesId.cs:44
Returns: Boolean

Compares two case-sensitive series identities.

Parameters

left ChartForgeX.Core.ChartSeriesId requiredposition: 0
right ChartForgeX.Core.ChartSeriesId requiredposition: 1
public override String ToString() #
ChartSeriesId.cs:40
Returns: String

Returns the identity value.

Properties

public String Value { get; } #
ChartSeriesId.cs:25

Gets the nonempty identifier. A default struct is invalid until constructed explicitly.

public Boolean IsAutomatic { get; } #
ChartSeriesId.cs:28

Gets whether this ID was allocated within a chart instead of supplied for cross-chart synchronization.