Api session event editor panel: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
51,321 edits
No edit summary
No edit summary
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Api session event editor panel Endpoints.
<noinclude lang="text" copy>API Endpoint: api/session/event/editorpanel/
 
</noinclude><noinclude lang="text" copy>
API endpoints for [[Panel]] editing.
API Endpoints for [[Panel]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor panel add|add]]
| [[Api session event editor panel add|add]]
|Add new [[Panel]]
| Add a [[Panel]] of a particular Type
|-
|-
|[[Api session event editor panel append attribute|append_attribute]]
| [[Api session event editor panel append attribute|append_attribute]]
|Appended to existing [[Panel]] [[Attribute]] value
| Appended to existing [[Panel]] numeric [[Attribute]] value
|-
|-
|[[Api session event editor panel duplicate|duplicate]]
| [[Api session event editor panel duplicate|duplicate]]
|Duplicate existing [[Panel]]
| Duplicate existing [[Panel]]
|-
|-
|[[Api session event editor panel remove|remove]]
| [[Api session event editor panel remove|remove]]
|Remove existing [[Panel]]
| Remove existing [[Panel]]
|-
|-
|[[Api session event editor panel remove attribute|remove_attribute]]
| [[Api session event editor panel remove attribute|remove_attribute]]
|Remove [[Attribute]] from [[Panel]]
| Remove numeric [[Attribute]] from [[Panel]]
|-
|-
|[[Api session event editor panel set attribute|set_attribute]]
| [[Api session event editor panel set attribute|set_attribute]]
|Set [[Panel]] [[Attribute]] value
| Set [[Panel]] numeric [[Attribute]] value
|-
|-
|[[Api session event editor panel set attributes|set_attributes]]
| [[Api session event editor panel set attributes|set_attributes]]
|Set multiple [[Panel]] [[Attribute]] values
| Set multiple [[Panel]] numeric [[Attribute]] values
|-
|-
|[[Api session event editor panel set name|set_name]]
| [[Api session event editor panel set name|set_name]]
|Set new name of existing [[Panel]]
| Set the name of a [[Panel]]
|}
|}
 
<noinclude lang="text" copy>
Additional API endpoints:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor panel add answer|add_answer]]
| [[Api session event editor panel add answer|add_answer]]
|Add [[Answer (Panel)]]
| Add an [[Answer (Panel)|Answer]] to a [[Panel]]
|-
|-
|[[Api session event editor panel add answer event|add_answer_event]]
| [[Api session event editor panel add answer event|add_answer_event]]
|Add [[Answer (Panel)]] Event
| Add a Server or Clientside Event to an [[Answer (Panel)|Answer]] of a [[Panel]]
|-
|-
|[[Api session event editor panel add global|add_global]]
| [[Api session event editor panel add global|add_global]]
|Add [[Global]]
| Add [[Global]]s to a [[Global Panel]]
|-
|-
|[[Api session event editor panel add overlay template|add_overlay_template]]
| [[Api session event editor panel add overlay template|add_overlay_template]]
|Add [[Overlay]] Template
| Add a Template [[Excel Panel]] associated with an [[Overlay]] using a [[Panel]] Template
|-
|-
|[[Api session event editor panel add template|add_template]]
| [[Api session event editor panel add template|add_template]]
|Add Template
| Add a Template [[Excel Panel]] using a [[Panel]] Template. Also adds a new [[Overlay]] when associated
|-
|-
|[[Api session event editor panel apply template panels|apply_template_panels]]
| [[Api session event editor panel apply template panels|apply_template_panels]]
|Apply Template [[Panel]]s
| Apply each provided Template ([[Excel Sheet]] / Text) [[Panel]], after removing previous instances
|-
|-
|[[Api session event editor panel duplicate answer|duplicate_answer]]
| [[Api session event editor panel duplicate answer|duplicate_answer]]
|Duplicate [[Answer (Panel)]]
| Duplicate an [[Answer (Panel)|Answer]] of a [[Panel]]
|-
|-
|[[Api session event editor panel edit answer event|edit_answer_event]]
| [[Api session event editor panel edit answer event|edit_answer_event]]
|Edit [[Answer (Panel)]] Event
| Replace the Coded Event of a Server or Clientside Event of an [[Answer (Panel)|Answer]] of a [[Panel]], using the Coded Event ID
|-
|-
|[[Api session event editor panel export debug excel|export_debug_excel]]
| [[Api session event editor panel export debug excel|export_debug_excel]]
|Export Debug [[Excel Sheet]]
| Export an [[Excel Sheet]], populated with data related to the [[Excel Panel]], to Byte array content
|-
|-
|[[Api session event editor panel export excel call tree|export_excel_call_tree]]
| [[Api session event editor panel export excel call tree|export_excel_call_tree]]
|Export [[Excel Sheet]] Call Tree
| Export a performance report of an [[Excel Sheet]], populated with data related to the [[Excel Panel]], to text as Byte array content
|-
|-
|[[Api session event editor panel import wikipedia points|import_wikipedia_points]]
| [[Api session event editor panel import wikipedia points|import_wikipedia_points]]
|Import Wikipedia [[#Api Model Point|Point]]s
| Add a positioned [[Web Panel]] for each identified Wikipedia [[Point]] of Interest
|-
|-
|[[Api session event editor panel remove answer|remove_answer]]
| [[Api session event editor panel remove answer|remove_answer]]
|Remove [[Answer (Panel)]]
| Remove an [[Answer (Panel)|Answer]] from a [[Panel]]
|-
|-
|[[Api session event editor panel remove answer event|remove_answer_event]]
| [[Api session event editor panel remove answer event|remove_answer_event]]
|Remove [[Answer (Panel)]] Event
| Remove a Coded Event of a Server or Clientside Event of an [[Answer (Panel)|Answer]] of a [[Panel]]
|-
|-
|[[Api session event editor panel remove global|remove_global]]
| [[Api session event editor panel remove global|remove_global]]
|Remove [[Global]]
| Remove [[Global]]s from a [[Global Panel]]
|-
|-
|[[Api session event editor panel remove overlay|remove_overlay]]
| [[Api session event editor panel remove overlay|remove_overlay]]
|Remove [[Overlay]]
| Remove the [[Overlay]] association from a [[Panel]]
|-
|-
|[[Api session event editor panel set answer contents|set_answer_contents]]
| [[Api session event editor panel set answer contents|set_answer_contents]]
|Set [[Answer (Panel)]] Contents
| Set the text content of an an [[Answer (Panel)|Answer]] of a [[Panel]]
|-
|-
|[[Api session event editor panel set attention|set_attention]]
| [[Api session event editor panel set attention|set_attention]]
|Set Attention
| Set whether the [[Panel]] requires attention
|-
|-
|[[Api session event editor panel set excel|set_excel]]
| [[Api session event editor panel set excel|set_excel]]
|Set [[Excel Sheet]]
| Set the [[Excel Sheet]] used by a (Template) [[Excel Panel]]
|-
|-
|[[Api session event editor panel set excel update timing|set_excel_update_timing]]
| [[Api session event editor panel set excel update timing|set_excel_update_timing]]
|Set [[Excel Sheet]] Update Timing
| Set the calculation Timing of an [[Excel Panel]]
|-
|-
|[[Api session event editor panel set for everyone|set_for_everyone]]
| [[Api session event editor panel set for everyone|set_for_everyone]]
|Set For Everyone
| Set a [[Panel]] accessible by each [[Stakeholder]]
|-
|-
|[[Api session event editor panel set for stakeholder|set_for_stakeholder]]
| [[Api session event editor panel set for stakeholder|set_for_stakeholder]]
|Set For [[Stakeholder]]
| Set a [[Panel]] only accessible to a particular [[Stakeholder]]
|-
|-
|[[Api session event editor panel set layout xy|set_layout_xy]]
| [[Api session event editor panel set layout xy|set_layout_xy]]
|Set Layout Xy
| Set the interface position of a [[Panel]]
|-
|-
|[[Api session event editor panel set overlay|set_overlay]]
| [[Api session event editor panel set overlay|set_overlay]]
|Set [[Overlay]]
| Set the [[Overlay]] associated by a [[Panel]]
|-
|-
|[[Api session event editor panel set point|set_point]]
| [[Api session event editor panel set point|set_point]]
|Set [[#Api Model Point|Point]]
| Set the position of a [[Panel]]
|-
|-
|[[Api session event editor panel set popup model type|set_popup_model_type]]
| [[Api session event editor panel set size|set_size]]
|Set [[Popup]] Model Type
| Set the interface size of a [[Panel]]
|-
|-
|[[Api session event editor panel set size|set_size]]
| [[Api session event editor panel set template apply automatically|set_template_apply_automatically]]
|Set Size
| Configure whether the specified [[Template Panel]]s are automiticatelly reapplied at the start of a [[Session]]
|-
|-
|[[Api session event editor panel set template apply automatically|set_template_apply_automatically]]
| [[Api session event editor panel set template attribute|set_template_attribute]]
|Set Template Apply Automatically
| Set which [[Attribute]] is used by a [[Template Panel]] to create [[Panel]] instances
|-
|-
|[[Api session event editor panel set template attribute|set_template_attribute]]
| [[Api session event editor panel set template panel maplink|set_template_panel_maplink]]
|Set Template [[Attribute]]
| Set which [[Maplink]] is used by a [[Template Panel]] to create [[Panel]] instances
|-
|-
|[[Api session event editor panel set template panel maplink|set_template_panel_maplink]]
| [[Api session event editor panel set template relation|set_template_relation]]
|Set Template [[Panel]] [[Maplink]]
| Set which [[Relation]] is used by a [[Template Panel]] to create [[Panel]] instances
|-
|-
|[[Api session event editor panel set template relation|set_template_relation]]
| [[Api session event editor panel set template use owner|set_template_use_owner]]
|Set Template [[Relation]]
| Set whether [[Panel]] instances of a [[Template Panel]] are owned by [[Stakeholder]]s of their associated [[Maplink]] [[Item]]s. (When false, [[Template Panel]] [[Stakeholder]] is used)
|-
|-
|[[Api session event editor panel set template use owner|set_template_use_owner]]
| [[Api session event editor panel set text|set_text]]
|Set Template Use Owner
| Set the text content of a (Template) [[Text Panel]]
|-
|-
|[[Api session event editor panel set text|set_text]]
| [[Api session event editor panel set url|set_url]]
|Set Text
| Set the URL of a [[Web Panel]]
|-
|-
|[[Api session event editor panel set url|set_url]]
| [[Api session event editor panel set visible|set_visible]]
|Set Url
| Set whether a [[Panel]] is visible in the [[3D Visualization]]
|-
|[[Api session event editor panel set visible|set_visible]]
|Set Visible
|}
|}
{{article end|seealso=*[[Api Events]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items panels]]
*[[Api session items panels]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:27, 13 November 2026

API Endpoint: api/session/event/editorpanel/

API Endpoints for Panel editing.

Name Description
add Add a Panel of a particular Type
append_attribute Appended to existing Panel numeric Attribute value
duplicate Duplicate existing Panel
remove Remove existing Panel
remove_attribute Remove numeric Attribute from Panel
set_attribute Set Panel numeric Attribute value
set_attributes Set multiple Panel numeric Attribute values
set_name Set the name of a Panel

Additional API Endpoints:

Name Description
add_answer Add an Answer to a Panel
add_answer_event Add a Server or Clientside Event to an Answer of a Panel
add_global Add Globals to a Global Panel
add_overlay_template Add a Template Excel Panel associated with an Overlay using a Panel Template
add_template Add a Template Excel Panel using a Panel Template. Also adds a new Overlay when associated
apply_template_panels Apply each provided Template (Excel Sheet / Text) Panel, after removing previous instances
duplicate_answer Duplicate an Answer of a Panel
edit_answer_event Replace the Coded Event of a Server or Clientside Event of an Answer of a Panel, using the Coded Event ID
export_debug_excel Export an Excel Sheet, populated with data related to the Excel Panel, to Byte array content
export_excel_call_tree Export a performance report of an Excel Sheet, populated with data related to the Excel Panel, to text as Byte array content
import_wikipedia_points Add a positioned Web Panel for each identified Wikipedia Point of Interest
remove_answer Remove an Answer from a Panel
remove_answer_event Remove a Coded Event of a Server or Clientside Event of an Answer of a Panel
remove_global Remove Globals from a Global Panel
remove_overlay Remove the Overlay association from a Panel
set_answer_contents Set the text content of an an Answer of a Panel
set_attention Set whether the Panel requires attention
set_excel Set the Excel Sheet used by a (Template) Excel Panel
set_excel_update_timing Set the calculation Timing of an Excel Panel
set_for_everyone Set a Panel accessible by each Stakeholder
set_for_stakeholder Set a Panel only accessible to a particular Stakeholder
set_layout_xy Set the interface position of a Panel
set_overlay Set the Overlay associated by a Panel
set_point Set the position of a Panel
set_size Set the interface size of a Panel
set_template_apply_automatically Configure whether the specified Template Panels are automiticatelly reapplied at the start of a Session
set_template_attribute Set which Attribute is used by a Template Panel to create Panel instances
set_template_panel_maplink Set which Maplink is used by a Template Panel to create Panel instances
set_template_relation Set which Relation is used by a Template Panel to create Panel instances
set_template_use_owner Set whether Panel instances of a Template Panel are owned by Stakeholders of their associated Maplink Items. (When false, Template Panel Stakeholder is used)
set_text Set the text content of a (Template) Text Panel
set_url Set the URL of a Web Panel
set_visible Set whether a Panel is visible in the 3D Visualization

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_panel&oldid=98634"