Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISmartbiXUtils

常用工具方法

Hierarchy 层级

  • ISmartbiXUtils

Index 目录

Methods 方法

Methods 方法

decodeBase64

  • decodeBase64(str: string): string

  • 将Base64编码的字符串进行解码

    version

    9.7.0

    since

    9.7.0

    Parameters 参数

    • str: string

      Base64编码的字符串

    Returns 返回值 string

deepClone

  • deepClone(...params: any[]): any

  • 深拷贝一个或多个对象

    version

    9.7.0

    since

    9.7.0

    示例

    let newObj = SmartbiXMacro.utils.deepClone({}, oldObj)

    Parameters 参数

    • Rest ...params: any[]

      对象列表

    Returns 返回值 any

    返回深拷贝后新的对象

encodeBase64

  • encodeBase64(str: string): string

  • 将字符串进行Base64编码

    version

    9.7.0

    since

    9.7.0

    Parameters 参数

    • str: string

      需要编码的字符串

    Returns 返回值 string

equals

  • equals(x: any, y: any): boolean

  • 比较两个对象是否相同

    version

    9.7.0

    since

    9.7.0

    Parameters 参数

    • x: any
    • y: any

    Returns 返回值 boolean

    返回对比的界面，true-相同，false-不相同

formatDate

  • formatDate(date: Date, fmt: string): string

  • 将 Date 转化为指定格式的String (月(M)、日(d)、12小时(h)、24小时(H)、分(m)、秒(s)、周(E)、季度(q)）

    version

    9.7.0

    since

    9.7.0

    示例代码

    可以用 1-2 个占位符 年(y)可以用 1-4 个占位符，毫秒(S)只能用 1 个占位符(是 1-3 位的数字)

// 输出效果：2006-07-02 08:09:04.423
SmartbiXMacro.utils.formatDate(new Date(), "yyyy-MM-dd hh:mm:ss.S")
// 输出效果：2009-03-10 二 20:09:04
SmartbiXMacro.utils.formatDate(new Date(), "yyyy-MM-dd E HH:mm:ss")
// 输出效果：2009-03-10 周二 08:09:04
SmartbiXMacro.utils.formatDate(new Date(), "yyyy-MM-dd EE hh:mm:ss")
// 输出效果：2009-03-10 星期二 08:09:04
SmartbiXMacro.utils.formatDate(new Date(), "yyyy-MM-dd EEE hh:mm:ss")
// 输出效果：2006-7-2 8:9:4.18
SmartbiXMacro.utils.formatDate(new Date(), "yyyy-M-d h:m:s.S")

    Parameters 参数

    • date: Date

      需要格式化的时间

    • fmt: string

      格式字符串

    Returns 返回值 string

    返回格式化后的时间字符串

getJsonValue

  • getJsonValue(obj: any, path: string | string[], defaultValue?: any): any

  • 获取对象的深层属性值

    version

    9.7.0

    since

    9.7.0

    示例

    let obj = {chartDefine: {seriesConfig: {global: {markLine: 'line'}}}}

// 例如：需要获取对象obj中的markLine深层属性的值
let markLine = SmartbiXMacro.utils.getJsonValue(obj, ['chartDefine','seriesConfig','global','markLine'], null)

    Parameters 参数

    • obj: any

      对象

    • path: string | string[]

      深层属性的路径

    • Optional defaultValue: any

      无属性时设置默认值，不是必填项

    Returns 返回值 any

    返回属性的值

transferColor

  • transferColor(color: string, targetType: ColorType | string): string

  • 颜色转换方法

    version

    10.5.0

    since

    10.5.0

    示例代码

    // 方法会自动识别当前的颜色类型，如果不能识别表示暂不支持转换
let orginColor = `rgba(255, 255, 255, 0.5)` // '#FFFFFF','rgb(255,255,255)'
// 转换成rgba
let color = transferColor(orginColor, ColorType.RGBA)
// 转换成rgb
let color = transferColor(orginColor, ColorType.RGB)
// 转换成hex
let color = transferColor(orginColor, ColorType.HEX)
// 转换成透明度
let color = transferColor(orginColor, ColorType.A)

    Parameters 参数

    • color: string

      颜色值

    • targetType: ColorType | string

      目标颜色的格式

    Returns 返回值 string