Get the layout of a bookmark

Get the layout of a bookmark by using the GetLayout method.

Examples

Example 1:

In this example, a chart is created and some values are selected. A bookmark is created and the layout of the bookmark is retrieved.

1. Create a transient chart. The chart contains one dimension (qFieldDefs is ProductName) and one measure (qDef is Sum (OrderTotal)).

The client sends:

{ "jsonrpc": "2.0", "id": 1, "method": "CreateSessionObject", "handle": 1, "params": [ { "qInfo": { "qId": "", "qType": "Chart" }, "qHyperCubeDef": { "qStateName": "$", "qDimensions": [ { "qLibraryId": "", "qNullSuppression": false, "qDef": { "qGrouping": "N", "qFieldDefs": [ "ProductName" ], "qFieldLabels": [ "" ] } } ], "qMeasures": [ { "qLibraryId": "", "qSortBy": { "qSortByState": 0, "qSortByFrequency": 0, "qSortByNumeric": 0, "qSortByAscii": 0, "qSortByLoadOrder": 1, "qSortByExpression": 0, "qExpression": { "qv": "" } }, "qDef": { "qLabel": "", "qDescription": "", "qTags": [ "tags" ], "qGrouping": "N", "qDef": "Sum (OrderTotal)" } } ] } } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 2, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 2, "qGenericType": "Chart", "qGenericId": "9e4a12f5-8c47-4080-96e4-d9140128adc5" } }, "change": [ 2 ] }

The transient chart is created. Its handle is 2.

2. Select in the dimension ProductName, the values of element numbers 1, 2 and 3. The handle is 2 (handle of the chart).

The client sends:

{ "jsonrpc": "2.0", "id": 2, "method": "SelectHyperCubeValues", "handle": 2, "params": [ "/qHyperCubeDef", 0, [ 1, 2, 3 ], false ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 2, "result": { "qSuccess": true }, "change": [ 2 ] }

The selections are successful.

3. Retrieve the first 10 values of the chart. The handle is 2.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "GetHyperCubeData", "handle": 2, "params": [ "/qHyperCubeDef", [ { "qTop": 0, "qHeight": 3, "qLeft": 0, "qWidth": 1 } ] ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qDataPages": [ { "qMatrix": [ [ { "qText": "Rössle Sauerkraut", "qNum": "NaN", "qElemNumber": 1, "qState": "S" }, { "qText": "1606,3", "qNum": 1606.3000000000002, "qElemNumber": 0, "qState": "L" } ], [ { "qText": "Chartreuse verte", "qNum": "NaN", "qElemNumber": 2, "qState": "S" }, { "qText": "424,8", "qNum": 424.79999999999995, "qElemNumber": 0, "qState": "L" } ], [ { "qText": "Spegesild", "qNum": "NaN", "qElemNumber": 3, "qState": "S" }, { "qText": "164,1675", "qNum": 164.1675, "qElemNumber": 0, "qState": "L" } ] ], "qTails": [ { "qUp": 0, "qDown": 0 } ], "qArea": { "qLeft": 0, "qTop": 0, "qWidth": 2, "qHeight": 3 } } ] } }

4. Create the bookmark.

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "CreateBookmark", "handle": 1, "params": [ { "qInfo": { "qId": "BM01", "qType": "Bookmark" } } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": { "qReturn": { "qType": "GenericBookmark", "qHandle": 3, "qGenericType": "Bookmark", "qGenericId": "BM01" }, "qInfo": { "qId": "BM01", "qType": "Bookmark" } }, "change": [ 1, 3 ] }

The bookmark BM01 is created. Its handle is 3.

5. Get the layout of the bookmark. The handle is 3.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "GetLayout", "handle": 3, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": { "qLayout": { "qInfo": { "qId": "BM01", "qType": "Bookmark" }, "qBookmark": { "qStateData": [ { "qStateName": "$", "qFieldItems": [ { "qDef": { "qName": "ProductName", "qType": "PRESENT" }, "qSelectInfo": { "qRangeLo": "NaN", "qRangeHi": "NaN", "qNumberFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0 }, "qRangeInfo": [] }, "qValues": [], "qExcludedValues": [] } ] } ], "qUtcModifyTime": 42213.620324074072, "qVariableItems": [] } } } }

The layout of the bookmark is displayed.

Example 2:

This example shows that the variables present in the app at the creation of the bookmark are listed when getting the layout of the bookmark.

1. Create a first variable, named MyVariable1. The identifier of the variable is Var01.

The client sends:

{ "jsonrpc": "2.0", "id": 2, "method": "CreateVariableEx", "handle": 1, "params": [ { "qInfo": { "qId": "Var01", "qType": "Variable" }, "qName": "MyVariable1", "qIncludeInBookmark": true } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 2, "result": { "qReturn": { "qType": "GenericVariable", "qHandle": 2, "qGenericType": "Variable", "qGenericId": "Var01" }, "qInfo": { "qId": "Var01", "qType": "Variable" } }, "change": [ 1, 2 ] }

The variable Var01 is created. Its handle is 2.

CreateVariableEx method

2. Set a value to the variable using the SetNumValue method. The handle of the request is 2 because the variable has 2 as a handle.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "SetNumValue", "handle": 2, "params": [ 1111.0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": {} }

The variable Var01 has 1111 as a value.

3. Create a second variable, named MyVariable2. The identifier of the variable is Var02.

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "CreateVariableEx", "handle": 1, "params": [ { "qInfo": { "qId": "Var02", "qType": "Variable" }, "qName": "MyVariable2", "qIncludeInBookmark": true } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": { "qReturn": { "qType": "GenericVariable", "qHandle": 3, "qGenericType": "Variable", "qGenericId": "Var02" }, "qInfo": { "qId": "Var02", "qType": "Variable" } }, "change": [ 1, 3 ] }

The variable Var02 is created. Its handle is 3.

4. Set a value to the variable using the SetNumValue method. The handle of the request is 3 because the variable has 3 as a handle.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "SetNumValue", "handle": 3, "params": [ 2222.0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": {} }

The variable Var02 has 2222 as a value.

5. Create a bookmark, using the CreateBookmark method. The identifier of the bookmark is BM01.

The client sends:

{ "jsonrpc": "2.0", "id": 6, "method": "CreateBookmark", "handle": 1, "params": [ { "qInfo": { "qId": "BM01", "qType": "Bookmark" } } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 6, "result": { "qReturn": { "qType": "GenericBookmark", "qHandle": 4, "qGenericType": "Bookmark", "qGenericId": "BM01" }, "qInfo": { "qId": "BM01", "qType": "Bookmark" } }, "change": [ 4 ] }

The bookmark BM01 is created and has 4 as a handle.

6. Create a third variable , named MyVariable3. The identifier of the variable is Var03.

The client sends:

{ "jsonrpc": "2.0", "id": 7, "method": "CreateVariableEx", "handle": 1, "params": [ { "qInfo": { "qId": "Var03", "qType": "Variable" }, "qName": "MyVariable3", "qIncludeInBookmark": true } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 7, "result": { "qReturn": { "qType": "GenericVariable", "qHandle": 5, "qGenericType": "Variable", "qGenericId": "Var03" }, "qInfo": { "qId": "Var03", "qType": "Variable" } }, "change": [ 1, 5 ] }

The variable Var03 is created. Its handle is 5.

7. Set a value to the variable using the SetNumValue method. The handle of the request is 5 because the variable has 5 as a handle.

The client sends:

{ "jsonrpc": "2.0", "id": 8, "method": "SetNumValue", "handle": 5, "params": [ 3333.0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 8, "result": {} }

The variable Var03 has 3333 as a value.

8. Set a new value to the variable Var02. The handle of the request is 3 because the variable has 3 as a handle.

The client sends:

{ "jsonrpc": "2.0", "id": 9, "method": "SetNumValue", "handle": 3, "params": [ 4444.0 ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 9, "result": {} }

The variable Var02 has now 4444 as a value.

9. Get the layout of the bookmark. The variables Var01 and Var02 should be returned in the layout. The variable Var03 should not be returned because this variable was not present in the app when the bookmark was created. The variable Var02 should have its old value 2222 because this variable got a new value once the bookmark was already created.

The client sends:

{ "jsonrpc": "2.0", "id": 10, "method": "GetLayout", "handle": 4, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 10, "result": { "qLayout": { "qInfo": { "qId": "BM01", "qType": "Bookmark" }, "qBookmark": { "qStateData": [ { "qStateName": "$", "qFieldItems": [] } ], "qUtcModifyTime": 42213.663981481484, "qVariableItems": [ { "qName": "MyVariable1", "qValue": { "qText": "1111", "qIsNumeric": true, "qNumber": 1111 } }, { "qName": "MyVariable2", "qValue": { "qText": "2222", "qIsNumeric": true, "qNumber": 2222 } } ] } } } }

The layout of the bookmark is returned.

Learn more

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here