Class AcApLayerStore

constructor

• new AcApLayerStore(document: AcApDocument): AcApLayerStore

  Parameters

  • document: AcApDocument

    Owning document whose layer table is observed.

  Returns AcApLayerStore

Readonlyevents

destroy

• destroy(): void

  Removes upstream event listeners and clears the cached layer data.

  Returns void

getCurrentLayerName

• getCurrentLayerName(): string

  Returns the current layer name (CLAYER) for this document.

  Returns string

  Current layer name, or an empty string when none is set.

getLayers

• getLayers(): AcApLayerInfo[]

  Returns a shallow copy of cached layer rows.

  Returns AcApLayerInfo[]

  Copy of the cached layer snapshots.

getLayerService

• getLayerService(): AcApLayerService

  Returns the layer service for this document.

  Returns AcApLayerService

isolateSingleLayer

• isolateSingleLayer(layerName: string): boolean

  Keeps one layer visible and turns all others off (UI quick-isolate).

  Parameters

  • layerName: string

    Layer to keep visible.

  Returns boolean

  true when the layer exists and isolation was applied.

setAllLayersOffExceptCurrent

• setAllLayersOffExceptCurrent(): boolean

  Turns off every layer except the current layer.

  Returns boolean

  true when at least one layer was turned off.

setAllLayersOn

• setAllLayersOn(): boolean

  Turns on every layer in this document.

  Returns boolean

  true when at least one layer was turned on.

setCurrentLayer

• setCurrentLayer(layerName: string): boolean

  Makes a layer current (CLAYER), ensuring it is on and thawed.

  Parameters

  • layerName: string

    Layer name to activate.

  Returns boolean

  true when the layer exists and was set current.

setLayerColor

• setLayerColor(layerName: string, color: AcCmColor): boolean

  Assigns color to a layer in this document.

  Parameters

  • layerName: string

    Target layer name.

  • color: AcCmColor

    Color to assign.

  Returns boolean

  true when the layer exists and color was set.

setLayerDescription

• setLayerDescription(layerName: string, description: string): boolean

  Updates a layer description in this document.

  Parameters

  • layerName: string

    Target layer name.

  • description: string

    New description text.

  Returns boolean

  true when the layer exists and was updated.

setLayerFrozen

• setLayerFrozen(layerName: string, frozen: boolean): boolean

  Freezes or thaws a layer, switching CLAYER when freezing the current layer.

  Parameters

  • layerName: string

    Target layer name.

  • frozen: boolean

    Desired frozen state.

  Returns boolean

  true when the layer exists and was updated.

setLayerLinetype

• setLayerLinetype(layerName: string, linetype: string): boolean

  Assigns a linetype name to a layer in this document.

  Parameters

  • layerName: string

    Target layer name.

  • linetype: string

    Linetype table record name.

  Returns boolean

  true when the layer exists and was updated.

setLayerLineWeight

• setLayerLineWeight(layerName: string, lineWeight: number): boolean

  Assigns line weight to a layer in this document.

  Parameters

  • layerName: string

    Target layer name.

  • lineWeight: number

    Line weight to assign.

  Returns boolean

  true when the layer exists and line weight was set.

setLayerLocked

• setLayerLocked(layerName: string, locked: boolean): boolean

  Locks or unlocks a layer in this document.

  Parameters

  • layerName: string

    Target layer name.

  • locked: boolean

    Desired locked state.

  Returns boolean

  true when the layer exists and was updated.

setLayerOn

• setLayerOn(layerName: string, isOn: boolean): boolean

  Turns a layer on or off, switching CLAYER when turning off the current layer.

  Parameters

  • layerName: string

    Target layer name.

  • isOn: boolean

    Desired visibility (true = on).

  Returns boolean

  true when the layer exists and was updated.

setLayerPlottable

• setLayerPlottable(layerName: string, isPlottable: boolean): boolean

  Sets whether a layer is included when plotting.

  Parameters

  • layerName: string

    Target layer name.

  • isPlottable: boolean

    Desired plottable state.

  Returns boolean

  true when the layer exists and was updated.

setLayerTransparency

• setLayerTransparency(layerName: string, transparency: AcCmTransparency): boolean

  Assigns transparency to a layer in this document.

  Parameters

  • layerName: string

    Target layer name.

  • transparency: AcCmTransparency

    Transparency value to assign.

  Returns boolean

  true when the layer exists and was updated.