FSparkline
| packages | @univerjs-pro/sheets-sparkline |
|---|
The facade class for the sparkline.
APIs
changeDataSource
Signature
changeDataSource(sourceRange: IRange, targetRange: IRange): FSparkline | undefinedParameters
sourceRange(IRange) — Location of new data sourcetargetRange(IRange) — New placement
Returns
- (
FSparkline | undefined) — Return this, for chaining
Tags
@description— Modify the data source of the sparkline in the current cell
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
// Create a sparkline in the range A10, with the data source in the range A1:A7.
const sparkline = fWorksheet.addSparkline(
[fWorksheet.getRange('A1:A7').getRange()],
[fWorksheet.getRange('A10').getRange()],
)
// Modify the data source of the sparkline to the range B1:B7, and move it to the range B10 after 3 seconds.
setTimeout(() => {
sparkline.changeDataSource(
fWorksheet.getRange('B1:B7').getRange(),
fWorksheet.getRange('B10').getRange(),
)
}, 3000)removeSparkline
Signature
removeSparkline(): voidTags
@description— Delete the sparkline in the current cell
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
// Create a sparkline in the range A10, with the data source in the range A1:A7.
const sparkline = fWorksheet.addSparkline(
[fWorksheet.getRange('A1:A7').getRange()],
[fWorksheet.getRange('A10').getRange()],
)
// Remove the sparkline after 3 seconds.
setTimeout(() => {
sparkline.removeSparkline()
}, 3000)