Navisworks: Appearance¶
14 nodes. Types ending in [] are lists. An input with a default is optional.
Nodes¶
Appearance.ColorByValues¶
One-node color-coding: pairs each item with its value, colors each distinct value (categorical palette, or a blue→red gradient when every value is numeric) and outputs the legend. The colours are permanent overrides, saved with the file; Appearance.ColorByValuesTemporary does the same as a temporary override that Viewpoint.Save can bake into a saved viewpoint.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to color. |
values required |
any[] |
— | One value per item (same length as items) — the color key. |
palette |
any[] |
null |
Colors to cycle through per distinct value (null uses a built-in palette; all-numeric values get a blue→red gradient instead). |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type |
|---|---|
items |
ModelItem[] |
legend |
dict |
Returns: The colored items and a value → "#RRGGBB" legend for reporting.
Tags: appearance color values legend heatmap code byvalue
Appearance.ColorByValuesTemporary¶
Like Appearance.ColorByValues, but the colours are TEMPORARY (viewpoint-scoped) overrides: nothing is written into the file, Viewpoint.Save with bakeOverrides on keeps them in a saved viewpoint (colour by clash status or by level, one view each), and Appearance.ResetTemporary clears them. Pairs each item with its value, colors each distinct value (categorical palette, or a blue→red gradient when every value is numeric) and outputs the legend.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to color. |
values required |
any[] |
— | One value per item (same length as items) — the color key. |
palette |
any[] |
null |
Colors to cycle through per distinct value (null uses a built-in palette; all-numeric values get a blue→red gradient instead). |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type |
|---|---|
items |
ModelItem[] |
legend |
dict |
Returns: The colored items and a value → "#RRGGBB" legend for reporting.
Tags: appearance color values legend heatmap code byvalue temporary viewpoint status
Appearance.Focus¶
Focus on some items: they stay as they are and everything else in the model fades by otherTransparency percent (0 = opaque, 100 = invisible) with a TEMPORARY transparency override — the Action.Ghost look in one node, no permanent change. With resetFirst on, every temporary override is cleared first; undo it later with Appearance.ResetTemporary. The scale is percent here; Appearance.OverrideTransparencyTemporary and Action.Ghost take 0 to 1. Touches every item in the model, so allow a moment on large models.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The items to focus on. |
otherTransparency |
number |
85 |
How transparent everything else becomes, from 0 (opaque) to 100 (invisible). |
resetFirst |
boolean |
true |
True clears every temporary override before ghosting, so each run starts clean. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The focused items (pass-through). |
Tags: appearance focus ghost fade transparency context highlight isolate temporary
Appearance.Hide¶
Hides model items in the viewport.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to hide. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The hidden items (pass-through). |
Tags: appearance hide hidden invisible
Appearance.Isolate¶
Shows only these items and hides everything else (undo with Appearance.ShowAll). An empty list does nothing and the node shows a warning: isolating nothing would hide the whole model, and an empty search result is the usual cause.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to isolate. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The isolated items (pass-through). |
Tags: appearance isolate only hide focus
Appearance.OverrideColor¶
Overrides the color of model items (a permanent override: saved with the file and undoable).
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to recolor. |
color required |
any |
— | A Color, a "#RRGGBB" string, or a list of three numbers. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The recolored items (pass-through). |
Tags: appearance color override paint tint
Appearance.OverrideColorTemporary¶
Applies a TEMPORARY (viewpoint-scoped) color override — unlike Appearance.OverrideColor (a single global permanent override), a temporary override is what Viewpoint.SaveWithOverrides bakes into each saved view, so every viewpoint keeps its own coloring. Clear with Appearance.ResetTemporary.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to recolor. |
color required |
any |
— | A Color, a "#RRGGBB" string, or a list of three numbers. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The recolored items (pass-through). |
Tags: appearance color temporary highlight viewpoint override runtime
Appearance.OverrideTransparency¶
Overrides the transparency of model items, from 0 (opaque) to 1 (invisible). Appearance.Focus takes percent (0 to 100) instead.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to change. |
transparency required |
number |
— | 0 = fully opaque, 1 = fully transparent. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The changed items (pass-through). |
Tags: appearance transparency override ghost opacity
Appearance.OverrideTransparencyTemporary¶
Applies a TEMPORARY (viewpoint-scoped) transparency override (from 0 = opaque to 1 = invisible; Appearance.Focus takes percent, 0 to 100) — the ghosting that Viewpoint.SaveWithOverrides bakes into each saved view. Fade 'the other' items so the highlighted one stands out. Clear with Appearance.ResetTemporary.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to change. |
transparency required |
number |
— | 0 = fully opaque, 1 = fully transparent. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The changed items (pass-through). |
Tags: appearance transparency temporary ghost fade viewpoint runtime
Appearance.Reset¶
Removes permanent color and transparency overrides from model items, restoring their original materials.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to reset. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The reset items (pass-through). |
Tags: appearance reset restore original materials
Appearance.ResetAll¶
Removes every permanent color/transparency override in the model — a clean slate before re-coloring.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
done |
boolean |
True when the overrides were cleared. |
Tags: appearance reset all clear clean
Appearance.ResetTemporary¶
Clears every TEMPORARY color/transparency override in the model — a clean slate before highlighting the next item. Does not touch permanent overrides (Appearance.OverrideColor) or already-saved viewpoints. Wire anything into 'after' to place this INSIDE a loop: without an input the node has nothing to depend on, so it runs once outside the loop body. Per iteration it keeps each saved viewpoint carrying only its own highlighting instead of every earlier iteration's as well.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
after |
any |
null |
Anything at all, passed straight back out. Its only job is to give this node an input, so it can sit inside a loop body and run once per iteration — a node with no inputs depends on nothing and runs once, outside the loop. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type |
|---|---|
done |
boolean |
after |
any |
Returns: True once the temporary overrides are cleared, plus whatever was wired into "after" — chain that onward to run the rest of the iteration after the reset.
Tags: appearance reset temporary clear clean runtime highlight loop
Appearance.Show¶
Shows (un-hides) model items in the viewport.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
items any number of wires required |
ModelItem[] |
— | The model items to show. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
items |
ModelItem[] |
The shown items (pass-through). |
Tags: appearance show unhide visible
Appearance.ShowAll¶
Shows (un-hides) every item in the model — undoes Appearance.Hide and Appearance.Isolate.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
done |
boolean |
True when the hidden flags were cleared. |
Tags: appearance show all unhide reveal isolate