@univerjs/sheets-hyper-link v0.5.0-beta.1 • Docs

Class: HyperLinkModel

Extends

Disposable

Constructors

new HyperLinkModel()

new HyperLinkModel(_univerInstanceService): HyperLinkModel

Parameters

Parameter	Type
`_univerInstanceService`	`IUniverInstanceService`

Returns

HyperLinkModel

Overrides

Disposable.constructor

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:66

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	core/src/shared/lifecycle.ts:93
`linkUpdate$`	`public`	`Observable`<`LinkUpdate`>	`undefined`	-	sheets-hyper-link/src/models/hyper-link.model.ts:61

Methods

addHyperLink()

addHyperLink(
   unitId, 
   subUnitId, 
   link): boolean

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`link`	`ICellHyperLink`

Returns

boolean

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:107

deleteUnit()

deleteUnit(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:261

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

core/src/shared/lifecycle.ts:106

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100

getAll()

getAll(): {
  links: ICellHyperLink[];
  subUnitId: string;
  unitId: string;
 }[][]

Returns

{ links: ICellHyperLink[]; subUnitId: string; unitId: string; }[][]

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:273

getHyperLink()

getHyperLink(
   unitId, 
   subUnitId, 
id): Nullable<ICellHyperLink>

Parameters

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

Returns

Nullable<ICellHyperLink>

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:202

getHyperLinkByLocation()

getHyperLinkByLocation(
   unitId, 
   subUnitId, 
   row, 
   column): undefined | ICellHyperLink

Parameters

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

Returns

undefined | ICellHyperLink

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:211

getHyperLinkByLocationSync()

getHyperLinkByLocationSync(
   unitId, 
   subUnitId, 
   row, 
   column): undefined | {
  column: number;
  display: cellValueStr;
  id: string;
  payload: string;
  row: number;
}

Parameters

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

Returns

undefined | { column: number; display: cellValueStr; id: string; payload: string; row: number; }

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:216

getSubUnit()

getSubUnit(unitId, subUnitId): ICellHyperLink[]

Parameters

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

Returns

ICellHyperLink[]

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:232

getUnit()

getUnit(unitId): {
  links: ICellHyperLink[];
  subUnitId: string;
  unitId: string;
 }[]

Parameters

Parameter	Type
`unitId`	`string`

Returns

{ links: ICellHyperLink[]; subUnitId: string; unitId: string; }[]

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:245

removeHyperLink()

removeHyperLink(
   unitId, 
   subUnitId, 
   id): boolean

Parameters

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

Returns

boolean

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:180

updateHyperLink()

updateHyperLink(
   unitId, 
   subUnitId, 
   id, 
   payload, 
   silent): boolean

Parameters

Parameter	Type	Default value
`unitId`	`string`	`undefined`
`subUnitId`	`string`	`undefined`
`id`	`string`	`undefined`
`payload`	`Partial`<`ICellLinkContent`>	`undefined`
`silent`	`boolean`	`false`

Returns

boolean

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:120

updateHyperLinkRef()

updateHyperLinkRef(
   unitId, 
   subUnitId, 
   id, 
   payload, 
   silent): boolean

Parameters

Parameter	Type	Default value
`unitId`	`string`	`undefined`
`subUnitId`	`string`	`undefined`
`id`	`string`	`undefined`
`payload`	`object`	`undefined`
`payload.column`	`number`	`undefined`
`payload.row`	`number`	`undefined`
`silent`	`boolean`	`false`

Returns

boolean

Defined in

sheets-hyper-link/src/models/hyper-link.model.ts:153

Readme Sheetshyperlinkparserservice