XCharts

https://xcharts-team.github.io/docs
Admin
XCharts is a charting and visualization library for creating interactive data visualizations and...
Tokens:74,228
Snippets:564
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get LineChart component and initialize in Unity

Source: https://xcharts-team.github.io/docs/tutorial01

Retrieves or creates a LineChart component on a gameObject and initializes it. This is the first step when programmatically adding a chart to your scene. The Init() method sets up the chart with default configuration.

```csharp
var chart = gameObject.GetComponent<LineChart>();
if (chart == null)
{
    chart = gameObject.AddComponent<LineChart>();
    chart.Init();
}
```

--------------------------------

### Add Component to Serie with C#

Source: https://xcharts-team.github.io/docs/tutorial01

Shows how to add additional components like AreaStyle and LabelStyle to a Serie using EnsureComponent() method. Includes example of setting label offset properties.

```csharp
serie.EnsureComponent<AreaStyle>();

var label = serie1.EnsureComponent<LabelStyle>();
label.offset = new Vector3(0,20,0);
```

--------------------------------

### Add and Configure New Serie with C#

Source: https://xcharts-team.github.io/docs/tutorial01

Shows how to create a new Serie (Pie chart type) and configure its properties including center position, radius, animation, and styling. This method is used when adding a new Serie to the chart.

```csharp
var serie = chart.AddSerie<Pie>();
serie.center[0] = 0.5f;
serie.center[1] = 0.5f;
serie.radius[0] = 80;
serie.radius[1] = 90;
serie.animation.dataChangeEnable = true;
serie.roundCap = true;
```

--------------------------------

### Populate LineChart with sample data in Unity

Source: https://xcharts-team.github.io/docs/tutorial01

Adds 10 data points to the chart with X-axis labels (x0-x9) and random Y-axis values between 10-20. This demonstrates the typical pattern for populating chart data programmatically. X-axis data should be added only once for multiple series.

```csharp
for (int i = 0; i < 10; i++)
{
    chart.AddXAxisData("x" + i);
    chart.AddData(0, Random.Range(10, 20));
}
```

--------------------------------

### Modify Existing Serie Parameters with C#

Source: https://xcharts-team.github.io/docs/tutorial01

Demonstrates retrieving an existing Serie and modifying its properties. This approach uses GetSerie() to access already-existing series data before making configuration changes.

```csharp
var serie = chart.GetSerie<Pie>();
serie.center[0] = 0.5f;
serie.center[1] = 0.5f;
serie.radius[0] = 80;
serie.radius[1] = 90;
serie.animation.dataChangeEnable = true;
serie.roundCap = true;
```

--------------------------------

### Configure XAxis and YAxis in LineChart

Source: https://xcharts-team.github.io/docs/tutorial01

Sets up both X and Y axes with specific properties. XAxis is configured as Category type with boundary gap and split number, while YAxis is configured as Value type. These define how data is displayed on the chart.

```csharp
var xAxis = chart.EnsureChartComponent<XAxis>();
xAxis.splitNumber = 10;
xAxis.boundaryGap = true;
xAxis.type = Axis.AxisType.Category;

var yAxis = chart.EnsureChartComponent<YAxis>();
yAxis.type = Axis.AxisType.Value;
```

--------------------------------

### Configure LineChart title component in Unity

Source: https://xcharts-team.github.io/docs/tutorial01

Adds or retrieves a Title component from the chart and sets its text. The EnsureChartComponent method guarantees the component exists before setting properties.

```csharp
var title = chart.EnsureChartComponent<Title>();
title.text = "Simple Line";
```

--------------------------------

### Modify SerieData Parameters with C#

Source: https://xcharts-team.github.io/docs/tutorial01

Demonstrates how to add new data to a chart and modify individual SerieData properties including radius and ItemStyle components. Shows both adding new data and retrieving existing data.

```csharp
var serieData = chart.AddData(0, 20);
//var serieData = serie.GetSerieData(0); //从已有数据中获取
serieData.radius = 10;

var itemStyle = serieData.EnsureComponent<ItemStyle>(); //给数据项添加ItemStyle组件
itemStyle.color = Color.blue;
```

--------------------------------

### Add XCharts package via manifest.json in Unity

Source: https://xcharts-team.github.io/docs/tutorial01

Manually adds XCharts dependency to Unity's manifest.json file for Package Manager integration. This method is used when the 'Add package from git URL' option is unavailable. The URL points to the XCharts GitHub repository.

```json
"com.monitor1394.xcharts": "https://github.com/XCharts-Team/XCharts.git"
```

--------------------------------

### Dynamically Update Chart Data

Source: https://xcharts-team.github.io/docs/faq

Update chart data dynamically by referencing the provided C# examples, such as `Example13_LineSimple.cs`. The XCharts API documentation provides details on relevant methods for data manipulation and chart updates.

```csharp
// Example of clearing data and adding new series
chart.ClearData();
chart.AddSeries<Line>(new SeriesBase
{
    name = "New Series",
    data = new double[] { 10, 20, 30 }
});
```

--------------------------------

### Get XCharts Package Full Path in C#

Source: https://xcharts-team.github.io/docs/api

Static method returning the complete file system path to the XCharts package. Useful for resource location and asset management operations.

```csharp
public static string GetPackageFullPath()
```

--------------------------------

### Configure Tooltip and Legend visibility in LineChart

Source: https://xcharts-team.github.io/docs/tutorial01

Controls the display of Tooltip and Legend components in the chart. Tooltip shows data on hover, while Legend displays series information. Both visibility states are controlled via the show property.

```csharp
var tooltip = chart.EnsureChartComponent<Tooltip>();
tooltip.show = true;

var legend = chart.EnsureChartComponent<Legend>();
legend.show = false;
```

--------------------------------

### DataZoomContext Start Value and Dimensions

Source: https://xcharts-team.github.io/docs/api

Defines the starting value for the data zoom range and the dimensions of the data zoom area. 'startValue' represents the beginning of the zoomed data range, and 'width', 'x', and 'y' define the visible area for the zoom. These are fundamental for configuring the zoom behavior.

```csharp
public double startValue
public float width
public float x
public float y
```

--------------------------------

### Get XCharts Full Version String in C#

Source: https://xcharts-team.github.io/docs/api

Static property providing the complete version string of XCharts framework. Returns a string with version information including build details.

```csharp
public static string fullVersion
```

--------------------------------

### Get XCSettings Asset Path in C#

Source: https://xcharts-team.github.io/docs/api

Static method returning the file system path to the XCSettings asset file. Used for asset management and configuration file operations.

```csharp
public static string GetSettingAssetPath()
```

--------------------------------

### AnimationInfo Class - Core Animation Configuration

Source: https://xcharts-team.github.io/docs/api

Base class for animation configuration parameters supporting delay, duration, easing, and callbacks. Provides methods for animation lifecycle management (start, pause, resume, end). Supports delegate functions for dynamic delay and duration calculations.

```csharp
class AnimationInfo
{
    public float delay;                              // Animation start delay in seconds
    public AnimationDelayFunction delayFunction;     // Delegate for dynamic delay calculation
    public float duration;                           // Animation duration in seconds
    public AnimationDurationFunction durationFunction; // Delegate for dynamic duration
    public bool enable;                              // Enable/disable animation
    public float speed;                              // Animation speed (overrides duration if set)
    public bool reverse;                             // Enable reverse animation
    public Action OnAnimationStart;                  // Start callback
    public Action OnAnimationEnd;                    // End callback
    
    public void Start(bool reset = true) { }         // Start animation
    public void Pause() { }                          // Pause animation
    public void Resume() { }                         // Resume animation
    public void End() { }                            // End animation
    public void Reset() { }                          // Reset animation state
    public bool Init(float curr, float dest, int totalPointIndex) { }  // Initialize animation
    public bool IsFinish() { }                       // Check if animation finished
    public bool IsInDelay() { }                      // Check if in delay phase
    public float GetIndexDelay(int dataIndex) { }   // Get delay for specific data index
    public bool IsInIndexDelay(int dataIndex) { }   // Check if index is in delay
}
```

--------------------------------

### XCThemeMgr - Get Theme List

Source: https://xcharts-team.github.io/docs/api

Retrieves a complete list of all Theme objects available in the theme manager. Returns a collection of Theme instances that can be enumerated or searched.

```csharp
public static List<Theme> GetThemeList()
```

--------------------------------

### XCThemeMgr - Get Theme Asset Path

Source: https://xcharts-team.github.io/docs/api

Returns the file system path to the assets folder for a specified theme. Used to locate theme-related resources and configuration files by theme name.

```csharp
public static string GetThemeAssetPath(string themeName)
```

--------------------------------

### Check XCSettings Asset File Existence in C#

Source: https://xcharts-team.github.io/docs/api

Static method to verify if the XCSettings asset file exists in the project. Returns boolean value. Used for validating configuration setup.

```csharp
public static bool ExistAssetFile()
```

--------------------------------

### DebugInfo Initialization and Update

Source: https://xcharts-team.github.io/docs/api

Provides methods for initializing and updating the debug information for a chart. 'Init' prepares the debug component with the associated chart, while 'Update' handles the logic for refreshing and displaying the debug metrics. These are core methods for the debug system.

```csharp
public void Init(BaseChart chart)
public void Update()
```

--------------------------------

### Clear chart data while preserving series in XCharts

Source: https://xcharts-team.github.io/docs/tutorial01

Clears only the data values from the chart while preserving the series structure and configuration. Recommended when series are pre-configured in the UI and only the data needs to be updated.

```csharp
chart.ClearData();
```

--------------------------------

### Create Chart Prefabs

Source: https://xcharts-team.github.io/docs/faq

Before creating a prefab, execute `Rebuild Chart Object` to refresh the chart's nodes and remove any redundant elements, ensuring a clean structure for the prefab.

```csharp
// In the Unity Editor, select the chart GameObject and click 'Rebuild Chart Object' button in the Inspector.
```

--------------------------------

### Set LineChart size dynamically in Unity

Source: https://xcharts-team.github.io/docs/tutorial01

Sets the chart dimensions to 580x300 pixels. Can be done via code, through direct rectTransform manipulation, or in the Inspector panel. This controls the rendering area of the chart.

```csharp
chart.SetSize(580, 300);
```

--------------------------------

### GaugeChart: Creating Default Barometer Gauge Chart (C#)

Source: https://xcharts-team.github.io/docs/gauge

This C# code demonstrates how to create a default barometer-style gauge chart using the GaugeChart class. It initializes the chart and calls the `DefaultBarometerGaugeChart` method. This is useful for displaying atmospheric pressure or similar metrics.

```csharp
using XCharts.Runtime.Gauges;

// Assuming 'chart' is an instance of BaseChart or a derived class
GaugeChart gaugeChart = chart as GaugeChart;
if (gaugeChart != null)
{
    gaugeChart.DefaultBarometerGaugeChart();
}
```

--------------------------------

### Chart Initialization and State Management

Source: https://xcharts-team.github.io/docs/api

Methods for initializing the chart and managing its internal state. This includes general initialization, initializing axis runtime data, and methods for serialization lifecycle events.

```csharp
public void Init(bool defaultChart = true)
public virtual void InitAxisRuntimeData(Axis axis)
public void OnAfterDeserialize()
public void OnBeforeSerialize()
public void Internal_CheckAnimation()
```

--------------------------------

### GaugeChart: Creating Default Progress Gauge Chart (C#)

Source: https://xcharts-team.github.io/docs/gauge

This C# code initializes a default progress gauge chart. The `DefaultProgressGaugeChart` method is called on a `GaugeChart` object, making it suitable for visualizing completion percentages or progress towards a goal.

```csharp
using XCharts.Runtime.Gauges;

// Assuming 'chart' is an instance of BaseChart or a derived class
GaugeChart gaugeChart = chart as GaugeChart;
if (gaugeChart != null)
{
    gaugeChart.DefaultProgressGaugeChart();
}
```

--------------------------------

### Copy Settings Configuration - C#

Source: https://xcharts-team.github.io/docs/api

Copies global parameter settings from one Settings instance to another. Allows duplication of global chart configuration for template-based chart creation.

```csharp
public void Copy(Settings settings)
```

--------------------------------

### Modify Main Chart Component Parameters with C#

Source: https://xcharts-team.github.io/docs/tutorial01

Demonstrates how to access and modify chart component parameters such as Title and XAxis properties using EnsureChartComponent() method. This approach retrieves or creates the component if it doesn't exist, allowing direct property modification.

```csharp
var title = chart.EnsureChartComponent<Title>();
title.text = "Simple LineChart";
title.subText = "normal line";

var xAxis = chart.EnsureChartComponent<XAxis>();
xAxis.splitNumber = 10;
xAxis.boundaryGap = true;
xAxis.type = Axis.AxisType.Category;
```

--------------------------------

### Pie Chart API

Source: https://xcharts-team.github.io/docs/api

Documentation for the Pie chart and its configurations in XCharts.Runtime.

```APIDOC
## Pie Class

class in XCharts.Runtime / 继承自: Serie

### Description
Represents a serie for a pie chart.

### Properties
- **defaultColorBy** (SerieColorBy) - The default color-by setting for the pie serie.
- **titleJustForSerie** (bool) - Indicates if the title is specific to the serie.

### Methods
- **AddDefaultSerie**(BaseChart chart, string serieName) : Serie - Adds a default serie for the pie chart.
- **ConvertSerie**(Serie serie) : Pie - Converts a general serie to a Pie serie.
```

```APIDOC
## PieChart Class

class in XCharts.Runtime / 继承自: BaseChart

### Description
A pie chart used to display the proportion of different categories, with arc length reflecting data size.

### Methods
- **DefaultAreaRosePieChart**() : void - Configures a default area rose pie chart.
- **DefaultDonutPieChart**() : void - Configures a default donut pie chart.
- **DefaultLabelDonutPieChart**() : void - Configures a default donut pie chart with labels.
- **DefaultLabelPieChart**() : void - Configures a default pie chart with labels.
- **DefaultRadiusRosePieChart**() : void - Configures a default radius rose pie chart.
```

--------------------------------

### Create Default Pie Chart Variations - C#

Source: https://xcharts-team.github.io/docs/api

Methods to initialize pie charts with predefined configurations including rose pie, donut, and labeled variants.

```csharp
public void DefaultAreaRosePieChart()
public void DefaultDonutPieChart()
public void DefaultLabelDonutPieChart()
public void DefaultLabelPieChart()
public void DefaultRadiusRosePieChart()
```

--------------------------------

### Tooltip Methods and Callbacks (C#)

Source: https://xcharts-team.github.io/docs/api

This snippet outlines the key methods and callback events available for the Tooltip component in XCharts.Runtime. These are used for managing tooltip state, handling user interactions, and dynamically updating tooltip content.

```csharp
public System.Action<int> onClickIndex;
public void AddSerieDataIndex(int serieIndex, int dataIndex);
public override void ClearComponentDirty();
public override void ClearData();
public void ClearSerieDataIndex();
public LabelStyle GetContentLabelStyle(int index);
public bool IsActive();
public bool isAnySerieDataIndex();
public bool IsSelected(int index);
public bool IsTriggerAxis();
public bool IsTriggerItem();
public void KeepTop();
public void SetActive(bool flag);
public void SetContentActive(bool flag);
```

--------------------------------

### 转换现有系列为3D柱状图 - XCharts

Source: https://xcharts-team.github.io/docs/bar3d

使用`Bar3D.ConvertSerie(Serie serie)`静态方法将一个现有的`Serie`对象转换为`Bar3D`类型的系列。这允许将已有的图表系列对象转换为3D柱状图。

```csharp
using XCharts.Runtime.Bar3Ds;

// ... 在某个类或方法中
Serie existingSerie = /* 获取一个已存在的Serie实例 */;

Bar3D convertedSerie = Bar3D.ConvertSerie(existingSerie);

if (convertedSerie != null)
{
    // 转换成功，convertedSerie 现在是 Bar3D 类型
}
```

--------------------------------

### Clear chart data and add Line serie in XCharts

Source: https://xcharts-team.github.io/docs/tutorial01

Removes all existing data and series from the chart, then adds a new Line serie named 'line'. This is used when you want to completely rebuild the chart structure. For keeping existing series structure, use ClearData() instead.

```csharp
chart.RemoveData();
chart.AddSerie<Line>("line");
```

--------------------------------

### Get Painter and Realtime Sort Serie

Source: https://xcharts-team.github.io/docs/api

Methods to retrieve the chart's painter for a given index and to get a realtime sorted series for a specific grid index.

```csharp
public Painter GetPainter(int index)
public Serie GetRealtimeSortSerie(int gridIndex)
```

--------------------------------

### 添加默认金字塔系列 (C#)

Source: https://xcharts-team.github.io/docs/pyramid

使用Pyramid.AddDefaultSerie()方法向BaseChart添加一个默认的金字塔系列。此方法需要chart对象和系列名称作为参数。

```csharp
public static void AddDefaultSerie(BaseChart chart, string serieName)
{
    // Implementation to add a default pyramid serie
}
```

--------------------------------

### Get Specific Data Points

Source: https://xcharts-team.github.io/docs/api

Methods for retrieving specific data points from a Serie based on index and dimension. Includes functions to get XY data, Y data with names, and current Y data.

```csharp
public double GetData(int index, int dimension, DataZoom dataZoom = null)
public void GetXYData(int index, DataZoom dataZoom, out double xValue, out double yVlaue)
public void GetYData(int index, out double yData, out string dataName, DataZoom dataZoom = null)
public double GetYCurrData(int index, DataZoom dataZoom = null)
```

--------------------------------

### Configure XCSettings Language and Themes in C#

Source: https://xcharts-team.github.io/docs/api

Static properties for language selection and custom theme management. Includes lang property for localization and customThemes list for theme storage.

```csharp
public static Lang lang
public static List<Theme> customThemes
```

--------------------------------

### Get Serie Data and Properties

Source: https://xcharts-team.github.io/docs/api

Methods for retrieving various properties and data related to chart series. This includes getting specific series by index, their color, data zoom information, and min/max values. Some methods are generic and require a specific Serie type.

```csharp
public Serie GetSerie(int serieIndex)
public T GetSerie<T>(int serieIndex) where T : Serie
public Color32 GetItemColor(Serie serie)
public Color32 GetItemColor(Serie serie, SerieData serieData, int colorIndex)
public DataZoom GetXDataZoomOfSerie(Serie serie)
public DataZoom GetVisualMapOfSerie(Serie serie)
public virtual void GetSeriesMinMaxValue(Axis axis, int axisIndex, out double tempMinValue, out double tempMaxValue)
```

--------------------------------

### Initialize SubTitle Theme - C#

Source: https://xcharts-team.github.io/docs/api

Constructor for SubTitleTheme that creates a subtitle theme based on the specified ThemeType. Inherits from ComponentTheme and applies theme-specific styling.

```csharp
public SubTitleTheme(ThemeType theme) : base(theme)
```

--------------------------------

### Get Last Data from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves the last data point in the series.

```csharp
public double GetLastData()
```

--------------------------------

### Initialize Since Attribute - C#

Source: https://xcharts-team.github.io/docs/api

Constructor for the Since attribute that marks the API version when a feature was introduced. Takes a version string parameter for version tracking and documentation purposes.

```csharp
public Since(string version)
```

--------------------------------

### Get Data Zoom of Serie

Source: https://xcharts-team.github.io/docs/api

Retrieves the data zoom information for a specific series.

```csharp
public void GetDataZoomOfSerie(Serie serie, out DataZoom xDataZoom, out DataZoom yDataZoom)
```

--------------------------------

### Configure XCSettings Performance Parameters in C#

Source: https://xcharts-team.github.io/docs/api

Static properties for performance tuning including maximum painter count and editor data display settings. Controls rendering pipeline and debug information.

```csharp
public static int maxPainter
public static bool editorShowAllListData
```

--------------------------------

### Get Total Data from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves the total amount of data points available in the series.

```csharp
public double GetTotalData()
```

--------------------------------

### DataZoomTheme Copy and Constructor

Source: https://xcharts-team.github.io/docs/api

Defines methods for managing the theme of DataZoom components. The 'Copy' method allows for duplicating theme settings, while the constructor initializes a DataZoomTheme with a specified ThemeType. This is used for applying consistent visual styles to zoom components.

```csharp
public void Copy(DataZoomTheme theme)
public DataZoomTheme(ThemeType theme) : base(theme)
```

--------------------------------

### Get Label Dimensions from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves the height and width of the labels associated with the data series.

```csharp
public float GetLabelHeight()
public float GetLabelWidth()
```

--------------------------------

### Radar Chart API

Source: https://xcharts-team.github.io/docs/api

Documentation for Radar charts, including axes, coordinate systems, and configurations in XCharts.Runtime.

```APIDOC
## Radar Class

class in XCharts.Runtime / 继承自: Serie,INeedSerieContainer

### Description
Represents a serie for a radar chart.

### Properties
- **containerIndex** (int) - The index of the container for this serie.
- **containterInstanceId** (int) - The instance ID of the container for this serie.
- **defaultColorBy** (SerieColorBy) - The default color-by setting for the radar serie.
- **multiDimensionLabel** (bool) - Indicates if multi-dimension labels are enabled.

### Methods
- **AddDefaultSerie**(BaseChart chart, string serieName) : Serie - Adds a default serie for the radar chart.
```

```APIDOC
## RadarAxisTheme Class

class in XCharts.Runtime / 继承自: BaseAxisTheme

### Description
Theme settings for a radar axis.
```

```APIDOC
## RadarChart Class

class in XCharts.Runtime / 继承自: BaseChart

### Description
A radar chart used to display multivariate data, such as analyzing attributes of a football player. Relies on the radar component.

### Methods
- **DefaultCircleRadarChart**() : void - Configures a default circular radar chart.
```

```APIDOC
## RadarCoord Class

class in XCharts.Runtime / 继承自: CoordSystem,ISerieContainer

### Description
Radar coordinate component for radar charts. Only applicable to radar charts.

### Inner Classes
#### RadarCoord.PositionType

class in XCharts.Runtime

### Description
Display position.

### Enum Values
- **Vertice**: Display at the vertex.
- **Between**: Display between vertices.

#### RadarCoord.Shape

class in XCharts.Runtime

### Description
Radar chart drawing type, supporting 'Polygon' and 'Circle'.

### Enum Values
- **Polygon**: Radar chart drawing type, supporting 'Polygon' and 'Circle'.
- **Circle**: Radar chart drawing type, supporting 'Polygon' and 'Circle'.
```

```APIDOC
## RadarCoordContext Class

class in XCharts.Runtime / 继承自: MainComponentContext

### Description
Context for the radar coordinate system.

### Properties
- **center** (Vector3) - The specific center point of the radar chart in the container.
- **dataRadius** (float) - The radius of the data points.
- **isPointerEnter** (bool) - Whether the pointer is currently over the radar chart.
- **radius** (float) - The actual runtime radius of the radar chart.
```

```APIDOC
## RadarType Class

class in XCharts.Runtime

### Description
Type of radar chart.

### Enum Values
- **Multiple**: Multiple radar circles. Can draw multiple circles within one radar, where one serieData forms a circle (multi-dimensional data).
- **Single**: Single radar circle. Only one circle can be drawn per radar. Multiple serieData form a circle, with data taken from `data[1]`.
```

--------------------------------

### Add Data to SerieData

Source: https://xcharts-team.github.io/docs/api

Adds new data to the series, with options for animation style and a starting value.

```csharp
public void OnAdd(AnimationStyle animation, double startValue = 0)
```

--------------------------------

### Gauge Axis Line and Pointer Settings

Source: https://xcharts-team.github.io/docs/gauge

Detailed configuration for the gauge axis line, including background and stage colors, and properties for the gauge pointer.

```APIDOC
## Gauge Axis Line and Pointer Settings

### GaugeAxisLine

*   **Inherits from**: `BaseLine`

#### GaugeAxisLine.backgroundColor

*   **Type**: `Color32`
*   **Default**: `Color32(230, 235, 248, 255)`
*   **Description**: The background color of the progress bar part of the axis.

#### GaugeAxisLine.stageColor

*   **Type**: `List<StageColor>`
*   **Description**: A list of colors to be used for different stages of the gauge.

#### GaugeAxisLine.stageGradient

*   **Type**: `bool`
*   **Introduced**: `v3.4.0`
*   **Description**: Whether the stage colors should have a gradient transition.

### GaugePointer

*   **Description**: Configuration options for the gauge pointer.
*   **Inherits from**: `ChildComponent`

#### GaugePointer.autoColor

*   **Type**: `bool`
*   **Default**: `true`
*   **Description**: Automatically adjusts the pointer color.

#### GaugePointer.backExtraLength

*   **Type**: `float`
*   **Default**: `0.05f`
*   **Description**: The extra length extending from the back of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.backLength

*   **Type**: `float`
*   **Default**: `0.05f`
*   **Description**: The length extending from the back of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.bottomLeftLength

*   **Type**: `float`
*   **Default**: `0.025f`
*   **Description**: The length of the protrusion at the bottom-left of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.bottomRightLength

*   **Type**: `float`
*   **Default**: `0.025f`
*   **Description**: The length of the protrusion at the bottom-right of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.color

*   **Type**: `Color32`
*   **Description**: The color of the pointer.

#### GaugePointer.cornerRadius

*   **Type**: `float[]`
*   **Description**: An array specifying the corner radii for the pointer (top-left, top-right, bottom-right, bottom-left) in clockwise order.

#### GaugePointer.distance

*   **Type**: `float`
*   **Description**: The distance of the pointer from the center.

#### GaugePointer.length

*   **Type**: `float`
*   **Default**: `0.6f`
*   **Description**: The length of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.roundCap

*   **Type**: `bool`
*   **Description**: Whether the pointer should have a rounded cap.

#### GaugePointer.show

*   **Type**: `bool`
*   **Default**: `true`
*   **Description**: Whether to display the pointer.

#### GaugePointer.toColor

*   **Type**: `Color32`
*   **Description**: The end color of the pointer, used for gradients.

#### GaugePointer.topLeftLength

*   **Type**: `float`
*   **Default**: `0f`
*   **Description**: The length of the protrusion at the top-left of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.topRightLength

*   **Type**: `float`
*   **Default**: `0f`
*   **Description**: The length of the protrusion at the top-right of the pointer. Can be an absolute value or a percentage (0-1) of the radius.

#### GaugePointer.value

*   **Type**: `double`
*   **Introduced**: `v3.6.0`
*   **Description**: The value of the pointer. For clock-type gauges, this can be used to set the pointer's position.
```

--------------------------------

### Get Min/Max Data from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves the maximum or minimum data value in the series, with an option to consider inverse values.

```csharp
public double GetMaxData(bool inverse = false)
public double GetMinData(bool inverse = false)
```

--------------------------------

### 配置金字塔样式 (C#)

Source: https://xcharts-team.github.io/docs/pyramid

通过PyramidStyle类配置金字塔图的各种样式属性，如是否绘制顶部、底部点比例、颜色透明度等。这些配置项影响图表的视觉表现。

```csharp
public class PyramidStyle : ChildComponent
{
    public bool drawTop { get; set; }
    public float bottomPointRate { get; set; } // 3D mode
    public float labelLineMargin { get; set; }
    public float leftColorOpacity { get; set; } // 3D mode
    public float leftPointRate { get; set; } // 3D mode
    public float rightColorOpacity { get; set; } // 3D mode
    public float rightPointRate { get; set; } // 3D mode
    public bool show { get; set; }
    public float topColorOpacity { get; set; } // 3D mode
    public bool is3D { get; set; } // Added based on context, assuming '3D' implies a boolean property
}
```

--------------------------------

### Get Specific Data from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves a specific data point by index, optionally considering minimum and maximum bounds.

```csharp
public double GetData(int index, double min, double max)
```

--------------------------------

### Treemap配置 - 层级样式

Source: https://xcharts-team.github.io/docs/treemap

配置矩形树图各层级的样式参数。类型为LevelStyle对象，用于统一管理不同层级节点的视觉效果。支持按层级设置颜色、边框、填充等样式属性。

```csharp
public LevelStyle levelStyle
```

--------------------------------

### Get Mark Color

Source: https://xcharts-team.github.io/docs/api

Retrieves the color associated with a mark for a given series and series data. This method is supported from v3.4.0.

```csharp
public Color32 GetMarkColor(Serie serie, SerieData serieData)
```

--------------------------------

### Get Stacked Serie Information

Source: https://xcharts-team.github.io/docs/api

Methods for handling series that are stacked, providing information about their stack index and total value.

```csharp
public int GetSerieIndexIfStack<T>(Serie currSerie, int gridIndex) where T : Serie
public double GetSerieSameStackTotalValue<T>(string stack, int dataIndex, int gridIndex) where T : Serie
```

--------------------------------

### Get Previous Data from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves the data point immediately preceding the current one, with an option to consider inverse values.

```csharp
public double GetPreviousData(int index, bool inverse = false)
```

--------------------------------

### Get First Data from SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves the first data point in the series, with options for using unscaled time and specifying animation duration.

```csharp
public double GetFirstData(bool unscaledTime, float animationDuration = 500f)
```

--------------------------------

### XCThemeMgr - Load Theme

Source: https://xcharts-team.github.io/docs/api

Loads a theme from storage by name and returns the Theme object. Initializes and prepares the theme for use in chart rendering.

```csharp
public static Theme LoadTheme(string themeName)
```

--------------------------------

### Treemap类 - 获取指定层级的标签样式

Source: https://xcharts-team.github.io/docs/treemap

根据层级索引获取该层级节点的标签样式配置。返回LabelStyle对象，用于配置文本标签的字体、颜色、位置等属性。支持多层级标签的独立配置。

```csharp
public LabelStyle GetLevelLabel(int level)
```

--------------------------------

### DataZoom.RangeMode Enumeration

Source: https://xcharts-team.github.io/docs/api

Specifies the value type for start and end parameters in DataZoom. Controls whether range values are interpreted as percentages or absolute values.

```APIDOC
## DataZoom.RangeMode Enumeration

### Description
Defines the value type interpretation for start and end parameters.

### Enumeration Values

#### Value
- **Value**: `Value`
- **Description**: Range values are interpreted as absolute values.

#### Percent
- **Value**: `Percent`
- **Description**: Range values are interpreted as percentages.
```

--------------------------------

### Prevent Axis Boundary Gaps in Line Charts

Source: https://xcharts-team.github.io/docs/faq

To display a line chart starting from 0 on the X-axis without blank space at the boundaries, set the `boundaryGap` parameter for the X-axis to `false`.

```csharp
chart.XAxis.boundaryGap = false;
```

--------------------------------

### Enable Background Component

Source: https://xcharts-team.github.io/docs/faq

Show a background for the chart by setting the `show` property of the `background` component to `true`.

```csharp
chart.background.show = true;
```

--------------------------------

### Treemap类 - 获取指定层级的项目样式

Source: https://xcharts-team.github.io/docs/treemap

根据层级索引获取该层级节点的ItemStyle样式配置。接收层级数字参数，返回对应层级的ItemStyle对象，用于动态获取和修改不同层级的视觉样式。

```csharp
public ItemStyle GetLevelItemStyle(int level)
```

--------------------------------

### XLog - Get Unix Timestamp

Source: https://xcharts-team.github.io/docs/api

Returns the current Unix timestamp as an unsigned 64-bit integer. Represents milliseconds or seconds since epoch depending on implementation.

```csharp
public static ulong GetTimestamp()
```

--------------------------------

### GaugeChart: Creating Default Clock Gauge Chart (C#)

Source: https://xcharts-team.github.io/docs/gauge

This C# code snippet shows how to instantiate a default clock-style gauge chart. It leverages the `DefaultClockGaugeChart` method of the `GaugeChart` class. This chart type is ideal for time-related visualizations.

```csharp
using XCharts.Runtime.Gauges;

// Assuming 'chart' is an instance of BaseChart or a derived class
GaugeChart gaugeChart = chart as GaugeChart;
if (gaugeChart != null)
{
    gaugeChart.DefaultClockGaugeChart();
}
```

--------------------------------

### XLog - Get Current Timestamp

Source: https://xcharts-team.github.io/docs/api

Returns the current time as a formatted string according to the provided formatter parameter. Uses default format if formatter is null.

```csharp
public static string GetNowTime(string formatter = null)
```

--------------------------------

### Treemap类 - 数据更新处理

Source: https://xcharts-team.github.io/docs/treemap

重写的数据更新方法，当Treemap的数据发生变化时调用。用于刷新图表显示，处理数据变动后的视觉更新。是Treemap基类方法的具体实现。

```csharp
public override void OnDataUpdate()
```

--------------------------------

### XCThemeMgr - Get Theme by Name

Source: https://xcharts-team.github.io/docs/api

Retrieves a specific Theme object by its name from the theme manager. Returns the Theme instance matching the provided theme name parameter.

```csharp
public static Theme GetTheme(string themeName)
```

--------------------------------

### BaseSerie Methods for Data and State Management

Source: https://xcharts-team.github.io/docs/api

This snippet covers methods within the BaseSerie class related to managing component and vertex data states, clearing data, and refreshing components. These methods are crucial for updating chart visualizations.

```csharp
public virtual void OnBeforeSerialize()
public virtual void OnDataUpdate()
public virtual void ClearComponentDirty()
public virtual void ClearData()
public virtual void ClearDirty()
public virtual void ClearVerticesDirty()
public virtual void OnAfterDeserialize()
public virtual void OnRemove()
public void RefreshLabel()
public virtual void SetAllDirty()
public virtual void SetComponentDirty()
public virtual void SetVerticesDirty()
```

--------------------------------

### Treemap配置 - 自定义返回上一层按钮

Source: https://xcharts-team.github.io/docs/treemap

配置自定义的返回上一层导航按钮GameObject。配置后需要手动处理按钮点击事件，并调用GoUpALevel()接口。类型为GameObject，用于实现自定义UI的钻取导航。

```csharp
public GameObject customGoUpLevelButton
```

--------------------------------

### Get Min/Max Data Range from SerieData

Source: https://xcharts-team.github.io/docs/api

Calculates and returns the minimum and maximum data values within a specified range of dimensions. The 'inverse' parameter affects the calculation.

```csharp
public void GetMinMaxData(int startDimensionIndex, bool inverse, out double min, out double max)
```

--------------------------------

### SerieData.EnsureComponent - Get or Create Component

Source: https://xcharts-team.github.io/docs/api

Ensures a data item has a component of the specified type. If not present, creates and adds it. Supports both non-generic and generic variants. Available from v3.6.0+

```csharp
public ISerieDataComponent EnsureComponent(Type type)
public T EnsureComponent<T>() where T : ChildComponent, ISerieDataComponent
```

--------------------------------

### GaugeChart: Creating Default Multiple Gauge Chart (C#)

Source: https://xcharts-team.github.io/docs/gauge

This C# code demonstrates the creation of a default multiple gauge chart. By calling `DefaultMultipleGaugeChart` on a `GaugeChart` instance, you can display several gauges simultaneously, suitable for comparing multiple metrics.

```csharp
using XCharts.Runtime.Gauges;

// Assuming 'chart' is an instance of BaseChart or a derived class
GaugeChart gaugeChart = chart as GaugeChart;
if (gaugeChart != null)
{
    gaugeChart.DefaultMultipleGaugeChart();
}
```

--------------------------------

### Get Serie Bar Properties

Source: https://xcharts-team.github.io/docs/api

Retrieves properties related to bar series, such as the gap between bars and the total width. These methods are generic and require specifying the Serie type.

```csharp
public float GetSerieBarGap<T>(int gridIndex) where T : Serie
public int GetSerieBarRealCount<T>(int gridIndex) where T : Serie
public float GetSerieTotalGap<T>(float categoryWidth, float gap, int index, int gridIndex) where T : Serie
public float GetSerieTotalWidth<T>(float categoryWidth, float gap, int realBarCount, int gridIndex) where T : Serie
```

--------------------------------

### Treemap类 - 返回上一层节点

Source: https://xcharts-team.github.io/docs/treemap

执行返回上一层级的钻取操作。无参数和返回值，直接修改图表显示状态。需要在调用前检查CanGoUpALevel()以确保操作的有效性。

```csharp
public void GoUpALevel()
```

--------------------------------

### XCThemeMgr - Get All Theme Names

Source: https://xcharts-team.github.io/docs/api

Retrieves a list of all available theme names in the XCharts theme manager. Returns a collection of string identifiers representing each registered theme that can be applied to charts.

```csharp
public static List<string> GetAllThemeNames()
```

--------------------------------

### Show Package Importer Window in XCResourceImporterWindow in C#

Source: https://xcharts-team.github.io/docs/api

Static method that displays the XCharts package importer editor window. Provides UI for importing XCharts resources and packages in the Unity editor.

```csharp
public static void ShowPackageImporterWindow()
```

--------------------------------

### Initialize VisualMapTheme with ThemeType in C#

Source: https://xcharts-team.github.io/docs/api

Constructor for VisualMapTheme class that accepts a ThemeType parameter and inherits from base theme. Used to create themed visual map components for chart visualization.

```csharp
public VisualMapTheme(ThemeType theme) : base(theme)
```

--------------------------------

### Get Duplicate Chart Name Information in C#

Source: https://xcharts-team.github.io/docs/api

Static method that retrieves detailed information about duplicate chart names. Returns a string with conflict details. Useful for debugging naming issues.

```csharp
public static string GetRepeatChartNameInfo(BaseChart chart, string chartName)
```

--------------------------------

### 添加默认3D柱状图系列 - XCharts

Source: https://xcharts-team.github.io/docs/bar3d

使用`Bar3D.AddDefaultSerie(BaseChart chart, string serieName)`静态方法向指定的`BaseChart`实例添加一个默认的3D柱状图系列。此方法是`Bar3D`类的一部分，需要传入图表实例和系列名称。

```csharp
using XCharts.Runtime.Bar3Ds;

// ... 在某个类或方法中
BaseChart chart = /* 获取你的BaseChart实例 */;
string serieName = "MyBar3DSerie";

Bar3D newSerie = Bar3D.AddDefaultSerie(chart, serieName);

if (newSerie != null)
{
    // 可以进一步配置 newSerie 的属性
}
```

--------------------------------

### 创建默认圆柱体3D柱状图 - XCharts

Source: https://xcharts-team.github.io/docs/bar3d

使用`Bar3DChart.DefaultCylinderChart()`方法创建一个默认的圆柱体3D柱状图。此方法属于`Bar3DChart`类，用于快速生成标准样式的圆柱图。

```csharp
using XCharts.Runtime.Bar3Ds;

// ... 在某个类或方法中
BaseChart chart = /* 获取你的BaseChart实例 */;
Bar3DChart bar3DChart = chart as Bar3DChart;

if (bar3DChart != null)
{
    bar3DChart.DefaultCylinderChart();
}
```

--------------------------------

### Get or Add Component to SerieData

Source: https://xcharts-team.github.io/docs/api

Retrieves an existing component of a specified type from SerieData, or adds a new one if it doesn't exist. The component type must inherit from ChildComponent and implement ISerieDataComponent.

```csharp
public T GetOrAddComponent<T>() where T : ChildComponent, ISerieDataComponent
```

--------------------------------

### Configure XCSettings Tooltip and VisualMap in C#

Source: https://xcharts-team.github.io/docs/api

Static properties controlling tooltip and visual map component appearance including line width, border width, and triangle length for visual map.

```csharp
public static float tootipLineWidth
public static float visualMapBorderWidth
public static float visualMapTriangeLen
```

--------------------------------

### DefaultTooltipAttribute Constructor

Source: https://xcharts-team.github.io/docs/api

Constructor for the DefaultTooltipAttribute, used to specify default tooltip behavior. It takes a Tooltip.Type and a Tooltip.Trigger, allowing developers to pre-configure how tooltips appear and behave. This attribute simplifies tooltip setup.

```csharp
public DefaultTooltipAttribute(Tooltip.Type type, Tooltip.Trigger trigger)
```

--------------------------------

### Coordinate and Position Calculations

Source: https://xcharts-team.github.io/docs/api

Functions for calculating grid coordinates and positions within the chart. This includes getting grid coordinates from local positions or data zooms, and calculating interpolated colors based on positions.

```csharp
public GridCoord GetGrid(Vector2 local)
public GridCoord GetGridOfDataZoom(DataZoom dataZoom)
public Vector3 GetTitlePosition(Title title)
public Color32 GetXLerpColor(Color32 areaColor, Color32 areaToColor, Vector3 pos, GridCoord grid)
public Color32 GetYLerpColor(Color32 areaColor, Color32 areaToColor, Vector3 pos, GridCoord grid)
```

--------------------------------

### AnimationStyle Progress Initialization - C#

Source: https://xcharts-team.github.io/docs/api

Initializes animation configuration with path vectors and axis orientation. Takes a List of Vector3 representing animation paths and a boolean flag indicating Y-axis animation, setting up the animation progress tracking system.

```csharp
public void InitProgress(List<Vector3> paths, bool isY)
{
  // 初始化动画配置
}
```

--------------------------------

### Pie3D Style Configuration Options

Source: https://xcharts-team.github.io/docs/pie3d

Details the configurable properties for Pie3DStyle, including drawSplitSide, ellipseMinorAxis, color rates for sides, auto height, max height, selected offset, and show property.

```csharp
// Pie3DStyle configuration examples:
// drawSplitSide: bool (default: true, v3.10.0)
// ellipseMinorAxis: float (default: 0.65f)
// endSideColorRate: float (default: 0.65f)
// peripherySideColorRate: float (default: 0.8f)
// pieAutoHeight: bool (default: false)
// pieMaxHeight: float (default: 20f)
// selectedOffset: Vector2 (default: Vector2(0.1f, 0.5f))
// startSideColorRate: float (default: 0.7f)
// show: bool (default: true)
```

--------------------------------

### ListPool<T> Methods in XCharts.Runtime

Source: https://xcharts-team.github.io/docs/api

A generic class for managing a pool of lists to improve performance by reusing list objects. It includes methods to Get a list, Release a list back to the pool, and ClearAll lists from the pool.

```csharp
public static void ClearAll()
public static List<T> Get()
public static void Release(List<T> toRelease)
```
Tokens:
Raw