@univerjs-pro/sheets-chart-ui v0.5.0-beta.1 • Docs

Class: SheetsChartUIService

Extends

Disposable

Constructors

new SheetsChartUIService()

new SheetsChartUIService(
   _chartModelService, 
   _sheetsChartService, 
   _commandService, 
   _localeService, 
   _chartHostProviderService, 
   _univerInstanceService): SheetsChartUIService

Parameters

Parameter	Type
`_chartModelService`	`ChartModelService`
`_sheetsChartService`	`SheetsChartService`
`_commandService`	`ICommandService`
`_localeService`	`LocaleService`
`_chartHostProviderService`	`IChartHostProviderService`
`_univerInstanceService`	`IUniverInstanceService`

Returns

SheetsChartUIService

Overrides

Disposable.constructor

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:843

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93

Accessors

activeChartModel

Get Signature

get activeChartModel(): Nullable<ChartModel>

Returns

Nullable<ChartModel>

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:856

rangeSelectMode

Get Signature

get rangeSelectMode(): boolean

Returns

boolean

Set Signature

set rangeSelectMode(on): void

Parameters

Parameter	Type
`on`	`boolean`

Returns

void

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:860

Methods

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:915

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

executeChartUpdateConfig()

executeChartUpdateConfig(params): void

Parameters

Parameter	Type
`params`	`Omit`<`IChartUpdateConfigCommandParams`, `"unitId"`>

Returns

void

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:887

executeChartUpdateSourceConfig()

executeChartUpdateSourceConfig(params): void

Parameters

Parameter	Type
`params`	`Omit`<`IChartUpdateSourceCommandParams`, `"unitId"`>

Returns

void

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:894

getDataSource()

getDataSource(id): undefined | IChartDataSource

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | IChartDataSource

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:868

getViewState()

getViewState<V>(id): undefined | IChartConfigState<V, V>

Type Parameters

Type Parameter	Default type
`V` extends `ChartConfigStateValue`	`ChartConfigStateValue`

Parameters

Parameter	Type
`id`	keyof `IChartConfigStateMap`

Returns

undefined | IChartConfigState<V, V>

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:876

registerViewState()

registerViewState<T>(id, state): void

Type Parameters

Type Parameter	Default type
`T` extends keyof `IChartConfigStateMap`	keyof `IChartConfigStateMap`

Parameters

Parameter	Type
`id`	`T`
`state`	(`chartModel`) => `IChartConfigStateMap`[`T`]

Returns

void

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:872

removeViewState()

removeViewState(id): void

Parameters

Parameter	Type
`id`	keyof `IChartConfigStateMap`

Returns

void

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:900

setBorder()

setBorder(id, color): void

Parameters

Parameter	Type
`id`	`string`
`color`	`string`

Returns

void

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:907

t()

t(...args): string

Parameters

Parameter	Type
…`args`	[`string`, `...args: string[]`]

Returns

string

Defined in

packages/sheets-chart-ui/src/services/sheets-chart-ui.service.ts:911

Sheetschartuicontroller Universheetschartuiplugin