TagFolder

A named group of tags that organizes them into collapsible sections in the Tags panel.

Tag folders help manage models with many tags — for example, grouping 'Plumbing', 'Electrical', and 'HVAC' tags under an 'MEP' folder. Get a folder by name with model.getTagManager().getTagFolderByName(), or create one with op.createTagFolder() inside a performOperation.

Example

let model = await SketchUpApi.getActiveModel();

// Create a folder containing MEP tags
await model.performOperation(op => {
  const ref = op.createTagFolder('MEP');
  op.createTag('Plumbing', ref);
  op.createTag('Electrical', ref);
}, 'Create MEP tag folder');

// Read it back
let tm = await model.getTagManager();
let folder = await tm.getTagFolderByName('MEP');
console.log(folder.name);
// => 'MEP'
console.log(folder.tags.length);
// => 2

See

Properties

attributes

readonly attributes: Attributes

User-defined key-value data attached to this folder.

folderRef

readonly folderRef: TagFolderRef | undefined

A reference to the parent folder, or undefined if this folder is at the root level.

id

readonly id: number

The persistent numeric identifier for this folder, stable across sessions.

name

readonly name: string

The user-visible name of this folder, like 'MEP'.

tagFolders

readonly tagFolders: readonly TagFolder[]

The nested tag folders directly inside this folder.

type

readonly type: TagFolder = EntityType.TagFolder

visible

readonly visible: boolean

Whether tags inside this folder are currently visible.

Accessors

sketchupId

Get Signature

get sketchupId(): SketchupId

JS API identifier for this folder. Pass it to API methods that accept a sketchupId.

Returns

SketchupId

typeName

Get Signature

get typeName(): string

Returns a named variant of the type field.

Since

SDK 2.35.0

Returns

string

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

getFolder()

getFolder(): Promise<TagFolder | undefined>

Fetches the parent folder this folder belongs to, or undefined if it is at the root level.

Returns

Promise<TagFolder | undefined>

Since

SDK 2.30.0

refresh()

refresh(): Promise<TagFolder>

Re-fetches this folder from SketchUp to pick up any changes made since this snapshot was taken.

Returns

Promise<TagFolder>

toString()

toString(): string

Returns

string

Show Deprecated

Deprecated

folderId

readonly folderId: number | undefined

The persistent id of the parent TagFolder instance

folder

Get Signature

get folder(): Promise<TagFolder | undefined>

Returns

Promise<TagFolder | undefined>

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