Servoy 7.x.x Documentation
Child pages
  • agent

Versions Compared

Old Version 8

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 9

changes.mady.by.user Servoy Docs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\ 

{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#x]
Gets or sets the x position of the agent.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#y]
Gets or sets the y position of the agent.{td}{tr}{tbody}{table}\\ 

{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{td}[#setBalloonSize]\(width, height)
Sets the size of the balloon.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setImageURL]\(url)
Sets a new image for the agent.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setLocation]\(x, y)
Sets the location of the agent.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setVisible]\(visible)
Show/hides the agent.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#speak]\(message)
Makes the agent speak.{td}{tr}{tbody}{table}\\ 

{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F}{tr:id=name}{td}h6.x{td}{tr}{tr:id=des}{td}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_des|text=|trigger=button}{sub-section}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_des|trigger=none|class=sIndent}Gets or sets the x position of the agent.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_ret|text=|trigger=button}{sub-section}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_see|text=|trigger=button}{sub-section}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_see|text=|trigger=button}{sub-section}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_sam|text=|trigger=button}{sub-section}{sub-section:010B07FC711FD887-31D18A9E-473F4049-BDAB9F57-C32456207403EB65809D573F_sam|class=sIndent|trigger=none}{code:language=javascript}
//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716}{tr:id=name}{td}h6.y{td}{tr}{tr:id=des}{td}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_des|text=|trigger=button}{sub-section}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_des|trigger=none|class=sIndent}Gets or sets the y position of the agent.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_ret|text=|trigger=button}{sub-section}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_see|text=|trigger=button}{sub-section}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_see|text=|trigger=button}{sub-section}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_sam|text=|trigger=button}{sub-section}{sub-section:5C6D85591CDBB2DE-12F38118-40DD49A1-9B36AF11-376CC2D341056A604C61B716_sam|class=sIndent|trigger=none}{code:language=javascript}
//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ 

{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450}{tr:id=name}{td}h6.setBalloonSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setBalloonSize{span}{span:id=iets|style=float: left;}\(width, height){span}{td}{tr}{tr:id=des}{td}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_des|text=|trigger=button}{sub-section}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_des|trigger=none|class=sIndent}Sets the size of the balloon.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_prs|trigger=none}width
height
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_ret|text=|trigger=button}{sub-section}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_see|text=|trigger=button}{sub-section}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_see|text=|trigger=button}{sub-section}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_sam|text=|trigger=button}{sub-section}{sub-section:FCC9481A5595DD39-83CC5B20-441343D5-B59B875C-04FEB5FD286531B9A10EB450_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.agent.setBalloonSize(width,height)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1}{tr:id=name}{td}h6.setImageURL{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setImageURL{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{tr:id=des}{td}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_des|text=|trigger=button}{sub-section}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_des|trigger=none|class=sIndent}Sets a new image for the agent.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_prs|trigger=none}url
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_ret|text=|trigger=button}{sub-section}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_see|text=|trigger=button}{sub-section}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_see|text=|trigger=button}{sub-section}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_sam|text=|trigger=button}{sub-section}{sub-section:C231F7FF75ACAF51-167DBA4D-457844AC-912089EE-D20BF3B0530C44A22C24AAA1_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.agent.setImageURL("url")
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618}{tr:id=name}{td}h6.setLocation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setLocation{span}{span:id=iets|style=float: left;}\(x, y){span}{td}{tr}{tr:id=des}{td}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_des|text=|trigger=button}{sub-section}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_des|trigger=none|class=sIndent}Sets the location of the agent.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_prs|trigger=none}x
y
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_ret|text=|trigger=button}{sub-section}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_see|text=|trigger=button}{sub-section}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_see|text=|trigger=button}{sub-section}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_sam|text=|trigger=button}{sub-section}{sub-section:D9E20DABAFBD2833-A9A9BCAA-4BFF475A-ADF19275-98C36B7977FF3130CBB3C618_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.agent.setLocation(100,100);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80}{tr:id=name}{td}h6.setVisible{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setVisible{span}{span:id=iets|style=float: left;}\(visible){span}{td}{tr}{tr:id=des}{td}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_des|text=|trigger=button}{sub-section}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_des|trigger=none|class=sIndent}Show/hides the agent.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_prs|trigger=none}visible
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_ret|text=|trigger=button}{sub-section}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_see|text=|trigger=button}{sub-section}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_see|text=|trigger=button}{sub-section}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_sam|text=|trigger=button}{sub-section}{sub-section:FBCF08678B0D96A1-7BBBB300-4A0D4B81-A61A9C31-76D4D85FBD70A3E0094CDA80_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.agent.setVisible(true);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F}{tr:id=name}{td}h6.speak{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}speak{span}{span:id=iets|style=float: left;}\(message){span}{td}{tr}{tr:id=des}{td}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_des|text=|trigger=button}{sub-section}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_des|trigger=none|class=sIndent}Makes the agent speak.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_prs|trigger=none}message
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_ret|text=|trigger=button}{sub-section}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_see|text=|trigger=button}{sub-section}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_see|text=|trigger=button}{sub-section}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_sam|text=|trigger=button}{sub-section}{sub-section:67A2F7E5F65A3513-C3E04307-434842BB-8BE0BB5F-D21672C56F235F79543A067F_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.agent.speak('hello nerd');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}