Tag

A tag (formerly “layer”) that controls the visibility of drawing elements in the model.

Tags let users show or hide groups of geometry together — for example, tagging all furniture so it can be toggled on or off at once. Retrieve a tag by name with model.getTagManager().findTag(), or create new tags inside a performOperation with op.createTag().

Example

let model = await SketchUpApi.getActiveModel();

// Create a tag and assign it a color
await model.performOperation(op => {
  const ref = op.createTag('Furniture');
  op.tagSetColor(
    ref, new SketchUpApi.Color(76, 175, 80)
  );
}, 'Create Furniture tag');

// Read it back
let tm = await model.getTagManager();
let tag = await tm.findTag('Furniture');
console.log(tag.name);
// => 'Furniture'
console.log(tag.color.toHex());
// => '#4CAF50FF'

See

Properties

attributes

readonly attributes: Attributes

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

color

readonly color: Color

The indicator color shown next to this tag in the Tags panel.

folderRef

readonly folderRef: TagFolderRef | undefined

A reference to the folder this tag belongs to, or undefined if it is in the root.

id

readonly id: number

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

name

readonly name: string

The user-visible name of this tag, like 'Furniture'.

type

readonly type: Tag = EntityType.Tag

visible

readonly visible: boolean

Whether geometry assigned to this tag is currently visible.

Accessors

sketchupId

Get Signature

get sketchupId(): SketchupId

JS API identifier for this tag. 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

getFolder()

getFolder(): Promise<TagFolder | undefined>

Fetches the folder this tag belongs to, or undefined if the tag is in the root (not inside any folder).

Returns

Promise<TagFolder | undefined>

Since

SDK 2.30.0

refresh()

refresh(): Promise<Tag>

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

Returns

Promise<Tag>

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>