Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ObjectPropertyDescription
config  JavaScript object which contains configuration properties about the button. Commonly used properties are:
 
Anchor
configname
configname
name:
The name of the button
 type:What type of dialog to display when the button is clicked (or an empty string for no dialog) [ quickdialog | modaldialog ]
 dialog;The name of the dialog to show when the button is clicked e.g. Astun.JS.Plugins.dialogs.mydialog where mydialog is the name of the dialog.
 hideOnEmptyDialog:Should the button be hidden if the dialog is empty  [ true | false ]
 text:The text to go in the button
 tooltip:The tooltip text that is shown when you hover over the button
 tooltipTitle:The title of the tooltip that is shown when you hover over the button
 click:A function which will be called when the button is clicked
category Optional - Usually, this can be ignored, but the as the category is set in the plugin XML file. The default uses standard and advanced for the different tool barstoolbars.
profile Optional - AgainFor future use, this can usually be safely ignored.

installDialog(name, config, category, profile);

...

ObjectDescription
Anchor
dialogname
dialogname
name
The name of the dialog so that it can be referenced. A dialog called mydialog would be referenced by Astun.JS.Plugins.dialogs.mydialog
configUsually a function which accepts two parameters which in turn would return a standard JavaScript object which would be used to render the dialog. (See the Examples for more information)
categoryOptional - Usually, this can be ignored, but the as the category is set in the plugin XML file. The default uses standard and advanced for the different toolbars.
profileOptional - AgainFor future use, this can usually be safely ignored.

installPanel(name, config, category, profile);

...

ObjectDescription
nameThe name of the panel so that it can be referenced. A panel called mypanel would be referenced by Astun.JS.Plugins.panels.mypanel.
configUsually a function which accepts three parameters which in turn would return  a standards JavaScript object which would be used to render the dialog. (See the Examples for more information)
categoryOptional - Usually, this can be ignored, but the as the category is set in the plugin XML file. The default uses standard and advanced for the different toolbars.
profileOptional - AgainFor future use, this can usually be safely ignored.

Anchor
examples
examples
Examples

...