Feature request for the future: PDF layers #269

Richard-Mlynarik · 2011-07-17T17:48:52Z

That is all.

The code looks really promising!

arturadib · 2011-10-07T20:16:59Z

Not clear what this means. User is no longer active on Github. Can reopen if asked.

Richard-Mlynarik · 2011-10-07T20:57:27Z

Let me Google that for You.

http://www.google.com/search?q=site:adobe.com+pdf+layer
http://www.google.com/search?q=site:adobe.com+pdf+%22optional+content+group%22

Standard since PDF specification 1.5.
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/PDF32000_2008.pdf
section 8.11.3 "Making Graphical Content Optional"

Present in the UI of every Adobe PDF viewer for about a billion years now.
PDF layers usefully correspond to Illustrator (and similar) drawing program layers, to layers in GIS output, etc.

I'd be more "active" on github (and with other free software) if I enjoyed being slapped about more. (I've stopped using Firefox since the "upgrade" that killed off the truly useful http://code.google.com/p/firefox-mac-pdf/ plugin, which also lacked PDF layer support but otherwise worked very nicely indeed. Browser with no PDF viewing = useless. Safari at least manages that, for all its other crapitude.)

arturadib · 2011-10-07T21:13:54Z

Hey there, didn't mean to insult you! We're doing an issue clean-up, so please forgive closing the issue on you.

And thanks for the detailed response - it definitely clarified what you meant.

Second-guessing terse user requests is a tough thing to do -- did the user mean "layers" at the UI/viewer level, or spec level (optional content), etc? I thought about inquiring here, but I wrongly assumed the odds of a response were low given that your only activity on Github was this comment (we're flattered! :)).

As I said, reopening is definitely an option - consider it done.

Thanks again.

blerner · 2013-01-08T21:41:57Z

I've uploaded a tiny file here that demonstrates broken rendering behavior for optional content groups and/or clipping paths (I'm not sure which thing is actually causing the bad behavior). If you try adding #textLayer=visible to the url, you can see that pdf.js is correctly finding and rendering the text, but is just not handling the rest of the rendering correctly.

(This particular PDF came about due to my working on this approach to rendering links in LaTeX using highlighting instead of boxes. The text is rendered into the current clipping path (7 Tr) rather than as normal text (0 Tr), then the clipping path is filled with the normal text color and, within an optional content group, filled again using the highlight color. IIRC, canvas.js#L982 already has some support for adding text to the clipping path, but it doesn't seem to be working here... As a result, this comment may not be 100% applicable to t his bug; feel free to redirect me to a more appropriate one if it exists ;-))

brendandahl · 2013-01-08T21:54:40Z

@blerner I think this issue is different than what you're asking about. Can you open a new issue with your comment above?

gitspeare · 2014-04-19T04:20:20Z

I'm looking for OCG functionality as well... is this on the plans? Can someone point me to the roadmap?

wearemothership · 2014-12-04T15:30:31Z

Any news on supporting layers? Would be incredible useful. Getting object names would be useful too (as in object and group names you can set in Illustrator)

Woodgnome · 2015-04-27T13:47:52Z

I'm also interested in knowing when layers will be supported (specifically showing/hiding them).

timvandermeij · 2015-04-27T14:24:15Z

There is no implementation for this yet and as far as I know no-one is working on this. If someone wants to work on this, feel free to create a pull request.

THausherr · 2016-06-16T15:05:04Z

Files with OCGs:
http://ims.er.usgs.gov/images/USTopo/
(not all, only the huge ones)

boundaryfree · 2017-03-01T03:44:58Z

Also expect this feature. Get layers info/showing layer/hiding layer.

boundaryfree · 2017-10-20T08:43:58Z

Hi, also expect OCGs (layer) supports. Any schedule?
@timvandermeij The attachment is a pdf file exported from a architectural drawing containing hundreds of layers.
OCGs_demo.PDF

timvandermeij · 2017-10-20T19:02:53Z

Currently this feature is not planned to be implemented. If someone wants to work on this, please let us know. If you can attach more example PDF files here, that would help to get people started and verify their work.

THausherr · 2019-03-07T10:06:49Z

Here's a simple one:
PDFBOX-4103-OCG.pdf

gitspeare · 2019-03-07T10:52:00Z

an old example with transparency and ocgs, it'd be nice if the ocgs were selectable from within a browser/ page
_myChessboardv1.2_mockup_ImageArray_beta0.7 - public.pdf

ma-rf · 2020-02-24T14:43:49Z

Hey there, I've been trying to find a solution for this issue during the last week and was hoping someone can point me in the right direction.
For my use-case, it would not be necessary to toggle additional layers, I would simply need to hide them in my viewer.

So far I was able to identify the "hidden" layers inside document.js like this:

const hiddenLayers = this.xref.root._map.OCProperties._map.D.get("OFF");

But I could not draw the connection between the layers and the actual content that is rendered by pdf.js. So if anyone could give me a hint how to figure out which data is supposed to be hidden, I'd rellay love to put it to use.

Add a new method to the API to get the optional content configuration. Add a new render task param that accepts the above configuration. For now, the optional content is not controllable by the user in the viewer, but renders with the default configuration in the PDF. All of the test files added exhibit different uses of optional content. Fixes mozilla#269.

Add a new method to the API to get the optional content configuration. Add a new render task param that accepts the above configuration. For now, the optional content is not controllable by the user in the viewer, but renders with the default configuration in the PDF. All of the test files added exhibit different uses of optional content. Fixes mozilla#269. Fix test to work with optional content. - Change the stopAtErrors test to ensure the operator list has something, instead of asserting the exact number of operators.

nuthinking · 2020-08-05T12:57:23Z

@brendandahl how does the new API works? What is "Optional Content"? Can't we simply scan existing layers and hide them? Thanks!

Snuffleupagus · 2020-08-05T13:12:30Z

What is "Optional Content"?

See https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/PDF32000_2008.pdf#G7.3858031

Can't we simply scan existing layers and hide them?

Unfortunately it's really quite difficult to understand what you're asking here.
Note: This functionality has not yet been integrated into the default viewer, however that'll be addressed in #12170.

nuthinking · 2020-08-05T13:50:42Z

Sorry, I meant detecting them and having the option to manipulate them (hide, remove, etc...)

THausherr · 2020-08-05T14:41:00Z

I tried the feature and it works as expected, which is that instead of displaying all layers, it only displays the ones for viewing.

brendandahl · 2020-08-05T16:06:00Z

@brendandahl how does the new API works? What is "Optional Content"? Can't we simply scan existing layers and hide them? Thanks!

The full API still needs a bit more work, but you can pdfDoc.getOptionalContentConfig then iterate over the various optionalContentConfig.groups and set which ones you want to hide/show (optionalContentGroup.visible). Then pass that config into your call to render a page.

Useful links:

pdf.js/src/display/api.js

Line 779 in 63e33a5

getOptionalContentConfig() {

pdf.js/src/display/optional_content_config.js

Line 25 in 63e33a5

class OptionalContentConfig {

pdf.js/src/display/api.js

Line 958 in 63e33a5

* @property {Promise<OptionalContentConfig>} [optionalContentConfigPromise] -

nuthinking · 2020-08-06T13:28:23Z

@brendandahl oh, this looks very interesting! I will give it a go. Thanks!

nuthinking · 2021-12-21T17:18:46Z

@brendandahl a pdf like this doesn't seem to have any optionalContentGroup. How could I split the different primitives into multiple renderings? I can see there is a SVG exporter. I wonder if parsing an SVG tree would be easier.

arturadib closed this as completed Oct 7, 2011

arturadib reopened this Oct 7, 2011

ghost assigned notmasteryet Nov 18, 2011

Kurdakov mentioned this issue Feb 28, 2015

'Only print' watermark is shown ( incorrectly ) when viewed in browser #5764

Closed

Snuffleupagus mentioned this issue Aug 18, 2015

multi language pdf renders all languages at the same time #6363

Closed

Snuffleupagus mentioned this issue Feb 17, 2016

Toggle Layer Visibility #7002

Closed

Snuffleupagus mentioned this issue Mar 13, 2016

Extraneous background image in PDF #7085

Closed

Snuffleupagus mentioned this issue May 3, 2016

pdf.js Bug? #7283

Closed

Snuffleupagus mentioned this issue Feb 7, 2017

Working with layers #8037

Closed

Snuffleupagus mentioned this issue Jul 3, 2017

Various rendering errors #8600

Closed

Snuffleupagus mentioned this issue Dec 26, 2017

Rendering Layered Content #9315

Closed

This was referenced Feb 8, 2018

First page is mixed with the last page #9462

Closed

Layers rendered in incorrect order #9483

Closed

Snuffleupagus mentioned this issue Sep 24, 2018

Grey Rectangles Appearing in background of PDF #10101

Closed

timvandermeij mentioned this issue Mar 6, 2019

someone know how to support Optional Content #10624

Closed

Snuffleupagus mentioned this issue Apr 21, 2020

PDFjs mispositions footer/header logos in this pdf, overlapping other content #11830

Closed

Snuffleupagus mentioned this issue Jun 17, 2020

PDF creative has different visible components in Acrobat Reader & pdf.js #12007

Closed

brendandahl self-assigned this Jun 23, 2020

brendandahl mentioned this issue Jul 14, 2020

Add support for optional marked content. #12095

Merged

brendandahl closed this as completed in #12095 Aug 4, 2020

nikhilag mentioned this issue Oct 9, 2021

Support for OptionalContentConfig in PdfHighlighter agentcooper/react-pdf-highlighter#161

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature request for the future: PDF layers #269

Feature request for the future: PDF layers #269

Richard-Mlynarik commented Jul 17, 2011

arturadib commented Oct 7, 2011

Richard-Mlynarik commented Oct 7, 2011

arturadib commented Oct 7, 2011

blerner commented Jan 8, 2013

brendandahl commented Jan 8, 2013

gitspeare commented Apr 19, 2014

wearemothership commented Dec 4, 2014

Woodgnome commented Apr 27, 2015

timvandermeij commented Apr 27, 2015

THausherr commented Jun 16, 2016

boundaryfree commented Mar 1, 2017

boundaryfree commented Oct 20, 2017 •

edited

timvandermeij commented Oct 20, 2017

THausherr commented Mar 7, 2019

gitspeare commented Mar 7, 2019

ma-rf commented Feb 24, 2020 •

edited

nuthinking commented Aug 5, 2020

Snuffleupagus commented Aug 5, 2020

nuthinking commented Aug 5, 2020

THausherr commented Aug 5, 2020

brendandahl commented Aug 5, 2020

nuthinking commented Aug 6, 2020

nuthinking commented Dec 21, 2021 •

edited

Feature request for the future: PDF layers #269

Feature request for the future: PDF layers #269

Comments

Richard-Mlynarik commented Jul 17, 2011

arturadib commented Oct 7, 2011

Richard-Mlynarik commented Oct 7, 2011

arturadib commented Oct 7, 2011

blerner commented Jan 8, 2013

brendandahl commented Jan 8, 2013

gitspeare commented Apr 19, 2014

wearemothership commented Dec 4, 2014

Woodgnome commented Apr 27, 2015

timvandermeij commented Apr 27, 2015

THausherr commented Jun 16, 2016

boundaryfree commented Mar 1, 2017

boundaryfree commented Oct 20, 2017 • edited

timvandermeij commented Oct 20, 2017

THausherr commented Mar 7, 2019

gitspeare commented Mar 7, 2019

ma-rf commented Feb 24, 2020 • edited

nuthinking commented Aug 5, 2020

Snuffleupagus commented Aug 5, 2020

nuthinking commented Aug 5, 2020

THausherr commented Aug 5, 2020

brendandahl commented Aug 5, 2020

nuthinking commented Aug 6, 2020

nuthinking commented Dec 21, 2021 • edited

boundaryfree commented Oct 20, 2017 •

edited

ma-rf commented Feb 24, 2020 •

edited

nuthinking commented Dec 21, 2021 •

edited