VariableCollection

Variable Collection properties

变量集合是相关变量对象的集合，每个对象都有相同的模式。

id

id: string [readonly]

变量集合的唯一标识符。

name

name: string

变量集合的名称。

hiddenFromPublishing

hiddenFromPublishing: boolean

是否在发布当前文件为库时隐藏该变量集合。只有当 remote 为 false（例如这是一个本地变量集合）时才能为 true。

getPublishStatusAsync

getPublishStatusAsync(): Promise<PublishStatus>

返回当前文件中此变量集合的发布状态。

remote

remote: boolean [readonly]

获取当前变量集合是否为远程变量集合或本地变量集合。

modes

modes: Array<{ modeId: string; name: string }> [readonly]

为此变量集合定义的模式列表。

variableIds

variableIds: string[] [readonly]

此变量集合中包含的变量列表。请注意，这些变量的顺序与 Pixso Design 中显示的大致相同，但不考虑分组。因此，这些变量的顺序可能无法完全反映创作 UI 中显示的确切顺序和分组。

defaultModeId

defaultModeId: string [readonly]

此集合的默认模式 ID。

key

key: string [readonly]

与 getVariablesInLibraryCollectionAsync 一起使用的键。请注意，虽然此键存在于本地和已发布的变量集合上，但 TeamLibaryAPI 只能用于查询已发布的变量集合的变量。

remove

remove(): void

从文档中删除此变量集合及其所有变量。

removeMode

removeMode(modeId: string): void

通过 ID 删除给定的模式。

addMode

addMode(name: string): string

向此集合添加具有给定名称的新模式。返回新创建的模式 ID。

renameMode

renameMode(modeId: string, newName: string): void

重命名给定的模式。

Plugin data properties

getPluginData

getPluginData(key: string): string

使用 setPluginData 存储在节点或样式上的自定义信息。如果未存储提供键的数据，则返回空字符串。

setPluginData

setPluginData(key: string, value: string): void

允许您在任何节点或样式上存储自定义信息，对您的插件来说是私有的。您的条目（pluginId、key、value）的总大小不能超过 100 kB。

getPluginDataKeys

getPluginDataKeys(): string[]

使用 setPluginData 存储在节点或样式上的自定义信息。此操作允许您遍历存储在节点或样式上的所有私有数据。

getSharedPluginData

getSharedPluginData(namespace: string, key: string): string

使用 setSharedPluginData 存储在节点或样式上的共享数据。如果未存储提供命名空间和键的数据，则返回空字符串。

setSharedPluginData

setSharedPluginData(namespace: string, key: string, value: string): void

允许您在任何节点上存储自定义信息。您可以使用相同的命名空间和键稍后调用 getSharedPluginData 来检索它。要查找存储在节点上的特定命名空间中的所有数据，请使用 getSharpedPluginDataKeys。

getSharedPluginDataKeys

getSharedPluginDataKeys(namespace: string): string[]

使用 setSharedPluginData 存储在节点或样式上的共享数据。此操作允许您遍历存储在节点或样式上的所有共享数据。