@univerjs-pro/sheets-sparkline v0.5.4

Class: SparklineDataSourceModel

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:10

Extends

Disposable

Constructors

new SparklineDataSourceModel()

new SparklineDataSourceModel(_univerInstanceService): SparklineDataSourceModel

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:24

Parameters

Parameter	Type
`_univerInstanceService`	`IUniverInstanceService`

Returns

SparklineDataSourceModel

Overrides

Disposable.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:96
`updateConfig$`	`public`	`Observable`<{ `config`: `ISparklineGroup`; `groupId`: `string`; `subUnitId`: `string`; `type`: `"add"` \| `"set"` \| `"remove"`; `unitId`: `string`; }>	`undefined`	-	packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:22

Methods

addSparkline()

addSparkline(
   unitId, 
   subUnitId, 
   groupId, 
   config): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:177

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`groupId`	`string`
`config`	`ISparklineGroup`

Returns

void

clearSparklineCache()

clearSparklineCache(
   unitId, 
   subUnitId, 
   groupId): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:228

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`groupId`	`string`

Returns

void

deleteUnit()

deleteUnit(unitId): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:333

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Disposable.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed

fromJSON()

fromJSON(modelJSON): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:300

Parameters

Parameter	Type
`modelJSON`	`ISparklineSnapshotJSON`

Returns

void

getSparkline()

getSparkline(
   unitId, 
   subUnitId, 
   row, 
   col): undefined | string

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:248

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`col`	`number`

Returns

undefined | string

getSparklineById()

getSparklineById(
   unitId, 
   subUnitId, 
   groupId): undefined | ISparklineGroup

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:244

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`groupId`	`string`

Returns

undefined | ISparklineGroup

getSparklineCache()

getSparklineCache(): {
  sparklineAnchorMap: ISparklineAnchorMap;
  sparklineModel: ISparklinesModel;
}

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:265

Returns

{
  sparklineAnchorMap: ISparklineAnchorMap;
  sparklineModel: ISparklinesModel;
}

Name	Type	Defined in
`sparklineAnchorMap`	`ISparklineAnchorMap`	packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:268
`sparklineModel`	`ISparklinesModel`	packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:267

getSubUnitSparkline()

getSubUnitSparkline(unitId, subUnitId): 
  | undefined
| Map<string, ISparklineGroup>

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:240

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

| undefined | Map<string, ISparklineGroup>

reBuildAnchorCache()

reBuildAnchorCache(unitId, subUnitId): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:252

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

void

removePartSparkline()

removePartSparkline(
   unitId, 
   subUnitId, 
   row, 
   col): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:213

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`col`	`number`

Returns

void

removeSparkline()

removeSparkline(
   unitId, 
   subUnitId, 
   groupId): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:194

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`groupId`	`string`

Returns

void

setSparkline()

setSparkline(
   unitId, 
   subUnitId, 
   groupIds, 
   config): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:184

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`groupIds`	`string`[]
`config`	`ISparklineGroup`

Returns

void

toJSON()

toJSON(unitId): ISparklineSnapshotJSON

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:272

Parameters

Parameter	Type
`unitId`	`string`

Returns

ISparklineSnapshotJSON

updateSparklineExtraNum()

updateSparklineExtraNum(
   unitId, 
   subUnitId, 
   groupId, 
   type): void

Defined in: packages/sheets-sparkline/src/models/sparkline-data-source.model.ts:61

Parameters

Parameter	Type	Default value
`unitId`	`string`	`undefined`
`subUnitId`	`string`	`undefined`
`groupId`	`string`	`undefined`
`type`	`"add"` \| `"set"`	`'set'`

Returns

void

Readme Universheetsparklineplugin