@univerjs/core v0.1.17 • Docs

Class: Tools

Universal tool library

Constructors

new Tools()

new Tools(): Tools

Returns

Tools

Methods

ABCatNum()

static ABCatNum(a): number

Column subscript letter to number

Parameters

Returns

number

Column subscript number,e.g.,0

Defined in

submodules/univer/packages/core/src/shared/tools.ts:548 (opens in a new tab)

arrayToObject()

static arrayToObject(array): IKeyValue

Parameters

Returns

IKeyValue

Defined in

submodules/univer/packages/core/src/shared/tools.ts:636 (opens in a new tab)

camelCase()

static camelCase(str): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:474 (opens in a new tab)

capitalize()

static capitalize(str): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:462 (opens in a new tab)

chatAtABC()

static chatAtABC(n): string

en: Column subscript number to letter

zh: 列下标 数字转字母

Parameters

Returns

string

Column subscript letter,e.g.,"A1"

Defined in

submodules/univer/packages/core/src/shared/tools.ts:575 (opens in a new tab)

commonExtend()

static commonExtend<T>(originJson, extendJson): T

extend two objects

Type Parameters

Parameters

Returns

T

Defined in

submodules/univer/packages/core/src/shared/tools.ts:609 (opens in a new tab)

commonExtend1()

static commonExtend1<T>(originJson, extendJson): T

Type Parameters

Parameters

Returns

T

Defined in

submodules/univer/packages/core/src/shared/tools.ts:627 (opens in a new tab)

deepClone()

static deepClone<T>(value): T

Type Parameters

Parameters

Returns

T

Defined in

submodules/univer/packages/core/src/shared/tools.ts:303 (opens in a new tab)

deepMerge()

static deepMerge(target, ...sources): any

Parameters

Returns

any

Defined in

submodules/univer/packages/core/src/shared/tools.ts:179 (opens in a new tab)

deleteBlank()

static deleteBlank(value?): undefined | string

Parameters

Returns

undefined | string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:81 (opens in a new tab)

diffValue()

static diffValue(one, tow): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:245 (opens in a new tab)

fCamelCase()

static fCamelCase(_all, letter): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:467 (opens in a new tab)

fillTwoDimensionalArray()

static fillTwoDimensionalArray(
   rows, 
   columns, 
   value): any[][]

Generate a two-dimensional array with the specified number of rows and columns, and fill in the values

Parameters

Returns

any[][]

Defined in

submodules/univer/packages/core/src/shared/tools.ts:504 (opens in a new tab)

generateRandomId()

static generateRandomId(n, alphabet?): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:168 (opens in a new tab)

getBrowserType()

static getBrowserType(): string

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:120 (opens in a new tab)

getClassName()

static getClassName(instance): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:175 (opens in a new tab)

getLanguage()

static getLanguage(): string

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:333 (opens in a new tab)

getSystemType()

static getSystemType(): string

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:88 (opens in a new tab)

getValueType()

static getValueType(value): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:341 (opens in a new tab)

hasIntersectionBetweenTwoRanges()

static hasIntersectionBetweenTwoRanges(
   range1Start, 
   range1End, 
   range2Start, 
   range2End): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:647 (opens in a new tab)

hasLength()

static hasLength(target, length?): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:452 (opens in a new tab)

indexAt()

static indexAt(code): number

Parameters

Returns

number

Defined in

submodules/univer/packages/core/src/shared/tools.ts:70 (opens in a new tab)

isAndroid()

static isAndroid(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:435 (opens in a new tab)

isArray()

static isArray<T>(value?): value is T[]

Type Parameters

Parameters

Returns

value is T[]

Defined in

submodules/univer/packages/core/src/shared/tools.ts:386 (opens in a new tab)

isAssignableFrom()

static isAssignableFrom<T>(object, clazz): object is T

Type Parameters

Parameters

Returns

object is T

Defined in

submodules/univer/packages/core/src/shared/tools.ts:359 (opens in a new tab)

isBlank()

static isBlank(value): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:349 (opens in a new tab)

isBoolean()

static isBoolean(value?): value is boolean

Parameters

Returns

value is boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:363 (opens in a new tab)

isDate()

static isDate(value?): value is Date

Parameters

Returns

value is Date

Defined in

submodules/univer/packages/core/src/shared/tools.ts:378 (opens in a new tab)

isDefine()

static isDefine<T>(value?): value is T

Type Parameters

Parameters

Returns

value is T

Defined in

submodules/univer/packages/core/src/shared/tools.ts:345 (opens in a new tab)

isEmptyObject()

static isEmptyObject(value?): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:406 (opens in a new tab)

isFunction()

static isFunction(value?): value is boolean

Parameters

Returns

value is boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:374 (opens in a new tab)

isIPhone()

static isIPhone(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:440 (opens in a new tab)

isMobile()

static isMobile(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:414 (opens in a new tab)

isNumber()

static isNumber(value?): value is number

Parameters

Returns

value is number

Defined in

submodules/univer/packages/core/src/shared/tools.ts:394 (opens in a new tab)

isObject()

static isObject<T>(value?): value is T

Type Parameters

Parameters

Returns

value is T

Defined in

submodules/univer/packages/core/src/shared/tools.ts:402 (opens in a new tab)

isPlainObject()

static isPlainObject(value): value is object

Parameters

Returns

value is object

Defined in

submodules/univer/packages/core/src/shared/tools.ts:367 (opens in a new tab)

isRegExp()

static isRegExp(value?): value is RegExp

Parameters

Returns

value is RegExp

Defined in

submodules/univer/packages/core/src/shared/tools.ts:382 (opens in a new tab)

isStartValidPosition()

static isStartValidPosition(name): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:656 (opens in a new tab)

isString()

static isString(value?): value is string

Parameters

Returns

value is string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:390 (opens in a new tab)

isStringNumber()

static isStringNumber(value?): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:398 (opens in a new tab)

isTablet()

static isTablet(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:426 (opens in a new tab)

isValidParameter()

static isValidParameter(name): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:662 (opens in a new tab)

isWeChat()

static isWeChat(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/tools.ts:430 (opens in a new tab)

itCount()

static itCount(count): Function

Parameters

Returns

Function

Defined in

submodules/univer/packages/core/src/shared/tools.ts:444 (opens in a new tab)

numToWord()

static numToWord(x): string

Generate a two-dimensional array with the specified number of rows and columns, and fill in the values

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:525 (opens in a new tab)

numberFixed()

static numberFixed(value, digit): number

Parameters

Returns

number

Defined in

submodules/univer/packages/core/src/shared/tools.ts:241 (opens in a new tab)

randSort()

static randSort<T>(arr): T[]

Type Parameters

Parameters

Returns

T[]

Defined in

submodules/univer/packages/core/src/shared/tools.ts:593 (opens in a new tab)

removeNull()

static removeNull(value): object

remove all null from object

Parameters

Returns

object

Defined in

submodules/univer/packages/core/src/shared/tools.ts:483 (opens in a new tab)

set()

static set(
   data, 
   propertyPath, 
   value): void

As lodash set, via a path string to set value to deep property set(obj, 'xx.yy', val)

Parameters

Returns

void

Defined in

submodules/univer/packages/core/src/shared/tools.ts:682 (opens in a new tab)

stringAt()

static stringAt(index): string

Parameters

Returns

string

Defined in

submodules/univer/packages/core/src/shared/tools.ts:57 (opens in a new tab)