Changes between Initial Version and Version 1 of Widgets/Scalebar


Ignore:
Timestamp:
Apr 3, 2008, 3:05:49 AM (16 years ago)
Author:
jbirch
Comment:

Automated wiki documentation upload

Legend:

Unmodified
Added
Removed
Modified

  • Widgets/Scalebar

    v1 v1  
     1[[PageOutline]]
     2[[BR]]
     3|| '''Automatically generated page, do not modify.  User Notes can be created at: [wiki:Widgets/ScalebarUsageNotes]'''||
     4[[BR]]
     5
     6= Widget: Scalebar =
     7
     8Outputs a cartographic scalebar
     9
     10== Usage Notes ==
     11
     12See: [wiki:Widgets/ScalebarUsageNotes]
     13
     14== Common Widget Properties ==
     15
     16 * '''Location''' :
     17 * '''Label''' : Scalebar
     18 * '''Tooltip''' :
     19 * '''StatusText''' :
     20 * '''ImageUrl''' :
     21 * '''ImageClass''' :
     22 * '''StandardUi''' : false
     23 * '''ContainableBy''' :
     24
     25== Parameters ==
     26
     27=== Style ===
     28
     29 * '''Description''' : Name of a style for the scalebbar
     30 * '''Type''' : String
     31 * '''Label''' : Style
     32  * '''fancy''' ''(Label: Fancy)''
     33  * '''fat''' ''(Label: Fat)''
     34  * '''thin''' ''(Label: Thin)''
     35  * '''thinner''' ''(Label: Thinner)''
     36 * '''DefaultValue''' : thin
     37 * '''IsMandatory''' : false
     38
     39=== DisplaySystem ===
     40
     41 * '''Description''' : Units to display
     42 * '''Type''' : String
     43 * '''Label''' : Display units
     44  * '''metric''' ''(Label: Metric)''
     45  * '''english''' ''(Label: English)''
     46 * '''DefaultValue''' : metric
     47 * '''IsMandatory''' : false
     48
     49=== MinWidth ===
     50
     51 * '''Description''' : Minimum width of the scalebar in pixels
     52 * '''Type''' : integer
     53 * '''Label''' : Minimum width
     54 * '''DefaultValue''' : 100
     55 * '''IsMandatory''' : false
     56
     57=== MaxWidth ===
     58
     59 * '''Description''' : Maximum width of the scalebar in pixels
     60 * '''Type''' : integer
     61 * '''Label''' : Maximum width
     62 * '''DefaultValue''' : 200
     63 * '''IsMandatory''' : false
     64
     65=== Divisions ===
     66
     67 * '''Description''' : The number of major divsions to use
     68 * '''Type''' : integer
     69 * '''Label''' : Divisions
     70 * '''DefaultValue''' : 2
     71 * '''IsMandatory''' : false
     72
     73=== SubDivisions ===
     74
     75 * '''Description''' : The number of minor divisions within each major divsion
     76 * '''Type''' : integer
     77 * '''Label''' : SubDivisions
     78 * '''DefaultValue''' : 2
     79 * '''IsMandatory''' : false
     80
     81=== ShowMinorMeasures ===
     82
     83 * '''Description''' : A flag to indicate if the minor divsions should be displayed
     84 * '''Type''' : boolean
     85 * '''Label''' : ShowMinorMeasures
     86 * '''DefaultValue''' : true
     87 * '''IsMandatory''' : false
     88
     89=== AbbreviateLabel ===
     90
     91 * '''Description''' : A flag to indicate if the full or an abbreviated units name is displayed
     92 * '''Type''' : boolean
     93 * '''Label''' : Abbreviate label
     94 * '''DefaultValue''' : true
     95 * '''IsMandatory''' : false
     96
     97=== SingleLine ===
     98
     99 * '''Description''' : A flag to indicate if the scalebar should bee drawn all on a single line
     100 * '''Type''' : boolean
     101 * '''Label''' : Single line
     102 * '''DefaultValue''' : false
     103 * '''IsMandatory''' : false
     104