Class AcLyLayerFilterTree

In-memory tree of Layer Manager filters for a drawing database.

Mirrors the AutoCAD .NET LayerFilterTree wrapper around the ObjectARX AcLy* filter hierarchy. The tree is typically accessed through AcDbDatabase.layerFilters.

Remarks

AutoCAD exposes the tree by value: callers should get the tree, mutate root / nested filters, then assign it back to the database.

See

https://help.autodesk.com/view/OARX/2024/ENU/?guid=OARX-RefGuide-AcLy_Classes

Example

const tree = db.layerFilters;
const unlocked = new AcLyLayerFilter();
unlocked.name = 'Unlocked Layers';
unlocked.setFilterExpression('LOCKED=="False"');
tree.root.addNested(unlocked);
db.layerFilters = tree;

Index

Constructors

constructor

new AcLyLayerFilterTree(
root?: AcLyLayerFilter,
current?: null | AcLyLayerFilter,
): AcLyLayerFilterTree
Creates a new AcLyLayerFilterTree.
Parameters
- Optionalroot: AcLyLayerFilter
  Root filter. When omitted, a default "All" root is created.
- Optionalcurrent: null | AcLyLayerFilter
  Currently active filter (defaults to root).
Returns AcLyLayerFilterTree
- Defined in packages/data-model/src/ly/AcLyLayerFilterTree.ts:38

Accessors

current

get current(): null | AcLyLayerFilter
Gets the currently active filter.

Returns null | AcLyLayerFilter
The current filter, or null.
- Defined in packages/data-model/src/ly/AcLyLayerFilterTree.ts:71
set current(value: null | AcLyLayerFilter): void
Sets the currently active filter.
Parameters
- value: null | AcLyLayerFilter
  Filter to make current, or null.
Returns void
- Defined in packages/data-model/src/ly/AcLyLayerFilterTree.ts:80

root

get root(): AcLyLayerFilter
Gets the root filter of this tree.

Returns AcLyLayerFilter
The root AcLyLayerFilter.
- Defined in packages/data-model/src/ly/AcLyLayerFilterTree.ts:62

Methods

clone

clone(): AcLyLayerFilterTree
Creates a shallow copy of this tree that shares the same filter instances.

Returns AcLyLayerFilterTree
A new AcLyLayerFilterTree.

Remarks
Useful when following AutoCAD's by-value Database.LayerFilters pattern.
- Defined in packages/data-model/src/ly/AcLyLayerFilterTree.ts:92

`Static`createDefaultRoot

createDefaultRoot(): AcLyLayerFilter
Creates the default root property filter used by AutoCAD (All).

Returns AcLyLayerFilter
A root AcLyLayerFilter.
- Defined in packages/data-model/src/ly/AcLyLayerFilterTree.ts:48

Class AcLyLayerFilterTree

Remarks

See

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcLyLayerFilterTree

Accessors

current

Returns null | AcLyLayerFilter

Parameters

Returns void

root

Returns AcLyLayerFilter

Methods

clone

Returns AcLyLayerFilterTree

Remarks

`Static`createDefaultRoot

Returns AcLyLayerFilter

Settings

On This Page

Class AcLyLayerFilterTree

Remarks

See

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcLyLayerFilterTree

Accessors

current

Returns null | AcLyLayerFilter

Parameters

Returns void

root

Returns AcLyLayerFilter

Methods

clone

Returns AcLyLayerFilterTree

Remarks

StaticcreateDefaultRoot

Returns AcLyLayerFilter

Settings

On This Page

`Static`createDefaultRoot