360Works Scribbler/Documentation
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
||
Line 28: | Line 28: | ||
<div id="toc"> | <div id="toc"> | ||
*[[#SCRIB_ChooseColor|SCRIB_ChooseColor]] ( color ) — Shows a color chooser dialog | *[[#SCRIB_ChooseColor|SCRIB_ChooseColor]] ( color ) — Shows a color chooser dialog | ||
− | |||
*[[#SCRIB_Image|SCRIB_Image]] ( containerOrUrl ; scribblerData ) — Renders a flattened image for scribbler data by applying markup to an image. | *[[#SCRIB_Image|SCRIB_Image]] ( containerOrUrl ; scribblerData ) — Renders a flattened image for scribbler data by applying markup to an image. | ||
*[[#SCRIB_LastError|SCRIB_LastError]] ( ) — Returns the last error generated by the scribbler plugin. | *[[#SCRIB_LastError|SCRIB_LastError]] ( ) — Returns the last error generated by the scribbler plugin. | ||
*[[#SCRIB_LicenseInfo|SCRIB_LicenseInfo]] ( ) — Returns information about the license. | *[[#SCRIB_LicenseInfo|SCRIB_LicenseInfo]] ( ) — Returns information about the license. | ||
− | |||
− | |||
*[[#SCRIB_Version|SCRIB_Version]] ( ) — Returns the version number. | *[[#SCRIB_Version|SCRIB_Version]] ( ) — Returns the version number. | ||
</div> | </div> | ||
Line 45: | Line 42: | ||
</dl></div> | </dl></div> | ||
<div class="see"><strong>Returns:</strong> newly selected color | <div class="see"><strong>Returns:</strong> newly selected color | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</div> | </div> | ||
Line 129: | Line 69: | ||
</div><div class="see"><strong>Returns:</strong> license info | </div><div class="see"><strong>Returns:</strong> license info | ||
</div> | </div> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<div id="SCRIB_Version"></div> | <div id="SCRIB_Version"></div> |
Latest revision as of 10:04, 3 November 2017
Contents |
[edit] 360Works Scribbler User Guide
Scribbler is a plugin for annotating images using mouse drawing. Typical usage involves calling the SCRIB_EditImage function, passing in the image to be edited, optional style parameters, and the name of a callback script to execute when editing is completed.
Example Usage: First, create a callback script which will be performed when the user closes the annotated image. Next, fire the following calculation:</p>
If [SCRIB_EditImage( Scribbler Example::image ; "color=#336699" ; "thickness=4.2" ; "onSave=myScript" ; # The name of the callback script "alpha=125" # A semi-transparent line )] # Scribbler opened successfully Else # Something went wrong Show Custom Dialog [ "An Error Occurred" ; SCRIB_LastError ] End If
This brings up the scribbler annotation dialog. Upon closing, the user is asked if they want to accept the changes. If he chooses "Yes
", the "myScript
" script is called with a script parameter containing the marked-up image. This annotated image can then be saved to a container field or <a href="http://360works.com/supercontainer">SuperContainer</a>.
[edit] 360Works Plugin Setup Guides
See Plugins_101 for Error reporting, installation, registration, and more.
[edit] Function Summary
- SCRIB_ChooseColor ( color ) — Shows a color chooser dialog
- SCRIB_Image ( containerOrUrl ; scribblerData ) — Renders a flattened image for scribbler data by applying markup to an image.
- SCRIB_LastError ( ) — Returns the last error generated by the scribbler plugin.
- SCRIB_LicenseInfo ( ) — Returns information about the license.
- SCRIB_Version ( ) — Returns the version number.
[edit] Function Detail
[edit] SCRIB_ChooseColor ( color )
Shows a color chooser dialog
color
- selected color
[edit] SCRIB_Image ( containerOrUrl ; scribblerData )
Renders a flattened image for scribbler data by applying markup to an image. You must specify an existing image, and scribblerData.
containerOrUrl
- a container field or URL pointing to the image to apply annotations to.
scribblerData
- layer data from previous invocation(s) of SCRIB_EditImage.
containerDataOrUrl
with scribblerData
rendered on top of it.
[edit] SCRIB_LastError ( )
Returns the last error generated by the scribbler plugin.
[edit] SCRIB_LicenseInfo ( )
Returns information about the license.
[edit] SCRIB_Version ( )
Returns the version number.