Class AcLyLayerFilter

Main Layer Manager filter class (property filter).

An AcLyLayerFilter allows clients to specify a filter expression and nest other filters into a tree. This is the AutoCAD Layer Properties Manager filter model (AcLy* classes), not the block-index AcDbLayerFilter.

Nesting rules (AutoCAD Layer Manager behavior):

The tree root may contain both group filters and property filters.
A non-root property filter (isIdFilter = false) may contain other property filters, but may not contain a group filter.
A group filter may contain both group filters and property filters.

Remarks

Mirrors ObjectARX AcLyLayerFilter from acly.h.

See

Example

const unlocked = new AcLyLayerFilter();
unlocked.name = 'Unlocked Layers';
unlocked.setFilterExpression('LOCKED=="False"');

const root = new AcLyLayerFilter();
root.name = 'All';
root.addNested(unlocked);

Hierarchy (View Summary)

AcLyLayerFilter
- AcLyLayerGroup

Constructors

constructor

new AcLyLayerFilter(): AcLyLayerFilter
Creates a new AcLyLayerFilter instance (property filter).

Returns AcLyLayerFilter
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:69

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.
- 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
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:150

name

get name(): string
Gets the filter name.

Returns string
The filter 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
- 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.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:187

Methods

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.
- 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.
- 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.
- 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.
- 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.
- 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.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:270

filter

filter(layer: AcDbLayerTableRecord): boolean
Tests whether the given layer table record passes this filter.
Parameters
- layer: AcDbLayerTableRecord
  Layer table record to test.
Returns boolean
true if the layer is accepted by this filter.

Remarks
Mirrors ObjectARX AcLyLayerFilter::filter. Property filters evaluate filterExpression; group filters override this method.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:404

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.
- 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.
- 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.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:178

isIdFilter

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

Returns boolean
true for group filters; otherwise false.

Remarks
Mirrors ObjectARX AcLyLayerFilter::isIdFilter. Property filters return false; AcLyLayerGroup overrides this to return true.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:212

isProxy

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

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

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.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:199

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.
- 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
- 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
- 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
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:279

setFilterExpression

setFilterExpression(expression: string): boolean
Sets the property-filter expression string.
Parameters
- expression: string
  Filter expression (for example LOCKED=="False").
Returns boolean
true if the expression was accepted.

Remarks
Mirrors ObjectARX AcLyLayerFilter::setFilterExpression.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:137

setIsProxy

setIsProxy(value: boolean): void
Sets whether this filter is a proxy.
Parameters
- value: boolean
  true if this is a proxy filter.
Returns void
- 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.
- 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.
- Defined in packages/data-model/src/ly/AcLyLayerFilter.ts:423

Class AcLyLayerFilter

Remarks

See

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns AcLyLayerFilter

Accessors

filterExpression

Returns string

Remarks

Parameters

Returns void

name

Returns string

Parameters

Returns void

nestedFilters

Returns readonly AcLyLayerFilter[]

Methods

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

parent

Returns null | AcLyLayerFilter

Remarks

removeNested

Parameters

Returns boolean

Remarks

setAllowDelete

Parameters

Returns void

setAllowRename

Parameters

Returns void

setDynamicallyGenerated

Parameters

Returns void

setFilterExpression

Parameters

Returns boolean

Remarks