model | vjgeo

Functions

addCaption

addCaption(modelContext: IModel, text: string, leftAnchorPoint?: IPoint, rightAnchorPoint?: IPoint): IModel

向模型添加标题对象.

Parameters
- modelContext: IModel
  
  The model to add to.
- text: string
  
  Text to add.
- Optional leftAnchorPoint: IPoint
  
  文本左侧中间的可选点.
- Optional rightAnchorPoint: IPoint
  
  文本右侧中间的可选点.
Returns IModel

The original model (for cascading).

addModel

addModel(parentModel: IModel, childModel: IModel, childModelId: string, overWrite?: boolean): IModel

将模型添加为子模型:
```
parentModel.models[childModelId] = childModel;
```
Parameters
- parentModel: IModel
  
  The model to add to.
- childModel: IModel
  
  The model to add.
- childModelId: string
  
  The id of the child model.
- Default value overWrite: boolean = false
  
  用于覆盖子模型 ID 引用的任何模型的可选标志。默认值为 false，这将创建一个类似于 childModelId 的 id.
Returns IModel

The original model (for cascading).

addPath

addPath(modelContext: IModel, pathContext: IPath, pathId: string, overWrite?: boolean): IModel

添加路径作为子路径:
```
parentModel.paths[childPathId] = childPath;
```
with additional checks to make it safe for cascading.
Parameters
- modelContext: IModel
  
  The model to add to.
- pathContext: IPath
  
  The path to add.
- pathId: string
  
  The id of the path.
- Default value overWrite: boolean = false
  
  Optional 标志以覆盖 pathId 引用的任何路径。默认值为 false，这将创建一个类似于 pathId 的 id.
Returns IModel

The original model (for cascading).

addTo

addTo(childModel: IModel, parentModel: IModel, childModelId: string, overWrite?: boolean): IModel

将一个模型添加为另一个模型的子模型.
```
parentModel.models[childModelId] = childModel;
```
Parameters
- childModel: IModel
  
  The model to add.
- parentModel: IModel
  
  The model to add to.
- childModelId: string
  
  The id of the child model.
- Default value overWrite: boolean = false
  
  Optional 标志以覆盖子模型 ID 引用的任何模型。默认值为 false，这将创建一个类似于 childModelId 的 id.
Returns IModel

The original model (for cascading).

breakPathsAtIntersections

breakPathsAtIntersections(modelToBreak: IModel, modelToIntersect?: IModel): IModel

断开模型与另一路径相交的路径.

Parameters
- modelToBreak: IModel
  
  包含要断开的路径的模型.
- Optional modelToIntersect: IModel
  
  包含查找交集的路径的可选模型，否则将使用 modelToBreak.
Returns IModel

The original model (for cascading).

center

center(modelToCenter: IModel, centerX?: boolean, centerY?: boolean): IModel

将模型居中 [0， 0].

Parameters
- modelToCenter: IModel
  
  The model to center.
- Default value centerX: boolean = true
  
  Boolean 以 X 轴为中心。默认值为 true.
- Default value centerY: boolean = true
  
  Boolean 以 y 轴为中心。默认值为 true.
Returns IModel

The original model (for cascading).

clone

clone(modelToClone: IModel): IModel

克隆模型。别名 vjgeo.cloneObject（modelToClone）

Parameters
- modelToClone: IModel
  
  The model to clone.
Returns IModel

A clone of the model you passed.

combine

combine(modelA: IModel, modelB: IModel, includeAInsideB?: boolean, includeAOutsideB?: boolean, includeBInsideA?: boolean, includeBOutsideA?: boolean, options?: ICombineOptions): IModel

组合 2 个模型。每个模型都将相应地修改.

Parameters
- modelA: IModel
  
  第一个组合模型.
- modelB: IModel
  
  第二个要组合的模型.
- Default value includeAInsideB: boolean = false
  
  标志以包含模型 A 中位于模型 B 内部的路径.
- Default value includeAOutsideB: boolean = true
  
  标志以包含模型 A 中位于模型 B 外部的路径.
- Default value includeBInsideA: boolean = false
  
  标志以包含模型 B 中位于模型 A 内部的路径.
- Default value includeBOutsideA: boolean = true
  
  标志以包含模型 B 中位于模型 A 外部的路径.
- Optional options: ICombineOptions
  
  可选 ICombineOptions 对象.
Returns IModel

包含“a”和“b”两个输入模型的新模型.

combineIntersection

combineIntersection(modelA: IModel, modelB: IModel): IModel

合并 2 个模型，产生相交。每个模型都将相应地修改.

Parameters
- modelA: IModel
  
  第一个组合模型.
- modelB: IModel
  
  第二个要组合的模型.
Returns IModel

包含“a”和“b”两个输入模型的新模型.

combineSubtraction

combineSubtraction(modelA: IModel, modelB: IModel): IModel

合并 2 个模型，结果从 A 中减去 B。每个模型都将相应地修改.

Parameters
- modelA: IModel
  
  第一个组合模型.
- modelB: IModel
  
  第二个要组合的模型.
Returns IModel

包含“a”和“b”两个输入模型的新模型.

combineUnion

combineUnion(modelA: IModel, modelB: IModel): IModel

合并 2 个模型，形成一个联合。每个模型都将相应地修改.

Parameters
- modelA: IModel
  
  第一个组合模型.
- modelB: IModel
  
  第二个要组合的模型.
Returns IModel

包含“a”和“b”两个输入模型的新模型.

convertUnits

convertUnits(modeltoConvert: IModel, destUnitType: string): IModel

转换模型以匹配不同的单位系统.

Parameters
- modeltoConvert: IModel
  
  The model to convert.
- destUnitType: string
  
  The unit system.
Returns IModel

The scaled model (for cascading).

countChildModels

countChildModels(modelContext: IModel): number

计算给定模型中子模型的数量.

Parameters
- modelContext: IModel
  
  The model containing other models.
Returns number

Number of child models.

data

data(modelContext: IModel, data: IProperties): IModel

设置模型的属性数据。
```
modelContext.data = data;
```
Parameters
- modelContext: IModel
  
  The model to set the properties.
- data: IProperties
  
  The data
Returns IModel

The original model (for cascading).

distort

distort(modelToDistort: IModel, scaleX: number, scaleY: number, scaleOrigin?: boolean, bezierAccuracy?: number): IModel

模型的扭曲 - 分别缩放 x 和 y.

Parameters
- modelToDistort: IModel
  
  The model to distort.
- scaleX: number
  
  x 缩放量.
- scaleY: number
  
  y 缩放量.
- Default value scaleOrigin: boolean = false
  
  用于缩放原点的可选布尔值。对于根模型通常为 false，通常为 false。.
- Optional bezierAccuracy: number
  
  贝塞尔曲线的可选精度.
Returns IModel

New model (for cascading).

expandPaths

expandPaths(modelToExpand: IModel, distance: number, joints?: number, combineOptions?: ICombineOptions): IModel

展开模型中的所有路径，然后合并生成的扩展.

Parameters
- modelToExpand: IModel
  
  Model to expand.
- distance: number
  
  Distance to expand.
- Default value joints: number = 0
  
  路径之间关节处的点数。圆接头使用 0，尖头接头使用 1，斜面接头使用 2.
- Default value combineOptions: ICombineOptions = {}
  
  Optional object containing combine options.
Returns IModel

围绕原始模型路径的模型.

findChains

findChains(modelContext: IModel, options?: IFindChainsOptions): IChain[] | IChainsMap
findChains(modelContext: IModel, callback: IChainCallback, options?: IFindChainsOptions): IChain[] | IChainsMap

查找具有公共终结点和表单链的路径.

Parameters
- modelContext: IModel
  
  The model to search for chains.
- Optional options: IFindChainsOptions
  
  Optional options object.
Returns IChain[] | IChainsMap

链的数组，或链数组的映射（由层 ID 键控） - 如果 options.byLayers 为 true.
查找具有公共终结点和表单链的路径.

Parameters
- modelContext: IModel
  
  The model to search for chains.
- callback: IChainCallback
  
  Callback function when chains are found.
- Optional options: IFindChainsOptions
  
  Optional options object.
Returns IChain[] | IChainsMap

链的数组，或链数组的映射（由层 ID 键控） - 如果 options.byLayers 为 true.

findSingleChain

findSingleChain(modelContext: IModel): IChain

在模型内跨所有层查找单个链。查找链的简写;当您知道模型中只有一个链要查找时很有用.

Parameters
- modelContext: IModel
  
  用于搜索链的模型.
Returns IChain

链对象或空（如果未找到链）.

getAllCaptionsOffset

getAllCaptionsOffset(modelContext: IModel): (ICaption & { layer?: string })[]

获取此模型中处于绝对位置的所有 Caption 对象及其子模型.

Parameters
- modelContext: IModel
  
  The model to search for Caption objects.
Returns (ICaption & { layer?: string })[]

Array of Caption objects.

getSimilarModelId

getSimilarModelId(modelContext: IModel, modelId: string): string

在模型映射中获取具有相同前缀的未使用 id.

Parameters
- modelContext: IModel
  
  The model containing the models map.
- modelId: string
  
  直接使用的 id（如果未使用）或用作前缀.
Returns string

getSimilarPathId

getSimilarPathId(modelContext: IModel, pathId: string): string

在路径映射中获取具有相同前缀的未使用 ID.

Parameters
- modelContext: IModel
  
  The model containing the paths map.
- pathId: string
  
  直接使用（如果未使用）或作为前缀的 id。
Returns string

layer

layer(modelContext: IModel, layer: string): IModel

设置模型的图层名称。
```
modelContext.layer = layer;
```
Parameters
- modelContext: IModel
  
  The model to set the layer.
- layer: string
  
  The layer name.
Returns IModel

The original model (for cascading).

mirror

mirror(modelToMirror: IModel, mirrorX: boolean, mirrorY: boolean): IModel

创建模型的克隆，在 x 轴和 y 轴上或两个轴上镜像.

Parameters
- modelToMirror: IModel
  
  The model to mirror.
- mirrorX: boolean
  
  Boolean 在 X 轴上镜像.
- mirrorY: boolean
  
  Boolean 在 Y 轴上镜像.
Returns IModel

Mirrored model.

move

move(modelToMove: IModel, origin: IPoint): IModel

将模型移动到绝对点。请注意，这也是通过直接设置 origin 属性来实现的。此函数用于级联.

Parameters
- modelToMove: IModel
  
  The model to move.
- origin: IPoint
  
  The new position of the model.
Returns IModel

The original model (for cascading).

moveRelative

moveRelative(modelToMove: IModel, delta: IPoint): IModel

按相对量移动模型的原点.

Parameters
- modelToMove: IModel
  
  The model to move.
- delta: IPoint
  
  作为点对象的 x 和 y 调整.
Returns IModel

The original model (for cascading).

originate

originate(modelToOriginate: IModel, origin?: IPoint): IModel

将模型的所有子项（模型和路径，递归方式）移动到同一个坐标空间。当子点之间的点需要相互连接时很有用.

Parameters
- modelToOriginate: IModel
  
  The model to originate.
- Optional origin: IPoint
  
  Optional offset reference point.
Returns IModel

The original model (for cascading).

outline

outline(modelToOutline: IModel, distance: number, joints?: number, inside?: boolean, options?: ICombineOptions): IModel

按指定的距离勾勒模型轮廓。

Parameters
- modelToOutline: IModel
  
  Model to outline.
- distance: number
  
  Distance to outline.
- Default value joints: number = 0
  
  路径之间关节处的点数。圆接头使用 0，尖头接头使用 1，斜面接头使用 2.
- Default value inside: boolean = false
  
  可选的布尔值，用于在模型内部而不是外部绘制线条.
- Default value options: ICombineOptions = {}
  
  Options to send to combine() function.
Returns IModel

Model which surrounds the paths outside of the original model.

prefixPathIds

prefixPathIds(modelToPrefix: IModel, prefix: string): IModel

为模型中路径的 id 添加前缀.

Parameters
- modelToPrefix: IModel
  
  The model to prefix.
- prefix: string
  
  The prefix to prepend on paths ids.
Returns IModel

The original model (for cascading).

removeDeadEnds

removeDeadEnds(modelContext: IModel, pointMatchingDistance?: number, keep?: IWalkPathBooleanCallback, trackDeleted?: (wp: IWalkPath, reason: string) => void): IModel

从具有未连接到其他路径的端点的模型中删除路径.

Parameters
- modelContext: IModel
  
  The model to search for dead ends.
- Optional pointMatchingDistance: number
  
  可选最大距离，可将两个点视为相同.
- Optional keep: IWalkPathBooleanCallback
  
  可选的回调函数（应返回布尔值）来决定是否应保留路径.
- Optional trackDeleted: (wp: IWalkPath, reason: string) => void
  
  可选的回调函数，将记录丢弃的路径及其被丢弃的原因.
  - - (wp: IWalkPath, reason: string): void
    - Parameters
      - wp: IWalkPath
      - reason: string
      Returns void
Returns IModel

The input model (for cascading).

rotate

rotate(modelToRotate: IModel, angleInDegrees: number, rotationOrigin?: IPoint): IModel

旋转模型.

Parameters
- modelToRotate: IModel
  
  The model to rotate.
- angleInDegrees: number
  
  旋转量，以度为单位.
- Default value rotationOrigin: IPoint = [0, 0]
  
  旋转中心点.
Returns IModel

The original model (for cascading).

scale

scale(modelToScale: IModel, scaleValue: number, scaleOrigin?: boolean, basePoint?: IPoint, isBasePointRelative?: boolean): IModel

缩放模型.

Parameters
- modelToScale: IModel
  
  The model to scale.
- scaleValue: number
  
  缩放量.
- Default value scaleOrigin: boolean = false
  
  用于缩放原点的可选布尔值。对于根模型通常为 false，通常为 false。.
- Optional basePoint: IPoint
  
  缩放的基点.
- Optional isBasePointRelative: boolean
  
  缩放的基点是否是相对于模型的坐标（没有包含origin). 默认是绝对坐标.
Returns IModel

The original model (for cascading).

simplify

simplify(modelToSimplify: IModel, options?: ISimplifyOptions): IModel

通过减少冗余来简化模型的路径：将多个重叠路径合并为一条路径。

Parameters
- modelToSimplify: IModel
- Optional options: ISimplifyOptions
  
  Optional options object.
Returns IModel

The simplified model (for cascading).

walk

walk(modelContext: IModel, options: IWalkOptions): IModel

递归遍历给定模型的所有子模型和路径.

Parameters
- modelContext: IModel
  
  The model to walk.
- options: IWalkOptions
  
  Object containing callbacks.
Returns IModel

The original model (for cascading).

zero

zero(modelToZero: IModel, zeroX?: boolean, zeroY?: boolean): IModel

移动模型，使其边界框从 [0， 0] 开始.

Parameters
- modelToZero: IModel
  
  The model to zero.
- Default value zeroX: boolean = true
  
  Boolean to zero on the x axis. Default is true.
- Default value zeroY: boolean = true
  
  Boolean to zero on the y axis. Default is true.
Returns IModel

The original model (for cascading).

Index

Functions

Functions

addCaption

Parameters

modelContext: IModel

text: string

Optional leftAnchorPoint: IPoint

Optional rightAnchorPoint: IPoint

Returns IModel

addModel

Parameters

parentModel: IModel

childModel: IModel

childModelId: string

Default value overWrite: boolean = false

Returns IModel

addPath

Parameters

modelContext: IModel

pathContext: IPath

pathId: string

Default value overWrite: boolean = false

Returns IModel

addTo

Parameters

childModel: IModel

parentModel: IModel

childModelId: string

Default value overWrite: boolean = false

Returns IModel

breakPathsAtIntersections

Parameters

modelToBreak: IModel

Optional modelToIntersect: IModel

Returns IModel

center

Parameters

modelToCenter: IModel

Default value centerX: boolean = true

Default value centerY: boolean = true

Returns IModel

clone

Parameters

modelToClone: IModel

Returns IModel

combine

Parameters

modelA: IModel

modelB: IModel

Default value includeAInsideB: boolean = false

Default value includeAOutsideB: boolean = true

Default value includeBInsideA: boolean = false

Default value includeBOutsideA: boolean = true

Optional options: ICombineOptions

Returns IModel

combineIntersection

Parameters

modelA: IModel

modelB: IModel

Returns IModel

combineSubtraction

Parameters

modelA: IModel

modelB: IModel

Returns IModel

combineUnion

Parameters

modelA: IModel

modelB: IModel

Returns IModel

convertUnits

Parameters

modeltoConvert: IModel

destUnitType: string

Returns IModel

countChildModels

Parameters

modelContext: IModel

Returns number