Class AcLyLayerGroup

Layer group filter (ID filter) used by the Layer Properties Manager.

An AcLyLayerGroup selects layers by object ID rather than by a property expression. Use isIdFilter (always true) to distinguish group filters from property filters.

Nesting rules (AutoCAD Layer Manager behavior):

A group filter may contain other group filters.
A group filter may contain property filters.
A property filter may not contain a group filter (enforced by AcLyLayerFilter.addNested).

Remarks

Mirrors ObjectARX AcLyLayerGroup. Filter expression APIs are unused and return empty / null values.

See

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

Example

const group = new AcLyLayerGroup();
group.name = 'My Layer Group';
group.addLayerId(layer.objectId);

const tree = db.layerFilters;
tree.root.addNested(group); // root may contain groups

const nested = new AcLyLayerGroup();
nested.name = 'Nested Group';
group.addNested(nested); // group may contain groups

Hierarchy (View Summary)

AcLyLayerFilter
- AcLyLayerGroup

Constructors

constructor

new AcLyLayerGroup(): AcLyLayerGroup
Creates a new AcLyLayerGroup instance.

Returns AcLyLayerGroup
Overrides AcLyLayerFilter.constructor
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:45

Accessors

filterExpression

get filterExpression(): string
Gets the property-filter expression string.

Returns string
The filter expression, or an empty string.

Remarks
Mirrors ObjectARX AcLyLayerFilter::filterExpression. Group filters do not use expression strings and return an empty string.
Inherited from AcLyLayerFilter.filterExpression
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:124
set filterExpression(value: string): void
Sets the filter expression via property assignment.
Parameters
- value: string
  Filter expression string.
Returns void
Inherited from AcLyLayerFilter.filterExpression
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:150

layerIdList

get layerIdList(): readonly string[]
Convenience accessor for layer IDs (mirrors .NET LayerIds).

Returns readonly string[]
A read-only array of layer object IDs.
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:79

name

get name(): string
Gets the filter name.

Returns string
The filter name.
Inherited from AcLyLayerFilter.name
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:85
set name(value: string): void
Sets the filter name via property assignment.
Parameters
- value: string
  New filter name.
Returns void
Inherited from AcLyLayerFilter.name
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:111

nestedFilters

get nestedFilters(): readonly AcLyLayerFilter[]
Convenience accessor for nested filters (mirrors .NET NestedFilters).

Returns readonly AcLyLayerFilter[]
A read-only array of nested filters.
Inherited from AcLyLayerFilter.nestedFilters
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:187

Methods

addLayerId

addLayerId(layerId: string): boolean
Adds a layer object ID to this group.
Parameters
- layerId: string
  Layer table record object ID to include.
Returns boolean
true if the ID was added; false if empty or already present.

Remarks
Mirrors ObjectARX AcLyLayerGroup::addLayerId.
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:92

addNested

addNested(filter: AcLyLayerFilter): boolean
Adds a nested child filter under this filter.
Parameters
- filter: AcLyLayerFilter
  Child filter to add.
Returns boolean
true if the child was added.
Remarks
Mirrors ObjectARX AcLyLayerFilter::addNested.

Nesting rules:
- This filter must allowNested.
- The tree root may contain both group and property filters.
- A non-root property filter may not contain a group filter.
- A group filter may contain both group and property filters.
Inherited from AcLyLayerFilter.addNested
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:316

allowDelete

allowDelete(): boolean
Returns whether this filter may be deleted.

Returns boolean
true if deletion is allowed.
Inherited from AcLyLayerFilter.allowDelete
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:234

allowNested

allowNested(): boolean
Returns whether nested filters are allowed under this filter.

Returns boolean
true if nested filters are allowed.

Remarks
Mirrors ObjectARX AcLyLayerFilter::allowNested. Both property and group filters allow nesting by default.
Inherited from AcLyLayerFilter.allowNested
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:225

allowRename

allowRename(): boolean
Returns whether this filter may be renamed.

Returns boolean
true if renaming is allowed.
Inherited from AcLyLayerFilter.allowRename
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:252

compareTo

compareTo(other: undefined | null | AcLyLayerFilter): boolean
Compares this filter to another filter.
Parameters
- other: undefined | null | AcLyLayerFilter
  Filter to compare against.
Returns boolean
true if the filters are considered equal.

Remarks
Mirrors ObjectARX AcLyLayerFilter::compareTo.
Inherited from AcLyLayerFilter.compareTo
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:383

dynamicallyGenerated

dynamicallyGenerated(): boolean
Returns whether this filter was generated dynamically.

Returns boolean
true if dynamically generated.
Inherited from AcLyLayerFilter.dynamicallyGenerated
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:270

filter

filter(layer: AcDbLayerTableRecord): boolean
Tests whether the given layer is a member of this group.
Parameters
- layer: AcDbLayerTableRecord
  Layer table record to test.
Returns boolean
true if the layer ID is in this group.

Remarks
Mirrors ObjectARX AcLyLayerGroup filter behavior: returns true when the layer's object ID is contained in layerIds.
Overrides AcLyLayerFilter.filter
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:131

filterExpressionTree

filterExpressionTree(): null | AcLyBoolExpr
Returns a parsed expression-tree representation of the filter expression.

Returns null | AcLyBoolExpr
An AcLyBoolExpr, or null.

Remarks
Mirrors ObjectARX AcLyLayerFilter::filterExpressionTree. Returns null when no expression is set, or for ID/group filters.
Inherited from AcLyLayerFilter.filterExpressionTree
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:163

generateNested

generateNested(): boolean
Generates nested filters from this filter's expression, when supported.

Returns boolean
true if nested filters were generated.

Remarks
Mirrors ObjectARX AcLyLayerFilter::generateNested. Not implemented beyond API parity; returns false.
Inherited from AcLyLayerFilter.generateNested
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:370

getNestedFilters

getNestedFilters(): readonly AcLyLayerFilter[]
Gets the nested child filters of this filter.

Returns readonly AcLyLayerFilter[]
A read-only array of nested filters.

Remarks
Mirrors ObjectARX AcLyLayerFilter::getNestedFilters.
Inherited from AcLyLayerFilter.getNestedFilters
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:178

isIdFilter

isIdFilter(): boolean
Returns whether this filter is an ID/group filter.

Returns boolean
Always true.

Remarks
Mirrors ObjectARX AcLyLayerFilter::isIdFilter for group filters.
Overrides AcLyLayerFilter.isIdFilter
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:58

isProxy

isProxy(): boolean
Returns whether this filter is a proxy for an unknown custom type.

Returns boolean
true if this is a proxy filter.
Inherited from AcLyLayerFilter.isProxy
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:288

layerIds

layerIds(): readonly string[]
Gets the layer object IDs included in this group.

Returns readonly string[]
A read-only array of layer object IDs.

Remarks
Mirrors ObjectARX AcLyLayerGroup::layerIds.
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:70

parent

parent(): null | AcLyLayerFilter
Gets the parent filter in the tree.

Returns null | AcLyLayerFilter
The parent filter, or null for the root.

Remarks
Mirrors ObjectARX AcLyLayerFilter::parent.
Inherited from AcLyLayerFilter.parent
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:199

removeLayerId

removeLayerId(layerId: string): boolean
Removes a layer object ID from this group.
Parameters
- layerId: string
  Layer table record object ID to remove.
Returns boolean
true if the ID was removed.

Remarks
Mirrors ObjectARX AcLyLayerGroup::removeLayerId.
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:112

removeNested

removeNested(filter: AcLyLayerFilter): boolean
Removes a nested child filter from this filter.
Parameters
- filter: AcLyLayerFilter
  Child filter to remove.
Returns boolean
true if the child was removed.

Remarks
Mirrors ObjectARX AcLyLayerFilter::removeNested.
Inherited from AcLyLayerFilter.removeNested
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:349

setAllowDelete

setAllowDelete(value: boolean): void
Sets whether this filter may be deleted.
Parameters
- value: boolean
  true to allow deletion.
Returns void
Inherited from AcLyLayerFilter.setAllowDelete
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:243

setAllowRename

setAllowRename(value: boolean): void
Sets whether this filter may be renamed.
Parameters
- value: boolean
  true to allow renaming.
Returns void
Inherited from AcLyLayerFilter.setAllowRename
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:261

setDynamicallyGenerated

setDynamicallyGenerated(value: boolean): void
Sets whether this filter was generated dynamically.
Parameters
- value: boolean
  true if dynamically generated.
Returns void
Inherited from AcLyLayerFilter.setDynamicallyGenerated
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:279

setFilterExpression

setFilterExpression(_expression: string): boolean
Group filters do not use filter expression strings.
Parameters
- _expression: string
  Ignored.
Returns boolean
Always false.
Overrides AcLyLayerFilter.setFilterExpression
- Defined in packages/data-model/src/ly/AcLyLayerGroup.ts:144

setIsProxy

setIsProxy(value: boolean): void
Sets whether this filter is a proxy.
Parameters
- value: boolean
  true if this is a proxy filter.
Returns void
Inherited from AcLyLayerFilter.setIsProxy
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:297

setName

setName(value: string): boolean
Sets the filter name.
Parameters
- value: string
  New filter name.
Returns boolean
true if the name was set.

Remarks
Mirrors ObjectARX AcLyLayerFilter::setName.
Inherited from AcLyLayerFilter.setName
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:98

showEditor

showEditor(): AcLyLayerFilterDialogResult
Shows the filter editor UI.

Returns AcLyLayerFilterDialogResult
Dialog result.

Remarks
Mirrors ObjectARX AcLyLayerFilter::showEditor. No UI is available in this port; always returns AcLyLayerFilterDialogResult.Cancel.
Inherited from AcLyLayerFilter.showEditor
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:423

Class AcLyLayerGroup

Remarks

See

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns AcLyLayerGroup

Accessors

filterExpression

Returns string

Remarks

Parameters

Returns void

layerIdList

Returns readonly string[]

name

Returns string

Parameters

Returns void

nestedFilters

Returns readonly AcLyLayerFilter[]

Methods

addLayerId

Parameters

Returns boolean

Remarks

addNested

Parameters

Returns boolean

Remarks

allowDelete

Returns boolean

allowNested

Returns boolean

Remarks

allowRename

Returns boolean

compareTo

Parameters

Returns boolean

Remarks

dynamicallyGenerated

Returns boolean

filter

Parameters

Returns boolean

Remarks

filterExpressionTree

Returns null | AcLyBoolExpr

Remarks

generateNested

Returns boolean

Remarks

getNestedFilters

Returns readonly AcLyLayerFilter[]

Remarks

isIdFilter

Returns boolean

Remarks

isProxy

Returns boolean

layerIds

Returns readonly string[]

Remarks

parent

Returns null | AcLyLayerFilter

Remarks

removeLayerId

Parameters

Returns boolean

Remarks

removeNested

Parameters

Returns boolean

Remarks