> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/core/layer-ocg/add-layer.md).

# Add a new PDF Layer on Server/Desktop

Learn how to add a PDF layer or OCG (optional content group) to a new document with full sample code for creating, extracting, and rendering PDF layers. Master PDF layer manipulation now! The Apryse S

To add a PDF layer or OCG (optional content group) to a new document.

{% tabs %}
{% tab title="C#" %}
{% code lineNumbers="true" %}

```csharp
PDFDoc doc = new PDFDoc();
ElementBuilder builder = new ElementBuilder(); // ElementBuilder is used to build new Element objects
ElementWriter writer = new ElementWriter(); // ElementWriter is used to write Elements to the page

// Create a layer
Group image_layer = Group.Create(doc, "Image Layer");
Config cfg = Config.Create(doc, true);
cfg.SetName("Default");

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
Obj layer_order_array = doc.CreateIndirectArray();
cfg.SetOrder(layer_order_array);
layer_order_array.PushBack(image_layer.GetSDFObj());

// Start a new page
Page page = doc.PageCreate();
writer.Begin(page);	// begin writing to this page

// Add new content to the page and associate it with the layer.
Image img = Image.Create(doc.GetSDFDoc(), imagename);
img.GetSDFObj().Put("OC", image_layer.GetSDFObj());
writer.WritePlacedElement(builder.CreateImage(img, 300, 600, 200, -150));
writer.End();    // save changes to the current page
doc.PagePushBack(page);
```

{% endcode %}
{% endtab %}

{% tab title="C++" %}
{% code lineNumbers="true" %}

```cpp
PDFDoc doc;
ElementBuilder builder;	// ElementBuilder is used to build new Element objects
ElementWriter writer;	// ElementWriter is used to write Elements to the page

// Create a layer
OCG::Group image_layer = OCG::Group::Create(doc, "Image Layer");
OCG::Config cfg = OCG::Config::Create(doc, true);
cfg.SetName("Default");

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
Obj layer_order_array = doc.CreateIndirectArray();
cfg.SetOrder(layer_order_array);
layer_order_array.PushBack(image_layer.GetSDFObj());

// Start a new page
Page page = doc.PageCreate();
writer.Begin(page);	// Begin writing to the page

// Add new content to the page and associate it with one of the layers.
Image img = Image::Create(doc.GetSDFDoc(), imagename);
img.GetSDFObj().Put("OC", image_layer.GetSDFObj());
writer.WritePlacedElement(builder.CreateImage(img, 300, 600, 200, -150));
writer.End();    // save changes to the current page
doc.PagePushBack(page);
```

{% endcode %}
{% endtab %}

{% tab title="Go" %}
{% code lineNumbers="true" %}

```go
doc := NewPDFDoc()

builder := NewElementBuilder()    // NewElementBuilder is used to build new Element objects
writer := NewElementWriter()      // NewElementWriter is used to write Elements to the page

// Create a layer
imageLayer := CreateLayer(doc, "Image Layer")
cfg = ConfigCreate(doc, true)
cfg.SetName("Default")

// Start a new page
page := doc.PageCreate()
writer.Begin(page)

// Add new content to the page and associate it with one of the layers.
img := ImageCreate(doc.GetSDFDoc(), imagname)
img.GetSDFObj().Put("OC", imageLayer.GetSDFObj())
writer.WritePlacedElement(builder.CreateImage(img, 300.0, 600.0, 200.0, -150.0))
writer.End()    // save changes to the current page
doc.PagePushBack(page)
```

{% endcode %}
{% endtab %}

{% tab title="Java" %}
{% code lineNumbers="true" %}

```java
PDFDoc doc = new PDFDoc();
ElementBuilder builder = new ElementBuilder(); // ElementBuilder is used to build new Element objects
ElementWriter writer = new ElementWriter(); // ElementWriter is used to write Elements to the page

// Create a layer
Group image_layer = Group.create(doc, "Image Layer");
Config cfg = Config.create(doc, true);
cfg.setName("Default");

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
Obj layer_order_array = doc.createIndirectArray();
cfg.setOrder(layer_order_array);
layer_order_array.pushBack(image_layer.getSDFObj());

// Start a new page
Page page = doc.pageCreate();
writer.begin(page); // Begin writing to the page

// Add new content to the page and associate it with one of the layers.
Image img = Image.create(doc.getSDFDoc(), imagename);
img.GetSDFObj().Put("OC", image_layer.GetSDFObj());
writer.writePlacedElement(builder.createImage(img, 300, 600, 200, -150));
writer.end();    // save changes to the current page
doc.pagePushBack(page);
```

{% endcode %}
{% endtab %}

{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
async function main() {
  let doc = await PDFNet.PDFDoc.create();
  const builder = await PDFNet.ElementBuilder.create();
  const writer = await PDFNet.ElementWriter.create();

  // Create a layer
  const imageLayer = await PDFNet.OCG.create(doc, 'Image Layer');
  const cfg = await PDFNet.OCGConfig.create(doc, true);
  cfg.setName('Default');

  // Add the new OCG to the list of layers that should appear in PDF viewer GUI.
  let layerOrderArray = await doc.createIndirectArray();
  cfg.setOrder(layerOrderArray);
  layerOrderArray.pushBack(await image_layer.getSDFObj());

  // Start a new page
  const page = await doc.pageCreate();
  writer.beginOnPage(page); // Begin writing to the page

  // Add new content to the page and associate it with one of the layers.
  const nullEncoderHints = new PDFNet.Obj('0');
  const img = await PDFNet.Image.createFromURL(doc, imagename, nullEncoderHints);
  const img_obj = await img.getSDFObj();
  img_obj.put('OC', imageLayer);
  writer.writePlacedElement(await builder.createImageScaled(img, 300, 600, 200, -150));
  await writer.end();   // save changes to the current page
  doc.pagePushBack(page);
}
PDFNet.runWithCleanup(main);
```

{% endcode %}
{% endtab %}

{% tab title="Kotlin" %}
{% code lineNumbers="true" %}

```kotlin
val doc = PDFDoc()
val builder = ElementBuilder() // ElementBuilder is used to build new Element objects
val writer = ElementWriter() // ElementWriter is used to write Elements to the page

// Create a layer
val image_layer = Group.create(doc, "Image Layer")
var cfg: Config? = Config.create(doc, true)
cfg!!.name = "Default"

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
var layer_order_array: Obj? = doc.createIndirectArray()
cfg.order = layer_order_array!!
layer_order_array.pushBack(image_layer.sdfObj)

// Start a new page
val page = doc.pageCreate()
writer.begin(page) // Begin writing to the page

// Add new content to the page and associate it with one of the layers.
val img = Image.create(doc.sdfDoc, imagename)
img.getSDFObj().put("OC", image_layer)
writer.writePlacedElement(builder.createImage(img, 300.0, 600.0, 200.0, -150.0))
writer.end()   // save changes to the current page
doc.pagePushBack(page)
```

{% endcode %}
{% endtab %}

{% tab title="Obj-C" %}
{% code lineNumbers="true" %}

```objc
PTPDFDoc *doc = [[PTPDFDoc alloc] init];
PTElementBuilder *builder = [[PTElementBuilder alloc] init];	// ElementBuilder is used to build new Element objects
PTElementWriter *writer= [[PTElementWriter alloc] init];	// ElementWriter is used to write Elements to the page

// Create a layer
PTGroup *image_layer = [PTGroup Create: doc name: @"Image Layer"];
PTConfig *cfg = [PTConfig Create: doc default_config: YES];
[cfg SetName: @"Default"];

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
PTObj *layer_order_array = [doc CreateIndirectArray];
[cfg SetOrder: layer_order_array];
[layer_order_array PushBack: [image_layer GetSDFObj]];

// Start a new page
PTPage *page = [doc PageCreate: [[PTPDFRect alloc] initWithX1: 0 y1: 0 x2: 612 y2:792]];
[writer WriterBeginWithPage: page placement: e_ptoverlay page_coord_sys: YES compress: YES]; // Begin writing to the page

// Add new content to the page and associate it with one of the layers.
PTImage *img = [PTImage Create: [doc GetSDFDoc] filename: imagename];
[[img GetSDFObj] Put: @"OC" obj: image_layer];
[writer WritePlacedElement: [builder CreateImageWithCornerAndScale: img x: 300 y: 600 hscale: 200 vscale: -150]];
[writer End];   // save changes to the current page
[doc PagePushBack: page];
```

{% endcode %}
{% endtab %}

{% tab title="Swift" %}
{% code lineNumbers="true" %}

```swift
let doc: PTPDFDoc = PTPDFDoc()
let builder: PTElementBuilder = PTElementBuilder()    // ElementBuilder is used to build new Element objects
let writer: PTElementWriter = PTElementWriter()      // ElementWriter is used to write Elements to the page

// Create a layer
let image_layer: PTGroup = PTGroup.create(doc, name: "Image Layer")
let cfg: PTConfig = PTConfig.create(doc, default_config: true)
cfg.setName("Default")

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
let layer_order_array: PTObj = doc.createIndirectArray()
cfg.setOrder(layer_order_array)
layer_order_array.pushBack(image_layer.getSDFObj())

// Start a new page
let page: PTPage = doc.pageCreate(PTPDFRect(x1: 0, y1: 0, x2: 612, y2: 792))
writer.writerBegin(with: page, placement: e_ptoverlay, page_coord_sys: true, compress: true) // Begin writing to the page

// Add new content to the page and associate it with one of the layers.
let img: PTImage = PTImage.create(doc.getSDFDoc(), filename: imagename)
img.getSDFObj().put("OC", obj: image_layer)
writer.writePlacedElement(builder.createImage(withCornerAndScale: img, x: 300, y: 600, hscale: 200, vscale: -150))             writer.end()   // save changes to the current page
doc.pagePushBack(page)
```

{% endcode %}
{% endtab %}

{% tab title="PHP" %}
{% code lineNumbers="true" %}

```php
$doc = new PDFDoc();
$builder = new ElementBuilder();	// ElementBuilder is used to build new Element objects
$writer = new ElementWriter;	// ElementWriter is used to write Elements to the page

// Create a layer
$image_layer = Group::Create($doc, "Image Layer");
$cfg = Config::Create($doc, true);
$cfg->SetName("Default");

// Add the new OCG to the list of layers that should appear in PDF viewer GUI.
$layer_order_array = $doc->CreateIndirectArray();
$cfg->SetOrder($layer_order_array);
$layer_order_array->PushBack($image_layer->GetSDFObj());

// Start a new page
$page = $doc->PageCreate();
$writer->Begin($page);		// Begin writing to the page

// Add new content to the page and associate it with one of the layers.
$img = Image::Create($doc->GetSDFDoc(), $imagename);
$img->GetSDFObj()->Put("OC", $image_layer);
$writer->WritePlacedElement($builder->CreateImage($img, 300.0, 600.0, 200.0, -150.0));
$writer->End();   // save changes to the current page
$doc->PagePushBack($page);
```

{% endcode %}
{% endtab %}

{% tab title="Python" %}
{% code lineNumbers="true" %}

```python
doc = PDFDoc()
builder = ElementBuilder()    # ElementBuilder is used to build new Element objects
writer = ElementWriter()      # ElementWriter is used to write Elements to the page

# Create a layer
image_layer = Group.Create(doc, "Image Layer")
cfg = Config.Create(doc, True)
cfg.SetName("Default")

# Add the new OCG to the list of layers that should appear in PDF viewer GUI.
layer_order_array = doc.CreateIndirectArray()
cfg.SetOrder(layer_order_array)
layer_order_array.PushBack(image_layer.GetSDFObj())

# Start a new page
page = doc.PageCreate()
writer.Begin(page)            # Begin writting to the page

# Add new content to the page and associate it with one of the layers.
img = Image.Create(doc.GetSDFDoc(), image_name)
img.GetSDFObj().Put("OC", image_layer)
writer.WritePlacedElement(builder.CreateImage(img, 300, 600, 200, -150))
writer.End()    # save changes to the current page
doc.PagePushBack(page)
```

{% endcode %}
{% endtab %}

{% tab title="Ruby" %}
{% code lineNumbers="true" %}

```ruby
doc = PDFDoc.new
builder = ElementBuilder.new	# ElementBuilder is used to build new Element objects
writer = ElementWriter.new	# ElementWriter is used to write Elements to the page

# Create a layer
image_layer = Group.Create(doc, "Image Layer")
cfg = PDFNetRuby::Config.Create(doc, true)
cfg.SetName("Default")

# Add the new OCG to the list of layers that should appear in PDF viewer GUI.
layer_order_array = doc.CreateIndirectArray
cfg.SetOrder(layer_order_array)
layer_order_array.PushBack(image_layer.GetSDFObj)

# Start a new page
page = doc.PageCreate
writer.Begin(page)		# Begin writting to the page

# Add new content to the page and associate it with one of the layers.
img = Image.Create(doc.GetSDFDoc, imagename)
img.GetSDFObj().Put("OC", image_layer)
writer.WritePlacedElement(builder.CreateImage(img, 300, 600, 200, -150))
writer.End	  # save changes to the current page
doc.PagePushBack(page)
```

{% endcode %}
{% endtab %}

{% tab title="VB" %}
{% code lineNumbers="true" %}

```vb
Dim doc As PDFDoc = New PDFDoc
Dim builder As ElementBuilder = New ElementBuilder			' ElementBuilder is used to build new Element objects
Dim writer As ElementWriter = New ElementWriter		  ' ElementWriter is used to write Elements to the page

' Create a layer
Dim image_layer As Group = Group.Create(doc, "Image Layer")
Dim cfg As Config = Config.Create(doc, True)
cfg.SetName("Default")

' Add the new OCG to the list of layers that should appear in PDF viewer GUI.
Dim layer_order_array As Obj = doc.CreateIndirectArray()
cfg.SetOrder(layer_order_array)
layer_order_array.PushBack(image_layer.GetSDFObj())

' Start a new page
Dim page As Page = doc.PageCreate()
writer.Begin(page)			 ' begin writing to this page

' Add new content to the page and associate it with one of the layers.
Dim img As Image = Image.Create(doc.GetSDFDoc(), imagename)
img.GetSDFObj().Put("OC", image_layer)
writer.WritePlacedElement(builder.CreateImage(img, 300, 600, 200, -150))
writer.End()   ' save changes to the current page
doc.PagePushBack(page)
```

{% endcode %}
{% endtab %}
{% endtabs %}

[PDF layers (OCG)](/core/get-started/samples/pdflayerstest.md) Full sample code which demonstrates how to create, extract, render PDF layers.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.apryse.com/core/layer-ocg/add-layer.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.