Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace vjgeo

Root module for geo.

Example: get a reference to geo

Index

Namespaces

Classes

Interfaces

Variables

Functions

Object literals

Variables

environment

environment: string = detectEnvironment()

当前执行环境类型，应为环境类型之一.

Functions

$

  • 创建一个容器以在模型上级联一系列函数。这允许 JQuery 风格的方法链接，例如:

    vjgeo.$(shape).center().rotate(45).$result

    每个函数调用的输出成为下一个函数调用的第一个参数输入. 最后一个函数调用的返回值可通过“.result”属性获得.

    Parameters

    • modelContext: IModel

      执行函数的初始模型.

    Returns ICascadeModel

    具有 ICascadeModel 方法的新级联容器.

  • 创建一个容器以在路径上级联一系列函数。这允许 JQuery 风格的方法链接，例如:

    vjgeo.$(path).center().rotate(90).$result

    每个函数调用的输出成为下一个函数调用的第一个参数输入. 最后一个函数调用的返回值可通过“.result”属性获得.

    Parameters

    • pathContext: IModel

      执行函数的初始路径.

    Returns ICascadePath

    具有 ICascadePath 方法的新级联容器.

  • 创建一个容器以在点上级联一系列函数。这允许 JQuery 风格的方法链接，例如:

    vjgeo.$([1,0]).scale(5).rotate(60).$result

    每个函数调用的输出成为下一个函数调用的第一个参数输入. 最后一个函数调用的返回值可通过“.result”属性获得.

    Parameters

    • pointContext: IPoint

      执行函数的初始点.

    Returns ICascadePoint

    具有 ICascadePoint 方法的新级联容器.

cloneObject

  • cloneObject<T>(objectToClone: T): T

  • 克隆对象。

    Type parameters

    • T

    Parameters

    • objectToClone: T

      The object to clone.

    Returns T

    A new clone of the original object.

createRouteKey

  • createRouteKey(route: string[]): string

  • 创建路由数组的字符串表示形式.

    Parameters

    • route: string[]

      作为路由段的字符串数组.

    Returns string

    数组连接组成的字符串.

extendObject

  • extendObject(target: Object, other: Object): Object

  • 将属性从一个对象复制到另一个对象.

    Example:

    vjgeo.extendObject({ abc: 12 }, { hello: 'world' }); //returns { abc: 12, hello: 'world' }

    Parameters

    • target: Object

      要扩展的对象。它将收到新属性.

    • other: Object

      包含要合并的属性的对象.

    Returns Object

    合并后的原始对象.

isChain

  • isChain(item: any): boolean

  • 测试以查看对象是否实现了链的必需属性.

    Parameters

    • item: any

      The item to test.

    Returns boolean

isFunction

  • isFunction(value: any): boolean

  • 判断变量是否为函数.

    Parameters

    • value: any

      The object to test.

    Returns boolean

    True if the object is a function type.

isModel

  • isModel(item: any): boolean

  • 测试以查看对象是否实现了模型的必需属性.

    Parameters

    • item: any

    Returns boolean

isNumber

  • isNumber(value: any): boolean

  • 判断变量是否为数字.

    Parameters

    • value: any

      The object to test.

    Returns boolean

    True if the object is a number type.

isObject

  • isObject(value: any): boolean

  • 判断变量是否是Object.

    Parameters

    • value: any

      The object to test.

    Returns boolean

    True if the object is an object type.

isObjectNotArray

  • isObjectNotArray(value: any): boolean

  • 判断变量是否是Object并且不是Array.

    Parameters

    • value: any

      The object to test.

    Returns boolean

    True if the object is an object type.

isObjectOrUndefinedNotArray

  • isObjectOrUndefinedNotArray(value: any): boolean

  • 判断变量是否是Object或undefined并且不是Array.

    Parameters

    • value: any

      The object to test.

    Returns boolean

    True if the object is an object type.

isPath

  • isPath(item: any): boolean

  • 判断变量是否为Path对象.

    Parameters

    • item: any

      The item to test.

    Returns boolean

isPathArc

  • isPathArc(item: any): boolean

  • 判断变量是否为PathArc对象.

    Parameters

    • item: any

      The item to test.

    Returns boolean

isPathArcInBezierCurve

  • isPathArcInBezierCurve(item: any): boolean

  • 测试以查看对象是否实现了贝塞尔曲线中弧的必需属性。

    Parameters

    • item: any

      The item to test.

    Returns boolean

isPathCircle

  • isPathCircle(item: any): boolean

  • 判断变量是否为PathCircle对象..

    Parameters

    • item: any

      The item to test.

    Returns boolean

isPathLine

  • isPathLine(item: any): boolean

  • 判断变量是否为Line对象.

    Parameters

    • item: any

      The item to test.

    Returns boolean

isPoint

  • isPoint(item: any): boolean

  • 判断变量是否点.

    Parameters

    • item: any

      The item to test.

    Returns boolean

round

  • round(n: number, accuracy?: number): number

  • 数字四舍五入

    示例：四舍五入到小数点后 3 位

    vjgeo.round(3.14159, .001); //returns 3.142

    Parameters

    • n: number

      要舍入的数字.

    • Default value accuracy: number = 1e-7

      可选的小数位数.

    Returns number

    Rounded number.

splitDecimal

  • splitDecimal(n: number): string[]

  • 将小数部分拆分为整数和小数部分作为字符串.

    示例：获取 80.012 的整部分和小数部分

    vjgeo.splitDecimal(80.012); //returns ["80", "012"]

    Parameters

    • n: number

      要拆分的数字.

    Returns string[]

    当 n 包含小数点时为 2 个字符串的数组，或当 n 为整数时为一个字符串的数组.

travel

  • 沿着模型内的路线以提取其模型树中的特定节点.

    Parameters

    • modelContext: IModel

      内部walk模型.

    • route: string | string[]

      路由的字符串或路由段的字符串数组.

    Returns { offset: IPoint; result: IPath | IModel }

    模型或 Path 对象在模型上下文树中.

Object literals

environmentTypes

environmentTypes: object

Enumeration of environment types.

BrowserUI

BrowserUI: string = "browser"

NodeJs

NodeJs: string = "node"

Unknown

Unknown: string = "unknown"

WebWorker

WebWorker: string = "worker"

pathType

pathType: object

所有路径类型的基于字符串的枚举.

示例：创建圆时使用 pathType 而不是字符串文字.

var circle: IPathCircle = { type: pathType.Circle, origin: [0, 0], radius: 7 };   //typescript
var circle = { type: pathType.Circle, origin: [0, 0], radius: 7 };   //javascript

Arc

Arc: string = "arc"

BezierSeed

BezierSeed: string = "bezier-seed"

Circle

Circle: string = "circle"

Line

Line: string = "line"

unitType

unitType: object

基于字符串的单位类型枚举：公制或其他. 模型可以指定它正在使用的单位制（如果有）。导入模型时，它可能具有不同的单位. 单位转换函数是 vjgeo.units.conversionScale（）.

Centimeter

Centimeter: string = "cm"

Foot

Foot: string = "foot"

Inch

Inch: string = "inch"

Meter

Meter: string = "m"

Millimeter

Millimeter: string = "mm"

Generated using TypeDoc