Qliksense Extension Snapshot method

[smith11484]

I have the need to implement a custom snapshot using javascript in qlik sense extension, in my extension there're more than one objects, i need to implement snapshot for each object (not to the whole extension), is there any method that i can implement snapshot for each object, like the exportData method for export data, let say on click button or on right click to take a snapshot and the snapshoted object will be available in the storytelling?              Dinar Detective News

[alex_colombo · Accepted solution]

Hi @smith11484 if you implement a custom button for each visualizations, yes, you can create snapshot for each visualizations.

For doing this you have to call createBookmark Engine API and pass all the information needed for create the snapshot. Basically when you create a snapshot on Qlik App, behind the scenes it will create a "special" bookmark.

About the information needed, you have to read the visualizations properties such as HypecubeDef,  title, subTitle, legend, etc. This information are available if you use the getObect method and getLayout from Engine API.

Below an example creating a snapshot

{
    "delta": true,
    "handle": 1,
    "method": "CreateBookmark",
    "params": [
        {
            "qInfo": {
                "qType": "snapshot"
            },
            "qMetaDef": {
                "title": "",
                "description": ""
            },
            "creationDate": "2022-11-10T10:40:40.903Z",
            "qMeta": {
                "privileges": [
                    "read",
                    "update",
                    "delete",
                    "exportdata"
                ]
            },
            "qSelectionInfo": {
                "qInSelections": false,
                "qMadeSelections": false
            },
            "qHyperCube": {
                "qSize": {
                    "qcx": 3,
                    "qcy": 1
                },
                "qDimensionInfo": [
                    {
                        "qFallbackTitle": "Num",
                        "qApprMaxGlyphCount": 2,
                        "qCardinal": 26,
                        "qSortIndicator": "A",
                        "qGroupFallbackTitles": [
                            "Num"
                        ],
                        "qGroupPos": 0,
                        "qStateCounts": {
                            "qLocked": 0,
                            "qSelected": 1,
                            "qOption": 0,
                            "qDeselected": 0,
                            "qAlternative": 25,
                            "qExcluded": 0,
                            "qSelectedExcluded": 0,
                            "qLockedExcluded": 0
                        },
                        "qTags": [
                            "$key",
                            "$numeric",
                            "$integer"
                        ],
                        "qDimensionType": "N",
                        "qGrouping": "N",
                        "qNumFormat": {
                            "qType": "I",
                            "qnDec": 0,
                            "qUseThou": 1,
                            "qFmt": "###0",
                            "qDec": "."
                        },
                        "qIsAutoFormat": true,
                        "qGroupFieldDefs": [
                            "Num"
                        ],
                        "qMin": 23,
                        "qMax": 23,
                        "qContinuousAxes": true,
                        "qAttrExprInfo": [
                            {
                                "qMin": "NaN",
                                "qMax": "NaN",
                                "qFallbackTitle": "'custom tooltip'",
                                "qNumFormat": {
                                    "qType": "U",
                                    "qnDec": 0,
                                    "qUseThou": 0
                                },
                                "qIsAutoFormat": true,
                                "cId": "MnhgA",
                                "autoSort": true,
                                "id": "customTooltipExpression"
                            }
                        ],
                        "qAttrDimInfo": [],
                        "qCardinalities": {
                            "qCardinal": 26,
                            "qHypercubeCardinal": 1,
                            "qAllValuesCardinal": -1
                        },
                        "autoSort": true,
                        "cId": "aHxsX",
                        "othersLabel": "Others"
                    }
                ],
                "qMeasureInfo": [
                    {
                        "qFallbackTitle": "Sum(Expression1)/Sum(total Expression1)",
                        "qApprMaxGlyphCount": 6,
                        "qCardinal": 0,
                        "qSortIndicator": "D",
                        "qNumFormat": {
                            "qType": "F",
                            "qnDec": 2,
                            "qUseThou": 0,
                            "qFmt": "0.0%",
                            "qDec": ".",
                            "qThou": ","
                        },
                        "qMin": 1,
                        "qMax": 1,
                        "qAttrExprInfo": [],
                        "qAttrDimInfo": [],
                        "qTrendLines": [],
                        "autoSort": true,
                        "cId": "abMgHc",
                        "numFormatFromTemplate": true,
                        "isCustomFormatted": false,
                        "modifiers": [
                            {
                                "type": "normalization",
                                "disabled": false,
                                "primaryDimension": 0,
                                "outputExpression": " (　Sum(Expression1)/Sum(total Expression1)　) / Sum({1} Total Aggr({1}  (　Sum(Expression1)/Sum(total Expression1)　) , [$(=Replace(GetObjectField(0),']',']]'))]))",
                                "dimensionalScope": 2,
                                "selectionScope": 2,
                                "base": {
                                    "qDef": "Sum(Expression1)/Sum(total Expression1)",
                                    "qLibraryId": "",
                                    "qLabel": "",
                                    "qLabelExpression": ""
                                }
                            }
                        ],
                        "base": {
                            "qDef": "Sum(Expression1)/Sum(total Expression1)",
                            "qLibraryId": "",
                            "qLabel": "",
                            "qLabelExpression": ""
                        }
                    },
                    {
                        "qFallbackTitle": "1-sum(Expression1)/sum(TOTAL Expression1)",
                        "qApprMaxGlyphCount": 1,
                        "qCardinal": 0,
                        "qSortIndicator": "D",
                        "qNumFormat": {
                            "qType": "F",
                            "qnDec": 2,
                            "qUseThou": 0,
                            "qFmt": "0.0%",
                            "qDec": ".",
                            "qThou": ","
                        },
                        "qMin": 0,
                        "qMax": 0,
                        "qAttrExprInfo": [],
                        "qAttrDimInfo": [],
                        "qTrendLines": [],
                        "autoSort": true,
                        "cId": "VNGWeL",
                        "numFormatFromTemplate": true,
                        "isCustomFormatted": false
                    }
                ],
                "qEffectiveInterColumnSortOrder": [
                    1,
                    0,
                    2
                ],
                "qGrandTotalRow": [
                    {
                        "qText": "100.0%",
                        "qNum": 1,
                        "qElemNumber": -1,
                        "qState": "X",
                        "qIsTotalCell": true
                    },
                    {
                        "qText": "0.0%",
                        "qNum": 0,
                        "qElemNumber": -1,
                        "qState": "X",
                        "qIsTotalCell": true
                    }
                ],
                "qDataPages": [
                    {
                        "qMatrix": [
                            [
                                {
                                    "qText": "23",
                                    "qNum": 23,
                                    "qElemNumber": 22,
                                    "qState": "S",
                                    "qAttrExps": {
                                        "qValues": [
                                            {
                                                "qText": "custom tooltip",
                                                "qNum": "NaN"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "qText": "100.0%",
                                    "qNum": 1,
                                    "qElemNumber": 0,
                                    "qState": "L"
                                },
                                {
                                    "qText": "0.0%",
                                    "qNum": 0,
                                    "qElemNumber": 0,
                                    "qState": "L"
                                }
                            ]
                        ],
                        "qTails": [
                            {
                                "qUp": 0,
                                "qDown": 0
                            }
                        ],
                        "qArea": {
                            "qLeft": 0,
                            "qTop": 0,
                            "qWidth": 3,
                            "qHeight": 1
                        }
                    }
                ],
                "qPivotDataPages": [],
                "qStackedDataPages": [],
                "qMode": "S",
                "qNoOfLeftDims": -1,
                "qTreeNodesOnDim": [],
                "qColumnOrder": []
            },
            "refLine": {
                "refLines": [],
                "dimRefLines": []
            },
            "showTitles": true,
            "title": "",
            "subtitle": "",
            "footnote": "",
            "disableNavMenu": false,
            "showDetails": false,
            "showDisclaimer": true,
            "components": [
                {
                    "key": "bar",
                    "style": {
                        "width": 0.68,
                        "strokeColor": {
                            "index": -1,
                            "color": "#205891"
                        },
                        "strokeWidth": "none"
                    }
                }
            ],
            "barGrouping": {
                "grouping": "stacked"
            },
            "orientation": "vertical",
            "scrollbar": "miniChart",
            "scrollStartPos": 0,
            "gridLine": {
                "auto": true,
                "spacing": 0
            },
            "dataPoint": {
                "showLabels": false,
                "showSegmentLabels": false,
                "showTotalLabels": true
            },
            "color": {
                "auto": true,
                "mode": "primary",
                "formatting": {
                    "numFormatFromTemplate": true
                },
                "useBaseColors": "off",
                "paletteColor": {
                    "index": 6
                },
                "useDimColVal": true,
                "useMeasureGradient": true,
                "persistent": false,
                "expressionIsColor": true,
                "expressionLabel": "",
                "measureScheme": "sg",
                "reverseScheme": false,
                "dimensionScheme": "12",
                "autoMinMax": true,
                "measureMin": 0,
                "measureMax": 10
            },
            "legend": {
                "show": true,
                "dock": "auto",
                "showTitle": true
            },
            "dimensionAxis": {
                "continuousAuto": true,
                "show": "labels",
                "label": "auto",
                "dock": "near",
                "axisDisplayMode": "auto",
                "maxVisibleItems": 10
            },
            "preferContinuousAxis": true,
            "measureAxis": {
                "show": "labels",
                "dock": "near",
                "spacing": 1,
                "autoMinMax": false,
                "minMax": "minMax",
                "min": 0,
                "max": 1
            },
            "tooltip": {
                "auto": false,
                "hideBasic": false,
                "chart": {
                    "style": {
                        "size": "medium"
                    },
                    "object": {
                        "refId": "644deff9-e8af-4e35-9d67-0794e387f0bf"
                    }
                },
                "data": {},
                "title": "",
                "description": ""
            },
            "visualization": "barchart",
            "version": "1.12.17",
            "showMiniChartForContinuousAxis": true,
            "masterVersion": 0.96,
            "snapshotData": {
                "object": {
                    "size": {
                        "w": 359,
                        "h": 391
                    }
                },
                "rtl": false,
                "content": {
                    "size": {
                        "w": 339.15625,
                        "h": 357.5
                    },
                    "chartData": {
                        "scrollOffset": 0,
                        "legendScrollOffset": 0
                    }
                },
                "parent": {
                    "h": 857,
                    "w": 896
                }
            },
            "reducedHyperCube": {
                "qDataPages": [
                    {
                        "qMatrix": [
                            [
                                {
                                    "qText": "23",
                                    "qNum": 23,
                                    "qElemNumber": 22,
                                    "qState": "S",
                                    "qAttrExps": {
                                        "qValues": [
                                            {
                                                "qText": "custom tooltip",
                                                "qNum": "NaN"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "qText": "100.0%",
                                    "qNum": 1,
                                    "qElemNumber": 0,
                                    "qState": "L"
                                },
                                {
                                    "qText": "0.0%",
                                    "qNum": 0,
                                    "qElemNumber": 0,
                                    "qState": "L"
                                }
                            ]
                        ],
                        "qTails": [
                            {
                                "qUp": 0,
                                "qDown": 0
                            }
                        ],
                        "qArea": {
                            "qLeft": 0,
                            "qTop": 0,
                            "qWidth": 3,
                            "qHeight": 1
                        }
                    }
                ],
                "qDimensionInfo": [
                    {
                        "qFallbackTitle": "Num",
                        "qApprMaxGlyphCount": 2,
                        "qCardinal": 26,
                        "qSortIndicator": "A",
                        "qGroupFallbackTitles": [
                            "Num"
                        ],
                        "qGroupPos": 0,
                        "qStateCounts": {
                            "qLocked": 0,
                            "qSelected": 1,
                            "qOption": 0,
                            "qDeselected": 0,
                            "qAlternative": 25,
                            "qExcluded": 0,
                            "qSelectedExcluded": 0,
                            "qLockedExcluded": 0
                        },
                        "qTags": [
                            "$key",
                            "$numeric",
                            "$integer"
                        ],
                        "qDimensionType": "N",
                        "qGrouping": "N",
                        "qNumFormat": {
                            "qType": "I",
                            "qnDec": 0,
                            "qUseThou": 1,
                            "qFmt": "###0",
                            "qDec": "."
                        },
                        "qIsAutoFormat": true,
                        "qGroupFieldDefs": [
                            "Num"
                        ],
                        "qMin": 23,
                        "qMax": 23,
                        "qContinuousAxes": true,
                        "qAttrExprInfo": [
                            {
                                "qMin": "NaN",
                                "qMax": "NaN",
                                "qFallbackTitle": "'custom tooltip'",
                                "qNumFormat": {
                                    "qType": "U",
                                    "qnDec": 0,
                                    "qUseThou": 0
                                },
                                "qIsAutoFormat": true,
                                "cId": "MnhgA",
                                "autoSort": true,
                                "id": "customTooltipExpression"
                            }
                        ],
                        "qAttrDimInfo": [],
                        "qCardinalities": {
                            "qCardinal": 26,
                            "qHypercubeCardinal": 1,
                            "qAllValuesCardinal": -1
                        },
                        "autoSort": true,
                        "cId": "aHxsX",
                        "othersLabel": "Others"
                    }
                ],
                "qEffectiveInterColumnSortOrder": [
                    1,
                    0
                ],
                "qMeasureInfo": [
                    {
                        "qFallbackTitle": "Sum(Expression1)/Sum(total Expression1)",
                        "qApprMaxGlyphCount": 6,
                        "qCardinal": 0,
                        "qSortIndicator": "D",
                        "qNumFormat": {
                            "qType": "F",
                            "qnDec": 2,
                            "qUseThou": 0,
                            "qFmt": "0.0%",
                            "qDec": ".",
                            "qThou": ","
                        },
                        "qMin": 1,
                        "qMax": 1,
                        "qAttrExprInfo": [],
                        "qAttrDimInfo": [],
                        "qTrendLines": [],
                        "autoSort": true,
                        "cId": "abMgHc",
                        "numFormatFromTemplate": true,
                        "isCustomFormatted": false,
                        "modifiers": [
                            {
                                "type": "normalization",
                                "disabled": false,
                                "primaryDimension": 0,
                                "outputExpression": " (　Sum(Expression1)/Sum(total Expression1)　) / Sum({1} Total Aggr({1}  (　Sum(Expression1)/Sum(total Expression1)　) , [$(=Replace(GetObjectField(0),']',']]'))]))",
                                "dimensionalScope": 2,
                                "selectionScope": 2,
                                "base": {
                                    "qDef": "Sum(Expression1)/Sum(total Expression1)",
                                    "qLibraryId": "",
                                    "qLabel": "",
                                    "qLabelExpression": ""
                                }
                            }
                        ],
                        "base": {
                            "qDef": "Sum(Expression1)/Sum(total Expression1)",
                            "qLibraryId": "",
                            "qLabel": "",
                            "qLabelExpression": ""
                        }
                    },
                    {
                        "qFallbackTitle": "1-sum(Expression1)/sum(TOTAL Expression1)",
                        "qApprMaxGlyphCount": 1,
                        "qCardinal": 0,
                        "qSortIndicator": "D",
                        "qNumFormat": {
                            "qType": "F",
                            "qnDec": 2,
                            "qUseThou": 0,
                            "qFmt": "0.0%",
                            "qDec": ".",
                            "qThou": ","
                        },
                        "qMin": 0,
                        "qMax": 0,
                        "qAttrExprInfo": [],
                        "qAttrDimInfo": [],
                        "qTrendLines": [],
                        "autoSort": true,
                        "cId": "VNGWeL",
                        "numFormatFromTemplate": true,
                        "isCustomFormatted": false
                    }
                ],
                "qStackedDataPages": [],
                "qMode": "S",
                "qSize": {
                    "qcx": 3,
                    "qcy": 1
                }
            },
            "visualizationType": "barchart",
            "sourceObjectId": "MyYcZ",
            "sheetId": "10c25f6a-2d96-42e0-b034-6f27b548984d",
            "timestamp": 1668076840875,
            "isClone": false,
            "supportExport": true
        }
    ],
    "id": 190,
    "jsonrpc": "2.0"
}