---
title: "Vision - Chart Scripting Functions"
---

# Vision - Chart Scripting Functions

> This page details the various component and extension functions available for [Vision's Chart component](chart.md).

## Component Functions
### getPlotProperties()
* Description
    * Retrieves the value of the selected PlotProperty objects that define background color and weight of each plot.

* Parameters
    * None

* Return
    * List

### getProperties()
* Description
    * Retrieves the value of custom properties added to the Chart.

* Parameters
    * None

* Return
    * List       

### getSelectedData()
* Description
    * Returns the value of the selected chart entity as a string.

* Parameters
    * None

* Return
    * String

### getSelectedEntity()
* Description
    * Returns the selected chart entity directly.

* Parameters
    * None

* Return
    * ChartEntity

### getSubplotMode()
* Description
    * Retrieves the subplot mode that is currently in use:
        * 0 = Shared Domain
        * 1 = Shared Range
* Parameters
    * None

* Return
    * Int

### getXAxes()
* Description
    * Returns a dictionary of the related rendering properties.

* Parameters
    * None

* Return
    * Dictionary<String, AxisConfig> - [AxisConfig](https://sdk.inductiveautomation.com/javadoc/ignition83/latest/com/inductiveautomation/factorypmi/application/components/chart/AxisConfig.html) is an object that defines rendering properties

### getYAxes()
* Description
    * Returns a dictionary of the related rendering properties.

* Parameters
    * None

* Return
    * Dictionary<String, AxisConfig> -  [AxisConfig](https://sdk.inductiveautomation.com/javadoc/ignition83/latest/com/inductiveautomation/factorypmi/application/components/chart/AxisConfig.html) is an object that defines rendering properties

### refreshChart()
* Description
    * Refreshes the dataset for the specified subplot and dataset.

* Parameters
    * int **subplotIndex**
    * int **dataSetIndex**

* Return
    * None

### setDatasetEnabled()
* Description
    * Sets a dataset to be enabled or not enabled.

* Parameters
    * string **dataSetName** 
    * boolean **isEnabled** - A boolean representing if the dataset is enabled

* Return
    * None

### setDatasetPlotNumber()
* Description
    * Sets a dataset's plot number.

* Parameters
    * string **dataSetName**
    * int **plotNumber**

* Return
    * None

### setDatasetXAxis()
* Description
    * Sets a dataset's X axis name.

* Parameters
    * string **dataSetName** 
    * string **axisName**

* Return
    * None

### setDatasetYAxis()
* Description
    * Sets a dataset's Y axis name.

* Parameters
    * string **dataSetName** 
    * string **axisName**

* Return
    * None

### setSubplotMode()
* Description
    * Sets the subplot mode to be used when there is more than one subplot.

* Parameters
    * int **mode** - The mode to set the chart to. The mode options are as follows:
        * 0 - Shared Domain
        * 1 - Shared Range

* Return
    * None

### setXAxes()
* Description
    * Sets defined rendering properties using AxisConfig objects.

* Parameters
    * PyDictionary string keys to [AxisConfig](https://sdk.inductiveautomation.com/javadoc/ignition83/latest/com/inductiveautomation/factorypmi/application/components/chart/AxisConfig.html) objects

* Return
    * None

### setYAxes()
* Description
    * Sets defined rendering properties using AxisConfig objects.

* Parameters
    * PyDictionary string keys to [AxisConfig](https://sdk.inductiveautomation.com/javadoc/ignition83/latest/com/inductiveautomation/factorypmi/application/components/chart/AxisConfig.html) objects

* Return
    * None

## Extension Functions
### configureChart
* Description
    * Provides an opportunity to perform further chart configuration via scripting.

* Parameters
    * Component **self**- A reference to the component that is invoking this function.

    * JFreeChart **chart**- A JFreeChart object. Refer to the [JFreeChart documentation](https://www.jfree.org/jfreechart/javadoc/index.html) for API details.

* Return
    * None

### getXTraceLabel
* Description
    * Provides an opportunity to configure the x-trace label. Return a string to override the default label.

* Parameters
    * Component **self**- A reference to the component that is invoking this function.

    * JFreeChart **chart** - A JFreeChart object. Refer to the [JFreeChart documentation](https://www.jfree.org/jfreechart/javadoc/index.html) for API details.

    * String **penName** - The name of the pen the x-trace label applies to.

    * int **yValue** - The y-value of the pen at the x-trace location

* Return
    * None