[]
        
(Showing Draft Content)

GC.Spread.Sheets.Sparklines.SparklineGroup

Class: SparklineGroup

Sheets.Sparklines.SparklineGroup

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new SparklineGroup(type, setting)

Represents a sparkline group.

Parameters

Name Type Description
type SparklineType The type of sparkline.
setting SparklineSetting The setting of the sparkline group.

Properties

setting

• setting: SparklineSetting

Indicates the sparkline settings.


sparklineType

• sparklineType: SparklineType

Indicates the sparkline type.

Methods

add

▸ add(item): void

Adds a sparkline to the group.

Parameters

Name Type Description
item Sparkline The sparkline item.

Returns

void


clone

▸ clone(): SparklineGroup

Clones the current sparkline group.

Returns

SparklineGroup

The cloned sparkline group.


contains

▸ contains(item): boolean

Determines whether the group contains a specific value.

Parameters

Name Type Description
item Sparkline The object to locate in the group.

Returns

boolean

true if the item is found in the group; otherwise, false.


count

▸ count(): number

Represents the count of the sparkline group innerlist.

Returns

number

The sparkline count in the group.


dateAxisData

▸ dateAxisData(value?): any

Represents the date axis data.

Parameters

Name Type Description
value? Range The date axis data.

Returns

any

If no value is set, returns the date axis data; otherwise, returns undefined.


dateAxisOrientation

▸ dateAxisOrientation(value): any

Represents the date axis orientation.

Parameters

Name Type Description
value DataOrientation The date axis orientation.

Returns

any

If no value is set, returns the date axis orientation; otherwise, returns undefined.


remove

▸ remove(item): Sparkline[]

Removes the first occurrence of a specific object from the group.

Parameters

Name Type Description
item Sparkline The sparkline item.

Returns

Sparkline[]

The GC.Spread.Sheets.Sparklines.Sparkline array.