Skip to content

pixso.variables

这些 API 定义在 pixso.variables 上。

getVariableByIdAsync

typescript
getVariableByIdAsync(id: string): Promise<VariableNode | null>

根据 ID 查找变量。如果未找到或提供的 ID 无效,则返回一个包含 null 的 promise。

getVariableCollectionByIdAsync

typescript
getVariableCollectionByIdAsync(id: string): Promise<VariableCollection | null>

根据 ID 查找变量集合。如果未找到或提供的 ID 无效,则返回一个包含 null 的 promise。

getLocalVariablesAsync

typescript
getLocalVariablesAsync(type?: VariableResolvedDataType): Promise<Variable[]>

获取当前文件中的所有本地变量。

getLocalVariableCollectionsAsync

typescript
getLocalVariableCollectionsAsync(): Promise<VariableCollection[]>

获取当前文件中的所有本地变量集合。

createVariable

typescript
createVariable(name: string, collection: VariableCollection, resolvedType: VariableResolvedDataType): Variable

在变量集合中创建一个变量。

createVariableCollection

typescript
createVariableCollection(name: string): VariableCollection

创建一个变量集合。

createVariableAlias

typescript
createVariableAlias(variable: Variable): VariableAlias

创建一个变量别名。

createVariableAliasByIdAsync

typescript
createVariableAliasByIdAsync(variableId: string): Promise<VariableAlias>

创建一个变量别名。

setBoundVariableForPaint

typescript
setBoundVariableForPaint(paint: SolidPaint, field: VariableBindablePaintField, variable: Variable | null): SolidPaint

将一个变量绑定到 SolidPaint。如果提供的变量为 null,则给定的字段将解除与任何变量的绑定。

setBoundVariableForEffect

typescript
setBoundVariableForEffect(effect: Effect, field: VariableBindableEffectField, variable: Variable | null): Effect

将一个变量绑定到 Effect。如果提供的变量为 null,则给定的字段将解除与任何变量的绑定。

setBoundVariableForLayoutGrid

typescript
setBoundVariableForLayoutGrid(layoutGrid: LayoutGrid, field: VariableBindableLayoutGridField, variable: Variable | null): LayoutGrid

将一个变量绑定到 LayoutGrid。如果提供的变量为 null,则给定的字段将解除与任何变量的绑定。

importVariableByKeyAsync

typescript
importVariableByKeyAsync(key: string): Promise<Variable>

从团队库中加载一个变量。如果未找到或提供的 key 无效,则返回一个包含 null 的 promise。