ods-charts
    Preparing search index...

    Class ODSChartsConfiguration

    ChartsConfiguration is used to specify the configuration specific to a type of graph.

    For the moment can be:

    Index

    Properties

    type: ODSChartsTypes = ODSChartsTypes.DEFAULT

    Methods

    • Internal

      For internal use only. This method should not be called directly by the user. It is used internally by the class to build the configuration of the charts.

      Returns any

      The default configuration of a chart.

    • Internal

      For internal use only. This method should not be called directly by the user. It is used internally by the class to build the configuration of the charts.

      Parameters

      • _serie: { type: string }

        The serie to get the configuration for.

      Returns any

      The configuration of the serie.

    • Get the empty default configuration of a chart. This method should not be used. Prefer to use the specific methods to get the configuration of a chart. For example, use getLineChartConfiguration to get the configuration of a line chart.

      Returns ODSChartsConfiguration

      The default configuration of a chart.

    • Get the configuration of a horizontal gauge chart. This chart is a bar chart with a horizontal orientation, used to display a single value within a range. It is useful for showing progress or performance against a target.

      Parameters

      • config: ODSChartsGaugeConfiguration

        Configuration of the horizontal gauge chart, must be used to specify the minimum and maximum values. The chart will display a bar that fills the space between these two values.

      Returns ODSChartsConfiguration

      Configuration of the horizontal gauge chart.