# GC.Spread.Sheets.Sparklines.SparklineEx

## Content

# Class: SparklineEx

[Sheets](../modules/GC.Spread.Sheets).[Sparklines](../modules/GC.Spread.Sheets.Sparklines).SparklineEx

## Hierarchy

- **`SparklineEx`**

  ↳ [`Codabar`](GC.Spread.Sheets.Barcode.Codabar)

  ↳ [`Code128`](GC.Spread.Sheets.Barcode.Code128)

  ↳ [`Code39`](GC.Spread.Sheets.Barcode.Code39)

  ↳ [`Code49`](GC.Spread.Sheets.Barcode.Code49)

  ↳ [`Code93`](GC.Spread.Sheets.Barcode.Code93)

  ↳ [`DataMatrix`](GC.Spread.Sheets.Barcode.DataMatrix)

  ↳ [`EAN13`](GC.Spread.Sheets.Barcode.EAN13)

  ↳ [`EAN8`](GC.Spread.Sheets.Barcode.EAN8)

  ↳ [`GS1_128`](GC.Spread.Sheets.Barcode.GS1_128)

  ↳ [`PDF417`](GC.Spread.Sheets.Barcode.PDF417)

  ↳ [`QRCode`](GC.Spread.Sheets.Barcode.QRCode)

  ↳ [`AreaSparkline`](GC.Spread.Sheets.Sparklines.AreaSparkline)

  ↳ [`BoxPlotSparkline`](GC.Spread.Sheets.Sparklines.BoxPlotSparkline)

  ↳ [`BulletSparkline`](GC.Spread.Sheets.Sparklines.BulletSparkline)

  ↳ [`CascadeSparkline`](GC.Spread.Sheets.Sparklines.CascadeSparkline)

  ↳ [`ColumnSparkline`](GC.Spread.Sheets.Sparklines.ColumnSparkline)

  ↳ [`GaugeKPISparkline`](GC.Spread.Sheets.Sparklines.GaugeKPISparkline)

  ↳ [`HBarSparkline`](GC.Spread.Sheets.Sparklines.HBarSparkline)

  ↳ [`HistogramSparkline`](GC.Spread.Sheets.Sparklines.HistogramSparkline)

  ↳ [`ImageSparkline`](GC.Spread.Sheets.Sparklines.ImageSparkline)

  ↳ [`LineSparkline`](GC.Spread.Sheets.Sparklines.LineSparkline)

  ↳ [`LollipopVariSparkline`](GC.Spread.Sheets.Sparklines.LollipopVariSparkline)

  ↳ [`MonthSparkline`](GC.Spread.Sheets.Sparklines.MonthSparkline)

  ↳ [`ParetoSparkline`](GC.Spread.Sheets.Sparklines.ParetoSparkline)

  ↳ [`PieSparkline`](GC.Spread.Sheets.Sparklines.PieSparkline)

  ↳ [`RangeBlockSparkline`](GC.Spread.Sheets.Sparklines.RangeBlockSparkline)

  ↳ [`ScatterSparkline`](GC.Spread.Sheets.Sparklines.ScatterSparkline)

  ↳ [`SpreadSparkline`](GC.Spread.Sheets.Sparklines.SpreadSparkline)

  ↳ [`StackedSparkline`](GC.Spread.Sheets.Sparklines.StackedSparkline)

  ↳ [`VariSparkline`](GC.Spread.Sheets.Sparklines.VariSparkline)

  ↳ [`VBarSparkline`](GC.Spread.Sheets.Sparklines.VBarSparkline)

  ↳ [`WinlossSparkline`](GC.Spread.Sheets.Sparklines.WinlossSparkline)

  ↳ [`YearSparkline`](GC.Spread.Sheets.Sparklines.YearSparkline)

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.Sparklines.SparklineEx#constructor)

### Properties

- [typeName](GC.Spread.Sheets.Sparklines.SparklineEx#typename)

### Methods

- [createFunction](GC.Spread.Sheets.Sparklines.SparklineEx#createfunction)
- [fromJSON](GC.Spread.Sheets.Sparklines.SparklineEx#fromjson)
- [name](GC.Spread.Sheets.Sparklines.SparklineEx#name)
- [paint](GC.Spread.Sheets.Sparklines.SparklineEx#paint)
- [toJSON](GC.Spread.Sheets.Sparklines.SparklineEx#tojson)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new SparklineEx**()

Represents the base class for the other SparklineEx classes.

## Properties

### <a id="typename" name="typename"></a> typeName

• **typeName**: `string`

Represents the type name string used for supporting serialization.

## Methods

### <a id="createfunction" name="createfunction"></a> createFunction

▸ **createFunction**(): [`Function`](GC.Spread.CalcEngine.Functions.Function)

Creates a custom function used to provide data and settings for SparklineEx.

#### Returns

[`Function`](GC.Spread.CalcEngine.Functions.Function)

The created custom function.

___

### <a id="fromjson" name="fromjson"></a> fromJSON

▸ **fromJSON**(`settings`): `void`

Loads the object state from the specified JSON string.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `settings` | `Object` | The sparklineEx data from deserialization. |

#### Returns

`void`

___

### <a id="name" name="name"></a> name

▸ **name**(): `string`

Gets the name of SparklineEx.

#### Returns

`string`

The SparklineEx's name.

___

### <a id="paint" name="paint"></a> paint

▸ **paint**(`context`, `value`, `x`, `y`, `width`, `height`): `void`

Paints the SparklineEx on the canvas.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `context` | `CanvasRenderingContext2D` | The canvas's two-dimensional context. |
| `value` | `any` | The value evaluated by the custom function. |
| `x` | `number` | <i>x</i>-coordinate relative to the canvas. |
| `y` | `number` | <i>y</i>-coordinate relative to the canvas. |
| `width` | `number` | The cell's width. |
| `height` | `number` | The cell's height. |

#### Returns

`void`

___

### <a id="tojson" name="tojson"></a> toJSON

▸ **toJSON**(): `Object`

Saves the object state to a JSON string.

#### Returns

`Object`

The sparklineEx data.