QGIS/resources/function_help/json/item_variables

{
  "name": "item_variables",
  "type": "function",
  "groups": ["Layout"],
  "description": "Returns a map of variables from a layout item inside this print layout.",
  "arguments": [ {"arg":"id","description":"layout item ID"}],
  "examples": [ { "expression":"map_get( item_variables('Map 0'), 'map_scale')", "returns":"scale of the item 'Map 0' in the current print layout"}
  ]
}
[FEATURE] item_variables expression function inside compositions This adds a new item_variables expression function when expressions are used inside a composition context. The function takes a single argument, the id for an item inside the composition, and returns a map of variable name to value for that item. This allows you to do things like insert text in a label fetching properties of another item in the composition, eg Insert scale of map into a label: map_get( item_variables( 'map'),'map_scale') Insert x coordinate of map center into a label: x(map_get( item_variables( 'map'),'map_extent_center')) 2017-01-09 13:51:53 +10:00			`{`
			`"name": "item_variables",`
			`"type": "function",`
Add groups to function_help files 2020-07-02 01:46:48 +01:00			`"groups": ["Layout"],`
Update references to compositions in expression function help 2021-01-09 11:15:18 +10:00			`"description": "Returns a map of variables from a layout item inside this print layout.",`
			`"arguments": [ {"arg":"id","description":"layout item ID"}],`
Updates on expression functions help fix examples and description add/update examples to "cross-link" functions 2020-08-02 09:53:34 +02:00			`"examples": [ { "expression":"map_get( item_variables('Map 0'), 'map_scale')", "returns":"scale of the item 'Map 0' in the current print layout"}`
[FEATURE] item_variables expression function inside compositions This adds a new item_variables expression function when expressions are used inside a composition context. The function takes a single argument, the id for an item inside the composition, and returns a map of variable name to value for that item. This allows you to do things like insert text in a label fetching properties of another item in the composition, eg Insert scale of map into a label: map_get( item_variables( 'map'),'map_scale') Insert x coordinate of map center into a label: x(map_get( item_variables( 'map'),'map_extent_center')) 2017-01-09 13:51:53 +10:00			`]`
			`}`