Allow snapshots of your visualization

To be able to take a snapshot of your visualization for use in data storytelling, it must be enabled in the code. This is done by setting the snapshot property to true.

Note: A new implementation of the snapshot property was introduced in version 3.0. Extensions using the legacy implementation of the snapshot property will continue to work but use this new implementation when creating new extensions.

 

Example: Basic example

		definition : properties,
		support : {
			snapshot: true
		},
		paint : function($element, layout) {

Example: snapshot as a function

In this example, the snapshot property is used as a function and does not allow snapshots when no data is available in the visualization extension.
		definition : properties,
		support : {
			snapshot: function( layout ) {
				return layout.qHyperCube.qDataPages[0].qMatrix.length;
			}
		},
		paint : function($element, layout) {

Legacy implementation (pre version 3.0)

To be able to take a snapshot of your visualization for use in data storytelling, it must be enabled in the code. This is done by setting the canTakeSnapshot parameter of the snapshot property to true.

Example

		definition : properties,
		snapshot : {
			canTakeSnapshot : true
		},
		paint : function($element, layout) {

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?