In This Topic ▼

deleteLayer Method

Summary

Deletes a layer from the container.

Syntax

TypeScript

JavaScript

AnnAutomation.prototype.deleteLayer = function( 
   layer, 
   deleteChildren 
)

deleteLayer( 
   layer: AnnLayer, 
   deleteChildren: boolean 
): void;

layer

The layer to delete. This parameter cannot be null since you cannot delete the default root layer of the container.

deleteChildren

true to also delete the layer children (objects and layers).

Remarks

Use this method to delete a layer from the container as follows:

If deleteChildren is false, then only the layer is deleted and its children (objects and any child layer) will be added one level up in the container. For example, if this layer is a child of the root container, the layer children will be added to the container. If this layer has a parent layer, its children are added to the parent layer.
If deleteChildren is true, then the layer and its children (objects and any child layer) are completely removed from the container.

Requirements

Help Version 23.0.2024.2.29