[]
DEMOS DOC DESIGNER API
DOWNLOAD
(Showing Draft Content)

GC.Spread.Sheets.Sparklines.SparklineEx

Class: SparklineEx

Sheets.Sparklines.SparklineEx

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new SparklineEx()

Represents the base class for the other SparklineEx classes.

Properties

typeName

• typeName: string

Represents the type name string used for supporting serialization.

Methods

createFunction

▸ createFunction(): Function

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

Returns

Function

The created custom function.

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

name

▸ name(): string

Gets the name of SparklineEx.

Returns

string

The SparklineEx's name.

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 x-coordinate relative to the canvas.
y number y-coordinate relative to the canvas.
width number The cell's width.
height number The cell's height.

Returns

void

toJSON

▸ toJSON(): Object

Saves the object state to a JSON string.

Returns

Object

The sparklineEx data.