TagManager

A snapshot of all tags and tag folders in the model.

Retrieve it with model.getTagManager(). Use it to look up tags or folders by name, or iterate over all tags in the model.

Example

let model = await SketchUpApi.getActiveModel();
let tm = await model.getTagManager();

console.log(tm.tags.length);
// => total number of tags in the model

// Find a tag by name
let tag = tm.findTag('Furniture');
console.log(tag?.visible);
// => true or false

See

Properties

attributes

readonly attributes: Attributes

User-defined key-value data attached to the tag manager.

tagFolders

readonly tagFolders: readonly TagFolder[]

All top-level tag folders in the model.

type

readonly type: TagManager = EntityType.TagManager

Methods

findTag()

findTag(name): Tag | undefined

Finds a tag by name across all root-level tags. Returns undefined if no tag with that name exists at the root.

Parameters

Parameter	Type
`name`	`string`

Returns

Tag | undefined

Since

SDK 2.35.0

findTagFolder()

findTagFolder(name): TagFolder | undefined

Finds a top-level tag folder by name. Returns undefined if no folder with that name exists at the root.

Parameters

Parameter	Type
`name`	`string`

Returns

TagFolder | undefined

Since

SDK 2.35.0

refresh()

refresh(): Promise<TagManager>

Re-fetches the tag manager from SketchUp to pick up any changes the user has made since this snapshot was taken.

Returns

Promise<TagManager>

toString()

toString(): string

Returns

string

Show Deprecated

Deprecated

getTagByName()

getTagByName(name): Tag | undefined

Parameters

Parameter	Type	Description
`name`	`string`	‐

Returns

Tag | undefined

getTagFolderByName()

getTagFolderByName(name): TagFolder | undefined

Parameters

Parameter	Type	Description
`name`	`string`	‐

Returns

TagFolder | undefined