← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/scilab_utilities_functions/xcosPalAddBlock.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xcos/help/en_US/scilab_utilities_functions/xcosPalAddBlock.xml
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="xcosPalAddBlock" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>xcosPalAddBlock</refname>
5
 
    <refpurpose>Add a block to a Scilab/Xcos palette instance. Some
6
 
      optional properties can be added to customize the palette icon
7
 
      and the style of the block.
8
 
    </refpurpose>
9
 
  </refnamediv>
10
 
  <refsynopsisdiv>
11
 
    <title>Calling Sequence</title>
12
 
    <synopsis>
13
 
      pal = xcosPalAddBlock(pal, block)
14
 
      pal = xcosPalAddBlock(pal, block, pal_block_img)
15
 
      pal = xcosPalAddBlock(pal, block, [], style)
16
 
      pal = xcosPalAddBlock(pal, block, pal_block_img, style)
17
 
    </synopsis>
18
 
  </refsynopsisdiv>
19
 
  <refsection>
20
 
    <title>Arguments</title>
21
 
    <variablelist>
22
 
      <varlistentry>
23
 
        <term>pal:</term>
24
 
        <listitem>
25
 
          <para>the palette to update</para>
26
 
        </listitem>
27
 
      </varlistentry>
28
 
      <varlistentry>
29
 
        <term>block:</term>
30
 
        <listitem>
31
 
          <para>the block to add to the palette</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>pal_block_img:</term>
36
 
        <listitem>
37
 
          <para>the block icon to use on the palette
38
 
            manager (png, jpg, gif).
39
 
          </para>
40
 
        </listitem>
41
 
      </varlistentry>
42
 
      <varlistentry>
43
 
        <term>style:</term>
44
 
        <listitem>
45
 
          <para>the style to apply to the block</para>
46
 
        </listitem>
47
 
      </varlistentry>
48
 
    </variablelist>
49
 
  </refsection>
50
 
  <refsection>
51
 
    <title>Description</title>
52
 
    <para>This macros add a block instance to a palette. This block
53
 
      parameter can be an instantiated block or a name
54
 
      (interface-function) or a path to a saved instance. Some
55
 
      operations are performed to load this block and check it's
56
 
      availability so it's interface-function must be loaded on
57
 
      Scilab. Some temporary files are also generated without full
58
 
      path arguments.
59
 
    </para>
60
 
    <para>The optional pal_block_img argument is generated on the 
61
 
      <link linkend="TMPDIR">TMPDIR</link>using Scilab graphics if
62
 
      not specified.Be careful that if you use our palette to be
63
 
      persistent you then need to specify it. Otherwise the generated
64
 
      image will be deleted at the end of the Scilab session.
65
 
    </para>
66
 
    <para>The optional style argument allow the user to determine
67
 
      the kind of style to be used by this block. This argument can
68
 
      be typed as a path 
69
 
      <link linkend="string">string</link> to an image (svg, png, jpg, gif) or a 
70
 
      <link linkend="struct">struct</link>. If it is a string then a
71
 
      default style value is generated and formatted as a style else
72
 
      a struct is wrapped to a key-value jgraphx settings. The 
73
 
      <link linkend="jgraphx-style-list">following
74
 
        style
75
 
      </link>
76
 
      correspond to jgraphx version 1.4.0.2. These style
77
 
      keys can change with new version of jgraphx without any
78
 
      warranty.
79
 
    </para>
80
 
    <para>
81
 
      <variablelist xml:id="jgraphx-style-list">
82
 
        <title>JGraphx style keys</title>
83
 
        <varlistentry>
84
 
          <term>
85
 
            <literal>"opacity"</literal>
86
 
          </term>
87
 
          <listitem>
88
 
            <para>Defines the key for the opacity style. The type
89
 
              of the value is float and the possible range is 
90
 
              <literal>0-100</literal>.
91
 
            </para>
92
 
          </listitem>
93
 
        </varlistentry>
94
 
        <varlistentry>
95
 
          <term>
96
 
            <literal>"textOpacity"</literal>
97
 
          </term>
98
 
          <listitem>
99
 
            <para>Defines the key for the text opacity style. The
100
 
              type of the value is float and the possible range is 
101
 
              <literal>0-100</literal>.
102
 
            </para>
103
 
          </listitem>
104
 
        </varlistentry>
105
 
        <varlistentry>
106
 
          <term>
107
 
            <literal>"overflow"</literal>
108
 
          </term>
109
 
          <listitem>
110
 
            <para>Defines the key for the overflow style. Possible
111
 
              values are 
112
 
              <literal>"visible"</literal>, 
113
 
              <literal>"hidden"</literal>or 
114
 
              <literal>"fill"</literal>. The default value is
115
 
              "visible". This value specifies how overlapping vertex
116
 
              labels are handles. A value of "visible" will show the
117
 
              complete label. A value of "hidden" will clip the label
118
 
              so that it does not overlap the vertex bounds. A value
119
 
              of "fill" will use the vertex bounds for the
120
 
              label.
121
 
            </para>
122
 
          </listitem>
123
 
        </varlistentry>
124
 
        <varlistentry>
125
 
          <term>
126
 
            <literal>"orthogonal"</literal>
127
 
          </term>
128
 
          <listitem>
129
 
            <para>Defines if the connection points on either end of
130
 
              the edge should be computed so that the edge is
131
 
              vertical or horizontal if possible and if the point is
132
 
              not at a fixed location. Default is 
133
 
              <literal>false</literal>.
134
 
            </para>
135
 
          </listitem>
136
 
        </varlistentry>
137
 
        <varlistentry>
138
 
          <term>
139
 
            <literal>"exitX"</literal>
140
 
          </term>
141
 
          <listitem>
142
 
            <para>Defines the key for the horizontal relative
143
 
              coordinate connection point of an edge with its source
144
 
              terminal.
145
 
            </para>
146
 
          </listitem>
147
 
        </varlistentry>
148
 
        <varlistentry>
149
 
          <term>
150
 
            <literal>"exitY"</literal>
151
 
          </term>
152
 
          <listitem>
153
 
            <para>Defines the key for the vertical relative
154
 
              coordinate connection point of an edge with its source
155
 
              terminal.
156
 
            </para>
157
 
          </listitem>
158
 
        </varlistentry>
159
 
        <varlistentry>
160
 
          <term>
161
 
            <literal>"exitPerimeter"</literal>
162
 
          </term>
163
 
          <listitem>
164
 
            <para>Defines if the perimeter should be used to find
165
 
              the exact entry point along the perimeter of the
166
 
              source. The type of the value is 
167
 
              <link linkend="boolean">boolean</link>. Default is 
168
 
              <literal>true</literal>.
169
 
            </para>
170
 
          </listitem>
171
 
        </varlistentry>
172
 
        <varlistentry>
173
 
          <term>
174
 
            <literal>"entryX"</literal>
175
 
          </term>
176
 
          <listitem>
177
 
            <para>Defines the key for the horizontal relative
178
 
              coordinate connection point of an edge with its target
179
 
              terminal.
180
 
            </para>
181
 
          </listitem>
182
 
        </varlistentry>
183
 
        <varlistentry>
184
 
          <term>
185
 
            <literal>"entryY"</literal>
186
 
          </term>
187
 
          <listitem>
188
 
            <para>Defines the key for the vertical relative
189
 
              coordinate connection point of an edge with its target
190
 
              terminal.
191
 
            </para>
192
 
          </listitem>
193
 
        </varlistentry>
194
 
        <varlistentry>
195
 
          <term>
196
 
            <literal>"entryPerimeter"</literal>
197
 
          </term>
198
 
          <listitem>
199
 
            <para>Defines if the perimeter should be used to find
200
 
              the exact entry point along the perimeter of the
201
 
              target. The type of the value is 
202
 
              <link linkend="boolean">boolean</link>. Default is 
203
 
              <literal>true</literal>.
204
 
            </para>
205
 
          </listitem>
206
 
        </varlistentry>
207
 
        <varlistentry>
208
 
          <term>
209
 
            <literal>"whiteSpace"</literal>
210
 
          </term>
211
 
          <listitem>
212
 
            <para>Defines the key for the white-space style.
213
 
              Possible values are 
214
 
              <literal>"nowrap"</literal>and 
215
 
              <literal>"wrap"</literal>. The default value is 
216
 
              <literal>"nowrap"</literal>. This value specifies how
217
 
              white-space inside a HTML vertex label should be
218
 
              handled. A value of 
219
 
              <literal>"nowrap"</literal>means the text will never
220
 
              wrap to the next line until a linefeed is encountered.
221
 
              A value of 
222
 
              <literal>"wrap"</literal>means text will wrap when
223
 
              necessary.
224
 
            </para>
225
 
          </listitem>
226
 
        </varlistentry>
227
 
        <varlistentry>
228
 
          <term>
229
 
            <literal>"rotation"</literal>
230
 
          </term>
231
 
          <listitem>
232
 
            <para>Defines the key for the rotation style. The type
233
 
              of the value is double and the possible range is 
234
 
              <literal>0-360</literal>.
235
 
            </para>
236
 
          </listitem>
237
 
        </varlistentry>
238
 
        <varlistentry>
239
 
          <term>
240
 
            <literal>"fillColor"</literal>
241
 
          </term>
242
 
          <listitem>
243
 
            <para>Defines the key for the fillColor style. The
244
 
              value is a string expression described on the 
245
 
              <link linkend="jgraphx-style-color-list">color
246
 
                list
247
 
              </link>
248
 
              .
249
 
            </para>
250
 
          </listitem>
251
 
        </varlistentry>
252
 
        <varlistentry>
253
 
          <term>
254
 
            <literal>"gradientColor"</literal>
255
 
          </term>
256
 
          <listitem>
257
 
            <para>Defines the key for the gradientColor style. The
258
 
              value is a string expression described on the 
259
 
              <link linkend="jgraphx-style-color-list">color
260
 
                list
261
 
              </link>
262
 
              .This is ignored if no 
263
 
              <literal>"fillColor"</literal>is defined.
264
 
            </para>
265
 
          </listitem>
266
 
        </varlistentry>
267
 
        <varlistentry>
268
 
          <term>
269
 
            <literal>"gradientDirection"</literal>
270
 
          </term>
271
 
          <listitem>
272
 
            <para>Defines the key for the gradient direction. The
273
 
              value is a string expression described on the 
274
 
              <link linkend="jgraphx-style-direction-list">direction
275
 
                list
276
 
              </link>
277
 
              .Default is 
278
 
              <literal>"south"</literal>. Generally, and by default,
279
 
              gradient painting is done from the value of 
280
 
              <literal>"fillColor"</literal>to the value of 
281
 
              <literal>"gradientColor"</literal>. Taking the example
282
 
              of 
283
 
              <literal>"north"</literal>, this means 
284
 
              <literal>"fillColor"</literal>color at the bottom of
285
 
              paint pattern and 
286
 
              <literal>"gradientColor"</literal>at top, with a
287
 
              gradient in-between.
288
 
            </para>
289
 
          </listitem>
290
 
        </varlistentry>
291
 
        <varlistentry>
292
 
          <term>
293
 
            <literal>"strokeColor"</literal>
294
 
          </term>
295
 
          <listitem>
296
 
            <para>Defines the key for the strokeColor style. The
297
 
              value is a string expression on the 
298
 
              <link linkend="jgraphx-style-color-list">color
299
 
                list
300
 
              </link>
301
 
              .
302
 
            </para>
303
 
          </listitem>
304
 
        </varlistentry>
305
 
        <varlistentry>
306
 
          <term>
307
 
            <literal>"separatorColor"</literal>
308
 
          </term>
309
 
          <listitem>
310
 
            <para>Defines the key for the separatorColor style. The
311
 
              value is a string expression described on the 
312
 
              <link linkend="jgraphx-style-color-list">color
313
 
                list
314
 
              </link>
315
 
              .This style is only used for 
316
 
              <literal>swimlane</literal>shapes.
317
 
            </para>
318
 
          </listitem>
319
 
        </varlistentry>
320
 
        <varlistentry>
321
 
          <term>
322
 
            <literal>"strokeWidth"</literal>
323
 
          </term>
324
 
          <listitem>
325
 
            <para>Defines the key for the strokeWidth style. The
326
 
              type of the value is float and the possible range is
327
 
              any non-negative value. The value reflects the stroke
328
 
              width in pixels.
329
 
            </para>
330
 
          </listitem>
331
 
        </varlistentry>
332
 
        <varlistentry>
333
 
          <term>
334
 
            <literal>"align"</literal>
335
 
          </term>
336
 
          <listitem>
337
 
            <para>Defines the key for the align style. Possible
338
 
              values are described on the 
339
 
              <link linkend="jgraphx-style-align-list">alignment
340
 
                list
341
 
              </link>
342
 
              .This value defines how the lines of the
343
 
              label are horizontally aligned. 
344
 
              <literal>"left"</literal>mean label text lines are
345
 
              aligned to left of the label bounds, 
346
 
              <literal>"right"</literal>to the right of the label
347
 
              bounds and 
348
 
              <literal>"center"</literal>means the center of the text
349
 
              lines are aligned in the center of the label bounds.
350
 
              Note this value does not affect the positioning of the
351
 
              overall label bounds relative to the vertex, to move
352
 
              the label bounds horizontally, use 
353
 
              <literal>"labelPosition"</literal>.
354
 
            </para>
355
 
          </listitem>
356
 
        </varlistentry>
357
 
        <varlistentry>
358
 
          <term>
359
 
            <literal>"verticalAlign"</literal>
360
 
          </term>
361
 
          <listitem>
362
 
            <para>Defines the key for the verticalAlign style.
363
 
              Possible values are described on the 
364
 
              <link linkend="jgraphx-style-align-list">alignment
365
 
                list
366
 
              </link>
367
 
              .This value defines how the lines of the
368
 
              label are vertically aligned. 
369
 
              <literal>"top"</literal>means the topmost label text
370
 
              line is aligned against the top of the label bounds, 
371
 
              <literal>"bottom"</literal>means the bottom-most label
372
 
              text line is aligned against the bottom of the label
373
 
              bounds and 
374
 
              <literal>"middle"</literal>means there is equal spacing
375
 
              between the topmost text label line and the top of the
376
 
              label bounds and the bottom-most text label line and
377
 
              the bottom of the label bounds. Note this value does not
378
 
              affect the positioning of the overall label bounds
379
 
              relative to the vertex, to move the label bounds
380
 
              vertically, use 
381
 
              <literal>"verticalLabelPosition"</literal>.
382
 
            </para>
383
 
          </listitem>
384
 
        </varlistentry>
385
 
        <varlistentry>
386
 
          <term>
387
 
            <literal>"labelPosition"</literal>
388
 
          </term>
389
 
          <listitem>
390
 
            <para>Defines the key for the horizontal label position
391
 
              of vertices. Possible values are described on the 
392
 
              <link linkend="jgraphx-style-align-list">alignment
393
 
                list
394
 
              </link>
395
 
              .Default is 
396
 
              <literal>"center"</literal>. The label align defines
397
 
              the position of the label relative to the cell. 
398
 
              <literal>"left"</literal>means the entire label bounds
399
 
              is placed completely just to the left of the vertex, 
400
 
              <literal>"right"</literal>means adjust to the right and
401
 
              
402
 
              <literal>"center"</literal>means the label bounds are
403
 
              vertically aligned with the bounds of the vertex. Note
404
 
              this value does not affect the positioning of label
405
 
              within the label bounds, to move the label horizontally
406
 
              within the label bounds, use 
407
 
              <literal>"align"</literal>.
408
 
            </para>
409
 
          </listitem>
410
 
        </varlistentry>
411
 
        <varlistentry>
412
 
          <term>
413
 
            <literal>"verticalLabelPosition"</literal>
414
 
          </term>
415
 
          <listitem>
416
 
            <para>Defines the key for the vertical label position
417
 
              of vertices. Possible values are described on the 
418
 
              <link linkend="jgraphx-style-align-list">alignment
419
 
                list
420
 
              </link>
421
 
              .Default is 
422
 
              <literal>"middle"</literal>. The label align defines
423
 
              the position of the label relative to the cell. 
424
 
              <literal>"top"</literal>means the entire label bounds
425
 
              is placed completely just on the top of the vertex, 
426
 
              <literal>"bottom"</literal>means adjust on the bottom
427
 
              and 
428
 
              <literal>"middle"</literal>means the label bounds are
429
 
              horizontally aligned with the bounds of the vertex.
430
 
              Note this value does not affect the positioning of label
431
 
              within the label bounds, to move the label vertically
432
 
              within the label bounds, use 
433
 
              <literal>"verticalAlign"</literal>.
434
 
            </para>
435
 
          </listitem>
436
 
        </varlistentry>
437
 
        <varlistentry>
438
 
          <term>
439
 
            <literal>"imageAlign"</literal>
440
 
          </term>
441
 
          <listitem>
442
 
            <para>Defines the key for the align style. Possible
443
 
              values are described on the 
444
 
              <link linkend="jgraphx-style-align-list">alignment
445
 
                list
446
 
              </link>
447
 
              .The value defines how any image in the
448
 
              vertex label is aligned horizontally within the label
449
 
              bounds of a 
450
 
              <literal>"label"</literal>shape.
451
 
            </para>
452
 
          </listitem>
453
 
        </varlistentry>
454
 
        <varlistentry>
455
 
          <term>
456
 
            <literal>"imageVerticalAlign"</literal>
457
 
          </term>
458
 
          <listitem>
459
 
            <para>Defines the key for the verticalAlign style.
460
 
              Possible values are described on the 
461
 
              <link linkend="jgraphx-style-align-list">alignment
462
 
                list
463
 
              </link>
464
 
              .The value defines how any image in the
465
 
              vertex label is aligned vertically within the label
466
 
              bounds of a 
467
 
              <literal>"label"</literal>shape.
468
 
            </para>
469
 
          </listitem>
470
 
        </varlistentry>
471
 
        <varlistentry>
472
 
          <term>
473
 
            <literal>"image"</literal>
474
 
          </term>
475
 
          <listitem>
476
 
            <para>Defines the key for the image style. Possible
477
 
              values are any image URL, the type of the value is
478
 
              String. This is the path to the image to image that is
479
 
              to be displayed within the label of a vertex.
480
 
            </para>
481
 
          </listitem>
482
 
        </varlistentry>
483
 
        <varlistentry>
484
 
          <term>
485
 
            <literal>"imageWidth"</literal>
486
 
          </term>
487
 
          <listitem>
488
 
            <para>Defines the key for the imageWidth style. The
489
 
              type of this value is int, the value is the image width
490
 
              in pixels and must be greated than 
491
 
              <literal>0</literal>.
492
 
            </para>
493
 
          </listitem>
494
 
        </varlistentry>
495
 
        <varlistentry>
496
 
          <term>
497
 
            <literal>"imageHeight"</literal>
498
 
          </term>
499
 
          <listitem>
500
 
            <para>Defines the key for the imageHeight style The
501
 
              type of this value is int, the value is the image
502
 
              height in pixels and must be greater than 
503
 
              <literal>0</literal>.
504
 
            </para>
505
 
          </listitem>
506
 
        </varlistentry>
507
 
        <varlistentry>
508
 
          <term>
509
 
            <literal>"noLabel"</literal>
510
 
          </term>
511
 
          <listitem>
512
 
            <para>Defines the key for the noLabel style. If this is
513
 
              
514
 
              <literal>true</literal>then no label is visible for a
515
 
              given cell. The type of the value is 
516
 
              <link linkend="boolean">boolean</link>. Default is 
517
 
              <literal>false</literal>.
518
 
            </para>
519
 
          </listitem>
520
 
        </varlistentry>
521
 
        <varlistentry>
522
 
          <term>
523
 
            <literal>"noEdgeStyle"</literal>
524
 
          </term>
525
 
          <listitem>
526
 
            <para>Defines the key for the noEdgeStyle style. If
527
 
              this is 
528
 
              <literal>true</literal>then no edge style is applied
529
 
              for a given edge. The type of the value is 
530
 
              <link linkend="boolean">boolean</link>. Default is 
531
 
              <literal>false</literal>.
532
 
            </para>
533
 
          </listitem>
534
 
        </varlistentry>
535
 
        <varlistentry>
536
 
          <term>
537
 
            <literal>"labelBackgroundColor"</literal>
538
 
          </term>
539
 
          <listitem>
540
 
            <para>Defines the key for the label background color.
541
 
              The value is a string expression described on the 
542
 
              <link linkend="jgraphx-style-color-list">color
543
 
                list
544
 
              </link>
545
 
              .
546
 
            </para>
547
 
          </listitem>
548
 
        </varlistentry>
549
 
        <varlistentry>
550
 
          <term>
551
 
            <literal>"labelBorderColor"</literal>
552
 
          </term>
553
 
          <listitem>
554
 
            <para>Defines the key for the label border color. The
555
 
              value is a string expression described on the 
556
 
              <link linkend="jgraphx-style-color-list">color
557
 
                list
558
 
              </link>
559
 
              .
560
 
            </para>
561
 
          </listitem>
562
 
        </varlistentry>
563
 
        <varlistentry>
564
 
          <term>
565
 
            <literal>"indicatorShape"</literal>
566
 
          </term>
567
 
          <listitem>
568
 
            <para>Defines the key for the indicatorShape style.
569
 
              Possible values are described on the 
570
 
              <link linkend="jgraphx-style-shape-list">shape
571
 
                list
572
 
              </link>
573
 
              .
574
 
            </para>
575
 
          </listitem>
576
 
        </varlistentry>
577
 
        <varlistentry>
578
 
          <term>
579
 
            <literal>"indicatorImage"</literal>
580
 
          </term>
581
 
          <listitem>
582
 
            <para>Defines the key for the indicatorImage style.
583
 
              Possible values are any image URL, the type of the
584
 
              value is String.
585
 
            </para>
586
 
          </listitem>
587
 
        </varlistentry>
588
 
        <varlistentry>
589
 
          <term>
590
 
            <literal>"indicatorColor"</literal>
591
 
          </term>
592
 
          <listitem>
593
 
            <para>Defines the key for the indicatorColor style. The
594
 
              value is a string expression described below.
595
 
            </para>
596
 
          </listitem>
597
 
        </varlistentry>
598
 
        <varlistentry>
599
 
          <term>
600
 
            <literal>"indicatorGradientColor"</literal>
601
 
          </term>
602
 
          <listitem>
603
 
            <para>Defines the key for the indicatorGradientColor
604
 
              style. The value is a string expression described on
605
 
              the 
606
 
              <link linkend="jgraphx-style-color-list">color
607
 
                list
608
 
              </link>
609
 
              .This style is only supported in 
610
 
              <literal>shape</literal>shapes.
611
 
            </para>
612
 
          </listitem>
613
 
        </varlistentry>
614
 
        <varlistentry>
615
 
          <term>
616
 
            <literal>"indicatorSpacing"</literal>
617
 
          </term>
618
 
          <listitem>
619
 
            <para>Defines the key for the indicatorSpacing style
620
 
              (in px).
621
 
            </para>
622
 
          </listitem>
623
 
        </varlistentry>
624
 
        <varlistentry>
625
 
          <term>
626
 
            <literal>"indicatorWidth"</literal>
627
 
          </term>
628
 
          <listitem>
629
 
            <para>Defines the key for the indicatorWidth style (in
630
 
              px).
631
 
            </para>
632
 
          </listitem>
633
 
        </varlistentry>
634
 
        <varlistentry>
635
 
          <term>
636
 
            <literal>"indicatorHeight"</literal>
637
 
          </term>
638
 
          <listitem>
639
 
            <para>Defines the key for the indicatorHeight style (in
640
 
              px).
641
 
            </para>
642
 
          </listitem>
643
 
        </varlistentry>
644
 
        <varlistentry>
645
 
          <term>
646
 
            <literal>"shadow"</literal>
647
 
          </term>
648
 
          <listitem>
649
 
            <para>Defines the key for the shadow style. The type of
650
 
              the value is 
651
 
              <link linkend="boolean">boolean</link>. This style
652
 
              applies to vertices and arrow style edges.
653
 
            </para>
654
 
          </listitem>
655
 
        </varlistentry>
656
 
        <varlistentry>
657
 
          <term>
658
 
            <literal>"endArrow"</literal>
659
 
          </term>
660
 
          <listitem>
661
 
            <para>Defines the key for the endArrow style. Possible
662
 
              values are described on the 
663
 
              <link linkend="jgraphx-style-arrow-list">arrow
664
 
                list
665
 
              </link>
666
 
              .
667
 
            </para>
668
 
          </listitem>
669
 
        </varlistentry>
670
 
        <varlistentry>
671
 
          <term>
672
 
            <literal>"startArrow"</literal>
673
 
          </term>
674
 
          <listitem>
675
 
            <para>Defines the key for the startArrow style.
676
 
              Possible values are described on the 
677
 
              <link linkend="jgraphx-style-arrow-list">arrow
678
 
                list
679
 
              </link>
680
 
              .
681
 
            </para>
682
 
          </listitem>
683
 
        </varlistentry>
684
 
        <varlistentry>
685
 
          <term>
686
 
            <literal>"endSize"</literal>
687
 
          </term>
688
 
          <listitem>
689
 
            <para>Defines the key for the endSize style. The type
690
 
              of this value is float and the value represents the
691
 
              size of the end marker in pixels.
692
 
            </para>
693
 
          </listitem>
694
 
        </varlistentry>
695
 
        <varlistentry>
696
 
          <term>
697
 
            <literal>"startSize"</literal>
698
 
          </term>
699
 
          <listitem>
700
 
            <para>Defines the key for the startSize style. The type
701
 
              of this value is float and the value represents the
702
 
              size of the start marker or the size of the swimlane
703
 
              title region depending on the shape it is used
704
 
              for.
705
 
            </para>
706
 
          </listitem>
707
 
        </varlistentry>
708
 
        <varlistentry>
709
 
          <term>
710
 
            <literal>"dashed"</literal>
711
 
          </term>
712
 
          <listitem>
713
 
            <para>Defines the key for the dashed style. The type of
714
 
              this value is 
715
 
              <link linkend="boolean">boolean</link>and the value
716
 
              determines whether or not an edge or border is drawn
717
 
              with a dashed pattern along the line.
718
 
            </para>
719
 
          </listitem>
720
 
        </varlistentry>
721
 
        <varlistentry>
722
 
          <term>
723
 
            <literal>"rounded"</literal>
724
 
          </term>
725
 
          <listitem>
726
 
            <para>Defines the key for the rounded style. The type
727
 
              of this value is 
728
 
              <link linkend="boolean">boolean</link>. For edges this
729
 
              determines whether or not joins between edges segments
730
 
              are smoothed to a rounded finish. For vertices that
731
 
              have the rectangle shape, this determines whether or
732
 
              not the rectangle is rounded.
733
 
            </para>
734
 
          </listitem>
735
 
        </varlistentry>
736
 
        <varlistentry>
737
 
          <term>
738
 
            <literal>"sourcePerimeterSpacing"</literal>
739
 
          </term>
740
 
          <listitem>
741
 
            <para>Defines the key for the source perimeter spacing.
742
 
              The type of this value is double. This is the distance
743
 
              between the source connection point of an edge and the
744
 
              perimeter of the source vertex in pixels. This style
745
 
              only applies to edges.
746
 
            </para>
747
 
          </listitem>
748
 
        </varlistentry>
749
 
        <varlistentry>
750
 
          <term>
751
 
            <literal>"targetPerimeterSpacing"</literal>
752
 
          </term>
753
 
          <listitem>
754
 
            <para>Defines the key for the target perimeter spacing.
755
 
              The type of this value is double. This is the distance
756
 
              between the target connection point of an edge and the
757
 
              perimeter of the target vertex in pixels. This style
758
 
              only applies to edges.
759
 
            </para>
760
 
          </listitem>
761
 
        </varlistentry>
762
 
        <varlistentry>
763
 
          <term>
764
 
            <literal>"perimeterSpacing"</literal>
765
 
          </term>
766
 
          <listitem>
767
 
            <para>Defines the key for the perimeter spacing. This
768
 
              is the distance between the connection point and the
769
 
              perimeter in pixels. When used in a vertex style, this
770
 
              applies to all incoming edges to floating ports (edges
771
 
              that terminate on the perimeter of the vertex). When
772
 
              used in an edge style, this spacing applies to the
773
 
              source and target separately, if they terminate in
774
 
              floating ports (on the perimeter of the vertex).
775
 
            </para>
776
 
          </listitem>
777
 
        </varlistentry>
778
 
        <varlistentry>
779
 
          <term>
780
 
            <literal>"spacing"</literal>
781
 
          </term>
782
 
          <listitem>
783
 
            <para>Defines the key for the spacing. The value
784
 
              represents the spacing, in pixels, added to each side
785
 
              of a label in a vertex (style applies to vertices
786
 
              only).
787
 
            </para>
788
 
          </listitem>
789
 
        </varlistentry>
790
 
        <varlistentry>
791
 
          <term>
792
 
            <literal>"spacingTop"</literal>
793
 
          </term>
794
 
          <listitem>
795
 
            <para>Defines the key for the spacingTop style. The
796
 
              value represents the spacing, in pixels, added to the
797
 
              top side of a label in a vertex (style applies to
798
 
              vertices only).
799
 
            </para>
800
 
          </listitem>
801
 
        </varlistentry>
802
 
        <varlistentry>
803
 
          <term>
804
 
            <literal>"spacingLeft"</literal>
805
 
          </term>
806
 
          <listitem>
807
 
            <para>Defines the key for the spacingLeft style. The
808
 
              value represents the spacing, in pixels, added to the
809
 
              left side of a label in a vertex (style applies to
810
 
              vertices only).
811
 
            </para>
812
 
          </listitem>
813
 
        </varlistentry>
814
 
        <varlistentry>
815
 
          <term>
816
 
            <literal>"spacingBottom"</literal>
817
 
          </term>
818
 
          <listitem>
819
 
            <para>Defines the key for the spacingBottom style The
820
 
              value represents the spacing, in pixels, added to the
821
 
              bottom side of a label in a vertex (style applies to
822
 
              vertices only).
823
 
            </para>
824
 
          </listitem>
825
 
        </varlistentry>
826
 
        <varlistentry>
827
 
          <term>
828
 
            <literal>"spacingRight"</literal>
829
 
          </term>
830
 
          <listitem>
831
 
            <para>Defines the key for the spacingRight style The
832
 
              value represents the spacing, in pixels, added to the
833
 
              right side of a label in a vertex (style applies to
834
 
              vertices only).
835
 
            </para>
836
 
          </listitem>
837
 
        </varlistentry>
838
 
        <varlistentry>
839
 
          <term>
840
 
            <literal>"horizontal"</literal>
841
 
          </term>
842
 
          <listitem>
843
 
            <para>Defines the key for the horizontal style. The
844
 
              type of this value is 
845
 
              <link linkend="boolean">boolean</link>. This value only
846
 
              applies to vertices. If the 
847
 
              <literal>"shape"</literal>is 
848
 
              <literal>"swimlane"</literal>a value of 
849
 
              <literal>false</literal>indicates that the swimlane
850
 
              should be drawn vertically, 
851
 
              <literal>true</literal>indicates to draw it
852
 
              horizontally. If the shape style does not indicate that
853
 
              this vertex is a swimlane, this value affects only
854
 
              whether the label is drawn horizontally or
855
 
              vertically.
856
 
            </para>
857
 
          </listitem>
858
 
        </varlistentry>
859
 
        <varlistentry>
860
 
          <term>
861
 
            <literal>"direction"</literal>
862
 
          </term>
863
 
          <listitem>
864
 
            <para>Defines the key for the direction style. The
865
 
              direction style is used to specify the direction of
866
 
              certain shapes. Possible values are described on the 
867
 
              <link linkend="jgraphx-style-direction-list">direction
868
 
                list
869
 
              </link>
870
 
              .This value only applies to
871
 
              vertices.
872
 
            </para>
873
 
          </listitem>
874
 
        </varlistentry>
875
 
        <varlistentry>
876
 
          <term>
877
 
            <literal>"elbow"</literal>
878
 
          </term>
879
 
          <listitem>
880
 
            <para>Defines the key for the elbow style. Possible
881
 
              values are 
882
 
              <literal>"horizontal"</literal>and 
883
 
              <literal>"vertical"</literal>. Default is 
884
 
              <literal>"horizontal"</literal>. This defines how the
885
 
              three segment orthogonal edge style leaves its terminal
886
 
              vertices. The vertical style leaves the terminal
887
 
              vertices at the top and bottom sides.
888
 
            </para>
889
 
          </listitem>
890
 
        </varlistentry>
891
 
        <varlistentry>
892
 
          <term>
893
 
            <literal>"fontColor"</literal>
894
 
          </term>
895
 
          <listitem>
896
 
            <para>Defines the key for the fontColor style. The
897
 
              value is type String and of the expression described
898
 
              below.
899
 
            </para>
900
 
          </listitem>
901
 
        </varlistentry>
902
 
        <varlistentry>
903
 
          <term>
904
 
            <literal>"fontFamily"</literal>
905
 
          </term>
906
 
          <listitem>
907
 
            <para>Defines the key for the fontFamily style.
908
 
              Possible values are names such as 
909
 
              <literal>Arial</literal>; 
910
 
              <literal>Dialog</literal>; 
911
 
              <literal>Verdana</literal>; 
912
 
              <literal>Times New Roman</literal>. The value is of
913
 
              type String.
914
 
            </para>
915
 
          </listitem>
916
 
        </varlistentry>
917
 
        <varlistentry>
918
 
          <term>
919
 
            <literal>"fontSize"</literal>
920
 
          </term>
921
 
          <listitem>
922
 
            <para>Defines the key for the fontSize style (in
923
 
              points). The type of the value is int.
924
 
            </para>
925
 
          </listitem>
926
 
        </varlistentry>
927
 
        <varlistentry>
928
 
          <term>
929
 
            <literal>"fontStyle"</literal>
930
 
          </term>
931
 
          <listitem>
932
 
            <para>Defines the key for the fontStyle style. Values
933
 
              may be any logical AND (sum) of values on the 
934
 
              <link linkend="jgraphx-style-font-table">font style
935
 
                table
936
 
              </link>
937
 
              .The type of the value is int.
938
 
            </para>
939
 
          </listitem>
940
 
        </varlistentry>
941
 
        <varlistentry>
942
 
          <term>
943
 
            <literal>"shape"</literal>
944
 
          </term>
945
 
          <listitem>
946
 
            <para>Defines the key for the shape style. Possible
947
 
              values are any of 
948
 
              <link linkend="jgraphx-style-shape-list">shape
949
 
                list
950
 
              </link>
951
 
              .
952
 
            </para>
953
 
          </listitem>
954
 
        </varlistentry>
955
 
        <varlistentry>
956
 
          <term>
957
 
            <literal>"routingCenterX"</literal>
958
 
          </term>
959
 
          <listitem>
960
 
            <para>Defines the key for the horizontal routing
961
 
              center. Possible values are between -0.5 and 0.5. This
962
 
              is the relative offset from the center used for
963
 
              connecting edges. The type of this value is
964
 
              float.
965
 
            </para>
966
 
          </listitem>
967
 
        </varlistentry>
968
 
        <varlistentry>
969
 
          <term>
970
 
            <literal>"routingCenterY"</literal>
971
 
          </term>
972
 
          <listitem>
973
 
            <para>Defines the key for the vertical routing center.
974
 
              Possible values are between -0.5 and 0.5. This is the
975
 
              relative offset from the center used for connecting
976
 
              edges. The type of this value is float;
977
 
            </para>
978
 
          </listitem>
979
 
        </varlistentry>
980
 
      </variablelist>
981
 
    </para>
982
 
    <para>
983
 
      <itemizedlist xml:id="jgraphx-style-align-list">
984
 
        <title>JGraphx alignment values</title>
985
 
        <listitem>
986
 
          <para>
987
 
            <literal>"left"</literal>- horizontal alignment
988
 
          </para>
989
 
        </listitem>
990
 
        <listitem>
991
 
          <para>
992
 
            <literal>"center"</literal>- horizontal alignment
993
 
          </para>
994
 
        </listitem>
995
 
        <listitem>
996
 
          <para>
997
 
            <literal>"right"</literal>- horizontal alignment
998
 
          </para>
999
 
        </listitem>
1000
 
        <listitem>
1001
 
          <para>
1002
 
            <literal>"top"</literal>- vertical alignment
1003
 
          </para>
1004
 
        </listitem>
1005
 
        <listitem>
1006
 
          <para>
1007
 
            <literal>"middle"</literal>- vertical alignment
1008
 
          </para>
1009
 
        </listitem>
1010
 
        <listitem>
1011
 
          <para>
1012
 
            <literal>"bottom"</literal>- vertical alignment
1013
 
          </para>
1014
 
        </listitem>
1015
 
      </itemizedlist>
1016
 
      <itemizedlist xml:id="jgraphx-style-arrow-list">
1017
 
        <title>JGraphx arrow values</title>
1018
 
        <listitem>
1019
 
          <para>
1020
 
            <literal>"classic"</literal>
1021
 
          </para>
1022
 
        </listitem>
1023
 
        <listitem>
1024
 
          <para>
1025
 
            <literal>"block"</literal>
1026
 
          </para>
1027
 
        </listitem>
1028
 
        <listitem>
1029
 
          <para>
1030
 
            <literal>"oval"</literal>
1031
 
          </para>
1032
 
        </listitem>
1033
 
        <listitem>
1034
 
          <para>
1035
 
            <literal>"diamond"</literal>
1036
 
          </para>
1037
 
        </listitem>
1038
 
      </itemizedlist>
1039
 
      <itemizedlist xml:id="jgraphx-style-shape-list">
1040
 
        <title>JGraphx shape values</title>
1041
 
        <listitem>
1042
 
          <para>
1043
 
            <literal>"rectangle"</literal>
1044
 
          </para>
1045
 
        </listitem>
1046
 
        <listitem>
1047
 
          <para>
1048
 
            <literal>"ellipse"</literal>
1049
 
          </para>
1050
 
        </listitem>
1051
 
        <listitem>
1052
 
          <para>
1053
 
            <literal>"doubleEllipse"</literal>
1054
 
          </para>
1055
 
        </listitem>
1056
 
        <listitem>
1057
 
          <para>
1058
 
            <literal>"rhombus"</literal>
1059
 
          </para>
1060
 
        </listitem>
1061
 
        <listitem>
1062
 
          <para>
1063
 
            <literal>"line"</literal>
1064
 
          </para>
1065
 
        </listitem>
1066
 
        <listitem>
1067
 
          <para>
1068
 
            <literal>"image"</literal>
1069
 
          </para>
1070
 
        </listitem>
1071
 
        <listitem>
1072
 
          <para>
1073
 
            <literal>"arrow"</literal>
1074
 
          </para>
1075
 
        </listitem>
1076
 
        <listitem>
1077
 
          <para>
1078
 
            <literal>"curve"</literal>
1079
 
          </para>
1080
 
        </listitem>
1081
 
        <listitem>
1082
 
          <para>
1083
 
            <literal>"label"</literal>
1084
 
          </para>
1085
 
        </listitem>
1086
 
        <listitem>
1087
 
          <para>
1088
 
            <literal>"cylinder"</literal>
1089
 
          </para>
1090
 
        </listitem>
1091
 
        <listitem>
1092
 
          <para>
1093
 
            <literal>"swimlane"</literal>
1094
 
          </para>
1095
 
        </listitem>
1096
 
        <listitem>
1097
 
          <para>
1098
 
            <literal>"connector"</literal>
1099
 
          </para>
1100
 
        </listitem>
1101
 
        <listitem>
1102
 
          <para>
1103
 
            <literal>"actor"</literal>
1104
 
          </para>
1105
 
        </listitem>
1106
 
        <listitem>
1107
 
          <para>
1108
 
            <literal>"cloud"</literal>
1109
 
          </para>
1110
 
        </listitem>
1111
 
        <listitem>
1112
 
          <para>
1113
 
            <literal>"triangle"</literal>
1114
 
          </para>
1115
 
        </listitem>
1116
 
        <listitem>
1117
 
          <para>
1118
 
            <literal>"hexagon"</literal>
1119
 
          </para>
1120
 
        </listitem>
1121
 
      </itemizedlist>
1122
 
      <itemizedlist xml:id="jgraphx-style-color-list">
1123
 
        <title>JGraphx valid color values</title>
1124
 
        <listitem>
1125
 
          <para>Web notation colors - 
1126
 
            <literal>"#E1E1E1"</literal>for example
1127
 
          </para>
1128
 
        </listitem>
1129
 
        <listitem>
1130
 
          <para>Java parseable colors - int values as RGB or sRGB
1131
 
            colors
1132
 
          </para>
1133
 
        </listitem>
1134
 
        <listitem>
1135
 
          <para>
1136
 
            <literal>"white"</literal>
1137
 
          </para>
1138
 
        </listitem>
1139
 
        <listitem>
1140
 
          <para>
1141
 
            <literal>"black"</literal>
1142
 
          </para>
1143
 
        </listitem>
1144
 
        <listitem>
1145
 
          <para>
1146
 
            <literal>"red"</literal>
1147
 
          </para>
1148
 
        </listitem>
1149
 
        <listitem>
1150
 
          <para>
1151
 
            <literal>"green"</literal>
1152
 
          </para>
1153
 
        </listitem>
1154
 
        <listitem>
1155
 
          <para>
1156
 
            <literal>"blue"</literal>
1157
 
          </para>
1158
 
        </listitem>
1159
 
        <listitem>
1160
 
          <para>
1161
 
            <literal>"orange"</literal>
1162
 
          </para>
1163
 
        </listitem>
1164
 
        <listitem>
1165
 
          <para>
1166
 
            <literal>"yellow"</literal>
1167
 
          </para>
1168
 
        </listitem>
1169
 
        <listitem>
1170
 
          <para>
1171
 
            <literal>"pink"</literal>
1172
 
          </para>
1173
 
        </listitem>
1174
 
        <listitem>
1175
 
          <para>
1176
 
            <literal>"turquoise"</literal>
1177
 
          </para>
1178
 
        </listitem>
1179
 
        <listitem>
1180
 
          <para>
1181
 
            <literal>"gray"</literal>
1182
 
          </para>
1183
 
        </listitem>
1184
 
      </itemizedlist>
1185
 
      <itemizedlist xml:id="jgraphx-style-direction-list">
1186
 
        <title>JGraphx direction values</title>
1187
 
        <listitem>
1188
 
          <para>
1189
 
            <literal>"north"</literal>
1190
 
          </para>
1191
 
        </listitem>
1192
 
        <listitem>
1193
 
          <para>
1194
 
            <literal>"south"</literal>
1195
 
          </para>
1196
 
        </listitem>
1197
 
        <listitem>
1198
 
          <para>
1199
 
            <literal>"east"</literal>
1200
 
          </para>
1201
 
        </listitem>
1202
 
        <listitem>
1203
 
          <para>
1204
 
            <literal>"west"</literal>
1205
 
          </para>
1206
 
        </listitem>
1207
 
      </itemizedlist>
1208
 
      <itemizedlist xml:id="jgraphx-style-font-table">
1209
 
        <title>JGraphx font modifier values</title>
1210
 
        <listitem>
1211
 
          <para>bold - 
1212
 
            <literal>1</literal>
1213
 
          </para>
1214
 
        </listitem>
1215
 
        <listitem>
1216
 
          <para>italic - 
1217
 
            <literal>2</literal>
1218
 
          </para>
1219
 
        </listitem>
1220
 
        <listitem>
1221
 
          <para>underline - 
1222
 
            <literal>4</literal>
1223
 
          </para>
1224
 
        </listitem>
1225
 
        <listitem>
1226
 
          <para>shadow - 
1227
 
            <literal>8</literal>
1228
 
          </para>
1229
 
        </listitem>
1230
 
      </itemizedlist>
1231
 
    </para>
1232
 
    <para/>
1233
 
  </refsection>
1234
 
  <refsection>
1235
 
    <title>Examples</title>
1236
 
    <para>
1237
 
      <programlisting role="example"><![CDATA[
 
3
    <refnamediv>
 
4
        <refname>xcosPalAddBlock</refname>
 
5
        <refpurpose>Add a block to a Scilab/Xcos palette instance. Some
 
6
            optional properties can be added to customize the palette icon
 
7
            and the style of the block.
 
8
        </refpurpose>
 
9
    </refnamediv>
 
10
    <refsynopsisdiv>
 
11
        <title>Calling Sequence</title>
 
12
        <synopsis>
 
13
            pal = xcosPalAddBlock(pal, block)
 
14
            pal = xcosPalAddBlock(pal, block, pal_block_img)
 
15
            pal = xcosPalAddBlock(pal, block, [], style)
 
16
            pal = xcosPalAddBlock(pal, block, pal_block_img, style)
 
17
        </synopsis>
 
18
    </refsynopsisdiv>
 
19
    <refsection>
 
20
        <title>Arguments</title>
 
21
        <variablelist>
 
22
            <varlistentry>
 
23
                <term>pal:</term>
 
24
                <listitem>
 
25
                    <para>the palette to update</para>
 
26
                </listitem>
 
27
            </varlistentry>
 
28
            <varlistentry>
 
29
                <term>block:</term>
 
30
                <listitem>
 
31
                    <para>the block to add to the palette</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>pal_block_img:</term>
 
36
                <listitem>
 
37
                    <para>the block icon to use on the palette
 
38
                        manager (png, jpg, gif).
 
39
                    </para>
 
40
                </listitem>
 
41
            </varlistentry>
 
42
            <varlistentry>
 
43
                <term>style:</term>
 
44
                <listitem>
 
45
                    <para>the style to apply to the block</para>
 
46
                </listitem>
 
47
            </varlistentry>
 
48
        </variablelist>
 
49
    </refsection>
 
50
    <refsection>
 
51
        <title>Description</title>
 
52
        <para>This macros add a block instance to a palette. This block
 
53
            parameter can be an instantiated block or a name
 
54
            (interface-function) or a path to a saved instance. Some
 
55
            operations are performed to load this block and check it's
 
56
            availability so it's interface-function must be loaded on
 
57
            Scilab. Some temporary files are also generated without full
 
58
            path arguments.
 
59
        </para>
 
60
        <para>The optional pal_block_img argument is generated on the 
 
61
            <link linkend="TMPDIR">TMPDIR</link>using Scilab graphics if
 
62
            not specified.Be careful that if you use our palette to be
 
63
            persistent you then need to specify it. Otherwise the generated
 
64
            image will be deleted at the end of the Scilab session.
 
65
        </para>
 
66
        <para>The optional style argument allow the user to determine
 
67
            the kind of style to be used by this block. This argument can
 
68
            be typed as a path 
 
69
            <link linkend="string">string</link> to an image (svg, png, jpg, gif) or a 
 
70
            <link linkend="struct">struct</link>. If it is a string then a
 
71
            default style value is generated and formatted as a style else
 
72
            a struct is wrapped to a key-value jgraphx settings. The 
 
73
            <link linkend="jgraphx-style-list">following
 
74
                style
 
75
            </link>
 
76
            correspond to jgraphx version 1.4.0.2. These style
 
77
            keys can change with new version of jgraphx without any
 
78
            warranty.
 
79
        </para>
 
80
        <para>
 
81
            <variablelist xml:id="jgraphx-style-list">
 
82
                <title>JGraphx style keys</title>
 
83
                <varlistentry>
 
84
                    <term>
 
85
                        <literal>"opacity"</literal>
 
86
                    </term>
 
87
                    <listitem>
 
88
                        <para>Defines the key for the opacity style. The type
 
89
                            of the value is float and the possible range is 
 
90
                            <literal>0-100</literal>.
 
91
                        </para>
 
92
                    </listitem>
 
93
                </varlistentry>
 
94
                <varlistentry>
 
95
                    <term>
 
96
                        <literal>"textOpacity"</literal>
 
97
                    </term>
 
98
                    <listitem>
 
99
                        <para>Defines the key for the text opacity style. The
 
100
                            type of the value is float and the possible range is 
 
101
                            <literal>0-100</literal>.
 
102
                        </para>
 
103
                    </listitem>
 
104
                </varlistentry>
 
105
                <varlistentry>
 
106
                    <term>
 
107
                        <literal>"overflow"</literal>
 
108
                    </term>
 
109
                    <listitem>
 
110
                        <para>Defines the key for the overflow style. Possible
 
111
                            values are 
 
112
                            <literal>"visible"</literal>, 
 
113
                            <literal>"hidden"</literal>or 
 
114
                            <literal>"fill"</literal>. The default value is
 
115
                            "visible". This value specifies how overlapping vertex
 
116
                            labels are handles. A value of "visible" will show the
 
117
                            complete label. A value of "hidden" will clip the label
 
118
                            so that it does not overlap the vertex bounds. A value
 
119
                            of "fill" will use the vertex bounds for the
 
120
                            label.
 
121
                        </para>
 
122
                    </listitem>
 
123
                </varlistentry>
 
124
                <varlistentry>
 
125
                    <term>
 
126
                        <literal>"orthogonal"</literal>
 
127
                    </term>
 
128
                    <listitem>
 
129
                        <para>Defines if the connection points on either end of
 
130
                            the edge should be computed so that the edge is
 
131
                            vertical or horizontal if possible and if the point is
 
132
                            not at a fixed location. Default is 
 
133
                            <literal>false</literal>.
 
134
                        </para>
 
135
                    </listitem>
 
136
                </varlistentry>
 
137
                <varlistentry>
 
138
                    <term>
 
139
                        <literal>"exitX"</literal>
 
140
                    </term>
 
141
                    <listitem>
 
142
                        <para>Defines the key for the horizontal relative
 
143
                            coordinate connection point of an edge with its source
 
144
                            terminal.
 
145
                        </para>
 
146
                    </listitem>
 
147
                </varlistentry>
 
148
                <varlistentry>
 
149
                    <term>
 
150
                        <literal>"exitY"</literal>
 
151
                    </term>
 
152
                    <listitem>
 
153
                        <para>Defines the key for the vertical relative
 
154
                            coordinate connection point of an edge with its source
 
155
                            terminal.
 
156
                        </para>
 
157
                    </listitem>
 
158
                </varlistentry>
 
159
                <varlistentry>
 
160
                    <term>
 
161
                        <literal>"exitPerimeter"</literal>
 
162
                    </term>
 
163
                    <listitem>
 
164
                        <para>Defines if the perimeter should be used to find
 
165
                            the exact entry point along the perimeter of the
 
166
                            source. The type of the value is 
 
167
                            <link linkend="boolean">boolean</link>. Default is 
 
168
                            <literal>true</literal>.
 
169
                        </para>
 
170
                    </listitem>
 
171
                </varlistentry>
 
172
                <varlistentry>
 
173
                    <term>
 
174
                        <literal>"entryX"</literal>
 
175
                    </term>
 
176
                    <listitem>
 
177
                        <para>Defines the key for the horizontal relative
 
178
                            coordinate connection point of an edge with its target
 
179
                            terminal.
 
180
                        </para>
 
181
                    </listitem>
 
182
                </varlistentry>
 
183
                <varlistentry>
 
184
                    <term>
 
185
                        <literal>"entryY"</literal>
 
186
                    </term>
 
187
                    <listitem>
 
188
                        <para>Defines the key for the vertical relative
 
189
                            coordinate connection point of an edge with its target
 
190
                            terminal.
 
191
                        </para>
 
192
                    </listitem>
 
193
                </varlistentry>
 
194
                <varlistentry>
 
195
                    <term>
 
196
                        <literal>"entryPerimeter"</literal>
 
197
                    </term>
 
198
                    <listitem>
 
199
                        <para>Defines if the perimeter should be used to find
 
200
                            the exact entry point along the perimeter of the
 
201
                            target. The type of the value is 
 
202
                            <link linkend="boolean">boolean</link>. Default is 
 
203
                            <literal>true</literal>.
 
204
                        </para>
 
205
                    </listitem>
 
206
                </varlistentry>
 
207
                <varlistentry>
 
208
                    <term>
 
209
                        <literal>"whiteSpace"</literal>
 
210
                    </term>
 
211
                    <listitem>
 
212
                        <para>Defines the key for the white-space style.
 
213
                            Possible values are 
 
214
                            <literal>"nowrap"</literal>and 
 
215
                            <literal>"wrap"</literal>. The default value is 
 
216
                            <literal>"nowrap"</literal>. This value specifies how
 
217
                            white-space inside a HTML vertex label should be
 
218
                            handled. A value of 
 
219
                            <literal>"nowrap"</literal>means the text will never
 
220
                            wrap to the next line until a linefeed is encountered.
 
221
                            A value of 
 
222
                            <literal>"wrap"</literal>means text will wrap when
 
223
                            necessary.
 
224
                        </para>
 
225
                    </listitem>
 
226
                </varlistentry>
 
227
                <varlistentry>
 
228
                    <term>
 
229
                        <literal>"rotation"</literal>
 
230
                    </term>
 
231
                    <listitem>
 
232
                        <para>Defines the key for the rotation style. The type
 
233
                            of the value is double and the possible range is 
 
234
                            <literal>0-360</literal>.
 
235
                        </para>
 
236
                    </listitem>
 
237
                </varlistentry>
 
238
                <varlistentry>
 
239
                    <term>
 
240
                        <literal>"fillColor"</literal>
 
241
                    </term>
 
242
                    <listitem>
 
243
                        <para>Defines the key for the fillColor style. The
 
244
                            value is a string expression described on the 
 
245
                            <link linkend="jgraphx-style-color-list">color
 
246
                                list
 
247
                            </link>
 
248
                            .
 
249
                        </para>
 
250
                    </listitem>
 
251
                </varlistentry>
 
252
                <varlistentry>
 
253
                    <term>
 
254
                        <literal>"gradientColor"</literal>
 
255
                    </term>
 
256
                    <listitem>
 
257
                        <para>Defines the key for the gradientColor style. The
 
258
                            value is a string expression described on the 
 
259
                            <link linkend="jgraphx-style-color-list">color
 
260
                                list
 
261
                            </link>
 
262
                            .This is ignored if no 
 
263
                            <literal>"fillColor"</literal>is defined.
 
264
                        </para>
 
265
                    </listitem>
 
266
                </varlistentry>
 
267
                <varlistentry>
 
268
                    <term>
 
269
                        <literal>"gradientDirection"</literal>
 
270
                    </term>
 
271
                    <listitem>
 
272
                        <para>Defines the key for the gradient direction. The
 
273
                            value is a string expression described on the 
 
274
                            <link linkend="jgraphx-style-direction-list">direction
 
275
                                list
 
276
                            </link>
 
277
                            .Default is 
 
278
                            <literal>"south"</literal>. Generally, and by default,
 
279
                            gradient painting is done from the value of 
 
280
                            <literal>"fillColor"</literal>to the value of 
 
281
                            <literal>"gradientColor"</literal>. Taking the example
 
282
                            of 
 
283
                            <literal>"north"</literal>, this means 
 
284
                            <literal>"fillColor"</literal>color at the bottom of
 
285
                            paint pattern and 
 
286
                            <literal>"gradientColor"</literal>at top, with a
 
287
                            gradient in-between.
 
288
                        </para>
 
289
                    </listitem>
 
290
                </varlistentry>
 
291
                <varlistentry>
 
292
                    <term>
 
293
                        <literal>"strokeColor"</literal>
 
294
                    </term>
 
295
                    <listitem>
 
296
                        <para>Defines the key for the strokeColor style. The
 
297
                            value is a string expression on the 
 
298
                            <link linkend="jgraphx-style-color-list">color
 
299
                                list
 
300
                            </link>
 
301
                            .
 
302
                        </para>
 
303
                    </listitem>
 
304
                </varlistentry>
 
305
                <varlistentry>
 
306
                    <term>
 
307
                        <literal>"separatorColor"</literal>
 
308
                    </term>
 
309
                    <listitem>
 
310
                        <para>Defines the key for the separatorColor style. The
 
311
                            value is a string expression described on the 
 
312
                            <link linkend="jgraphx-style-color-list">color
 
313
                                list
 
314
                            </link>
 
315
                            .This style is only used for 
 
316
                            <literal>swimlane</literal>shapes.
 
317
                        </para>
 
318
                    </listitem>
 
319
                </varlistentry>
 
320
                <varlistentry>
 
321
                    <term>
 
322
                        <literal>"strokeWidth"</literal>
 
323
                    </term>
 
324
                    <listitem>
 
325
                        <para>Defines the key for the strokeWidth style. The
 
326
                            type of the value is float and the possible range is
 
327
                            any non-negative value. The value reflects the stroke
 
328
                            width in pixels.
 
329
                        </para>
 
330
                    </listitem>
 
331
                </varlistentry>
 
332
                <varlistentry>
 
333
                    <term>
 
334
                        <literal>"align"</literal>
 
335
                    </term>
 
336
                    <listitem>
 
337
                        <para>Defines the key for the align style. Possible
 
338
                            values are described on the 
 
339
                            <link linkend="jgraphx-style-align-list">alignment
 
340
                                list
 
341
                            </link>
 
342
                            .This value defines how the lines of the
 
343
                            label are horizontally aligned. 
 
344
                            <literal>"left"</literal>mean label text lines are
 
345
                            aligned to left of the label bounds, 
 
346
                            <literal>"right"</literal>to the right of the label
 
347
                            bounds and 
 
348
                            <literal>"center"</literal>means the center of the text
 
349
                            lines are aligned in the center of the label bounds.
 
350
                            Note this value does not affect the positioning of the
 
351
                            overall label bounds relative to the vertex, to move
 
352
                            the label bounds horizontally, use 
 
353
                            <literal>"labelPosition"</literal>.
 
354
                        </para>
 
355
                    </listitem>
 
356
                </varlistentry>
 
357
                <varlistentry>
 
358
                    <term>
 
359
                        <literal>"verticalAlign"</literal>
 
360
                    </term>
 
361
                    <listitem>
 
362
                        <para>Defines the key for the verticalAlign style.
 
363
                            Possible values are described on the 
 
364
                            <link linkend="jgraphx-style-align-list">alignment
 
365
                                list
 
366
                            </link>
 
367
                            .This value defines how the lines of the
 
368
                            label are vertically aligned. 
 
369
                            <literal>"top"</literal>means the topmost label text
 
370
                            line is aligned against the top of the label bounds, 
 
371
                            <literal>"bottom"</literal>means the bottom-most label
 
372
                            text line is aligned against the bottom of the label
 
373
                            bounds and 
 
374
                            <literal>"middle"</literal>means there is equal spacing
 
375
                            between the topmost text label line and the top of the
 
376
                            label bounds and the bottom-most text label line and
 
377
                            the bottom of the label bounds. Note this value does not
 
378
                            affect the positioning of the overall label bounds
 
379
                            relative to the vertex, to move the label bounds
 
380
                            vertically, use 
 
381
                            <literal>"verticalLabelPosition"</literal>.
 
382
                        </para>
 
383
                    </listitem>
 
384
                </varlistentry>
 
385
                <varlistentry>
 
386
                    <term>
 
387
                        <literal>"labelPosition"</literal>
 
388
                    </term>
 
389
                    <listitem>
 
390
                        <para>Defines the key for the horizontal label position
 
391
                            of vertices. Possible values are described on the 
 
392
                            <link linkend="jgraphx-style-align-list">alignment
 
393
                                list
 
394
                            </link>
 
395
                            .Default is 
 
396
                            <literal>"center"</literal>. The label align defines
 
397
                            the position of the label relative to the cell. 
 
398
                            <literal>"left"</literal>means the entire label bounds
 
399
                            is placed completely just to the left of the vertex, 
 
400
                            <literal>"right"</literal>means adjust to the right and
 
401
                            
 
402
                            <literal>"center"</literal>means the label bounds are
 
403
                            vertically aligned with the bounds of the vertex. Note
 
404
                            this value does not affect the positioning of label
 
405
                            within the label bounds, to move the label horizontally
 
406
                            within the label bounds, use 
 
407
                            <literal>"align"</literal>.
 
408
                        </para>
 
409
                    </listitem>
 
410
                </varlistentry>
 
411
                <varlistentry>
 
412
                    <term>
 
413
                        <literal>"verticalLabelPosition"</literal>
 
414
                    </term>
 
415
                    <listitem>
 
416
                        <para>Defines the key for the vertical label position
 
417
                            of vertices. Possible values are described on the 
 
418
                            <link linkend="jgraphx-style-align-list">alignment
 
419
                                list
 
420
                            </link>
 
421
                            .Default is 
 
422
                            <literal>"middle"</literal>. The label align defines
 
423
                            the position of the label relative to the cell. 
 
424
                            <literal>"top"</literal>means the entire label bounds
 
425
                            is placed completely just on the top of the vertex, 
 
426
                            <literal>"bottom"</literal>means adjust on the bottom
 
427
                            and 
 
428
                            <literal>"middle"</literal>means the label bounds are
 
429
                            horizontally aligned with the bounds of the vertex.
 
430
                            Note this value does not affect the positioning of label
 
431
                            within the label bounds, to move the label vertically
 
432
                            within the label bounds, use 
 
433
                            <literal>"verticalAlign"</literal>.
 
434
                        </para>
 
435
                    </listitem>
 
436
                </varlistentry>
 
437
                <varlistentry>
 
438
                    <term>
 
439
                        <literal>"imageAlign"</literal>
 
440
                    </term>
 
441
                    <listitem>
 
442
                        <para>Defines the key for the align style. Possible
 
443
                            values are described on the 
 
444
                            <link linkend="jgraphx-style-align-list">alignment
 
445
                                list
 
446
                            </link>
 
447
                            .The value defines how any image in the
 
448
                            vertex label is aligned horizontally within the label
 
449
                            bounds of a 
 
450
                            <literal>"label"</literal>shape.
 
451
                        </para>
 
452
                    </listitem>
 
453
                </varlistentry>
 
454
                <varlistentry>
 
455
                    <term>
 
456
                        <literal>"imageVerticalAlign"</literal>
 
457
                    </term>
 
458
                    <listitem>
 
459
                        <para>Defines the key for the verticalAlign style.
 
460
                            Possible values are described on the 
 
461
                            <link linkend="jgraphx-style-align-list">alignment
 
462
                                list
 
463
                            </link>
 
464
                            .The value defines how any image in the
 
465
                            vertex label is aligned vertically within the label
 
466
                            bounds of a 
 
467
                            <literal>"label"</literal>shape.
 
468
                        </para>
 
469
                    </listitem>
 
470
                </varlistentry>
 
471
                <varlistentry>
 
472
                    <term>
 
473
                        <literal>"image"</literal>
 
474
                    </term>
 
475
                    <listitem>
 
476
                        <para>Defines the key for the image style. Possible
 
477
                            values are any image URL, the type of the value is
 
478
                            String. This is the path to the image to image that is
 
479
                            to be displayed within the label of a vertex.
 
480
                        </para>
 
481
                    </listitem>
 
482
                </varlistentry>
 
483
                <varlistentry>
 
484
                    <term>
 
485
                        <literal>"imageWidth"</literal>
 
486
                    </term>
 
487
                    <listitem>
 
488
                        <para>Defines the key for the imageWidth style. The
 
489
                            type of this value is int, the value is the image width
 
490
                            in pixels and must be greated than 
 
491
                            <literal>0</literal>.
 
492
                        </para>
 
493
                    </listitem>
 
494
                </varlistentry>
 
495
                <varlistentry>
 
496
                    <term>
 
497
                        <literal>"imageHeight"</literal>
 
498
                    </term>
 
499
                    <listitem>
 
500
                        <para>Defines the key for the imageHeight style The
 
501
                            type of this value is int, the value is the image
 
502
                            height in pixels and must be greater than 
 
503
                            <literal>0</literal>.
 
504
                        </para>
 
505
                    </listitem>
 
506
                </varlistentry>
 
507
                <varlistentry>
 
508
                    <term>
 
509
                        <literal>"noLabel"</literal>
 
510
                    </term>
 
511
                    <listitem>
 
512
                        <para>Defines the key for the noLabel style. If this is
 
513
                            
 
514
                            <literal>true</literal>then no label is visible for a
 
515
                            given cell. The type of the value is 
 
516
                            <link linkend="boolean">boolean</link>. Default is 
 
517
                            <literal>false</literal>.
 
518
                        </para>
 
519
                    </listitem>
 
520
                </varlistentry>
 
521
                <varlistentry>
 
522
                    <term>
 
523
                        <literal>"noEdgeStyle"</literal>
 
524
                    </term>
 
525
                    <listitem>
 
526
                        <para>Defines the key for the noEdgeStyle style. If
 
527
                            this is 
 
528
                            <literal>true</literal>then no edge style is applied
 
529
                            for a given edge. The type of the value is 
 
530
                            <link linkend="boolean">boolean</link>. Default is 
 
531
                            <literal>false</literal>.
 
532
                        </para>
 
533
                    </listitem>
 
534
                </varlistentry>
 
535
                <varlistentry>
 
536
                    <term>
 
537
                        <literal>"labelBackgroundColor"</literal>
 
538
                    </term>
 
539
                    <listitem>
 
540
                        <para>Defines the key for the label background color.
 
541
                            The value is a string expression described on the 
 
542
                            <link linkend="jgraphx-style-color-list">color
 
543
                                list
 
544
                            </link>
 
545
                            .
 
546
                        </para>
 
547
                    </listitem>
 
548
                </varlistentry>
 
549
                <varlistentry>
 
550
                    <term>
 
551
                        <literal>"labelBorderColor"</literal>
 
552
                    </term>
 
553
                    <listitem>
 
554
                        <para>Defines the key for the label border color. The
 
555
                            value is a string expression described on the 
 
556
                            <link linkend="jgraphx-style-color-list">color
 
557
                                list
 
558
                            </link>
 
559
                            .
 
560
                        </para>
 
561
                    </listitem>
 
562
                </varlistentry>
 
563
                <varlistentry>
 
564
                    <term>
 
565
                        <literal>"indicatorShape"</literal>
 
566
                    </term>
 
567
                    <listitem>
 
568
                        <para>Defines the key for the indicatorShape style.
 
569
                            Possible values are described on the 
 
570
                            <link linkend="jgraphx-style-shape-list">shape
 
571
                                list
 
572
                            </link>
 
573
                            .
 
574
                        </para>
 
575
                    </listitem>
 
576
                </varlistentry>
 
577
                <varlistentry>
 
578
                    <term>
 
579
                        <literal>"indicatorImage"</literal>
 
580
                    </term>
 
581
                    <listitem>
 
582
                        <para>Defines the key for the indicatorImage style.
 
583
                            Possible values are any image URL, the type of the
 
584
                            value is String.
 
585
                        </para>
 
586
                    </listitem>
 
587
                </varlistentry>
 
588
                <varlistentry>
 
589
                    <term>
 
590
                        <literal>"indicatorColor"</literal>
 
591
                    </term>
 
592
                    <listitem>
 
593
                        <para>Defines the key for the indicatorColor style. The
 
594
                            value is a string expression described below.
 
595
                        </para>
 
596
                    </listitem>
 
597
                </varlistentry>
 
598
                <varlistentry>
 
599
                    <term>
 
600
                        <literal>"indicatorGradientColor"</literal>
 
601
                    </term>
 
602
                    <listitem>
 
603
                        <para>Defines the key for the indicatorGradientColor
 
604
                            style. The value is a string expression described on
 
605
                            the 
 
606
                            <link linkend="jgraphx-style-color-list">color
 
607
                                list
 
608
                            </link>
 
609
                            .This style is only supported in 
 
610
                            <literal>shape</literal>shapes.
 
611
                        </para>
 
612
                    </listitem>
 
613
                </varlistentry>
 
614
                <varlistentry>
 
615
                    <term>
 
616
                        <literal>"indicatorSpacing"</literal>
 
617
                    </term>
 
618
                    <listitem>
 
619
                        <para>Defines the key for the indicatorSpacing style
 
620
                            (in px).
 
621
                        </para>
 
622
                    </listitem>
 
623
                </varlistentry>
 
624
                <varlistentry>
 
625
                    <term>
 
626
                        <literal>"indicatorWidth"</literal>
 
627
                    </term>
 
628
                    <listitem>
 
629
                        <para>Defines the key for the indicatorWidth style (in
 
630
                            px).
 
631
                        </para>
 
632
                    </listitem>
 
633
                </varlistentry>
 
634
                <varlistentry>
 
635
                    <term>
 
636
                        <literal>"indicatorHeight"</literal>
 
637
                    </term>
 
638
                    <listitem>
 
639
                        <para>Defines the key for the indicatorHeight style (in
 
640
                            px).
 
641
                        </para>
 
642
                    </listitem>
 
643
                </varlistentry>
 
644
                <varlistentry>
 
645
                    <term>
 
646
                        <literal>"shadow"</literal>
 
647
                    </term>
 
648
                    <listitem>
 
649
                        <para>Defines the key for the shadow style. The type of
 
650
                            the value is 
 
651
                            <link linkend="boolean">boolean</link>. This style
 
652
                            applies to vertices and arrow style edges.
 
653
                        </para>
 
654
                    </listitem>
 
655
                </varlistentry>
 
656
                <varlistentry>
 
657
                    <term>
 
658
                        <literal>"endArrow"</literal>
 
659
                    </term>
 
660
                    <listitem>
 
661
                        <para>Defines the key for the endArrow style. Possible
 
662
                            values are described on the 
 
663
                            <link linkend="jgraphx-style-arrow-list">arrow
 
664
                                list
 
665
                            </link>
 
666
                            .
 
667
                        </para>
 
668
                    </listitem>
 
669
                </varlistentry>
 
670
                <varlistentry>
 
671
                    <term>
 
672
                        <literal>"startArrow"</literal>
 
673
                    </term>
 
674
                    <listitem>
 
675
                        <para>Defines the key for the startArrow style.
 
676
                            Possible values are described on the 
 
677
                            <link linkend="jgraphx-style-arrow-list">arrow
 
678
                                list
 
679
                            </link>
 
680
                            .
 
681
                        </para>
 
682
                    </listitem>
 
683
                </varlistentry>
 
684
                <varlistentry>
 
685
                    <term>
 
686
                        <literal>"endSize"</literal>
 
687
                    </term>
 
688
                    <listitem>
 
689
                        <para>Defines the key for the endSize style. The type
 
690
                            of this value is float and the value represents the
 
691
                            size of the end marker in pixels.
 
692
                        </para>
 
693
                    </listitem>
 
694
                </varlistentry>
 
695
                <varlistentry>
 
696
                    <term>
 
697
                        <literal>"startSize"</literal>
 
698
                    </term>
 
699
                    <listitem>
 
700
                        <para>Defines the key for the startSize style. The type
 
701
                            of this value is float and the value represents the
 
702
                            size of the start marker or the size of the swimlane
 
703
                            title region depending on the shape it is used
 
704
                            for.
 
705
                        </para>
 
706
                    </listitem>
 
707
                </varlistentry>
 
708
                <varlistentry>
 
709
                    <term>
 
710
                        <literal>"dashed"</literal>
 
711
                    </term>
 
712
                    <listitem>
 
713
                        <para>Defines the key for the dashed style. The type of
 
714
                            this value is 
 
715
                            <link linkend="boolean">boolean</link>and the value
 
716
                            determines whether or not an edge or border is drawn
 
717
                            with a dashed pattern along the line.
 
718
                        </para>
 
719
                    </listitem>
 
720
                </varlistentry>
 
721
                <varlistentry>
 
722
                    <term>
 
723
                        <literal>"rounded"</literal>
 
724
                    </term>
 
725
                    <listitem>
 
726
                        <para>Defines the key for the rounded style. The type
 
727
                            of this value is 
 
728
                            <link linkend="boolean">boolean</link>. For edges this
 
729
                            determines whether or not joins between edges segments
 
730
                            are smoothed to a rounded finish. For vertices that
 
731
                            have the rectangle shape, this determines whether or
 
732
                            not the rectangle is rounded.
 
733
                        </para>
 
734
                    </listitem>
 
735
                </varlistentry>
 
736
                <varlistentry>
 
737
                    <term>
 
738
                        <literal>"sourcePerimeterSpacing"</literal>
 
739
                    </term>
 
740
                    <listitem>
 
741
                        <para>Defines the key for the source perimeter spacing.
 
742
                            The type of this value is double. This is the distance
 
743
                            between the source connection point of an edge and the
 
744
                            perimeter of the source vertex in pixels. This style
 
745
                            only applies to edges.
 
746
                        </para>
 
747
                    </listitem>
 
748
                </varlistentry>
 
749
                <varlistentry>
 
750
                    <term>
 
751
                        <literal>"targetPerimeterSpacing"</literal>
 
752
                    </term>
 
753
                    <listitem>
 
754
                        <para>Defines the key for the target perimeter spacing.
 
755
                            The type of this value is double. This is the distance
 
756
                            between the target connection point of an edge and the
 
757
                            perimeter of the target vertex in pixels. This style
 
758
                            only applies to edges.
 
759
                        </para>
 
760
                    </listitem>
 
761
                </varlistentry>
 
762
                <varlistentry>
 
763
                    <term>
 
764
                        <literal>"perimeterSpacing"</literal>
 
765
                    </term>
 
766
                    <listitem>
 
767
                        <para>Defines the key for the perimeter spacing. This
 
768
                            is the distance between the connection point and the
 
769
                            perimeter in pixels. When used in a vertex style, this
 
770
                            applies to all incoming edges to floating ports (edges
 
771
                            that terminate on the perimeter of the vertex). When
 
772
                            used in an edge style, this spacing applies to the
 
773
                            source and target separately, if they terminate in
 
774
                            floating ports (on the perimeter of the vertex).
 
775
                        </para>
 
776
                    </listitem>
 
777
                </varlistentry>
 
778
                <varlistentry>
 
779
                    <term>
 
780
                        <literal>"spacing"</literal>
 
781
                    </term>
 
782
                    <listitem>
 
783
                        <para>Defines the key for the spacing. The value
 
784
                            represents the spacing, in pixels, added to each side
 
785
                            of a label in a vertex (style applies to vertices
 
786
                            only).
 
787
                        </para>
 
788
                    </listitem>
 
789
                </varlistentry>
 
790
                <varlistentry>
 
791
                    <term>
 
792
                        <literal>"spacingTop"</literal>
 
793
                    </term>
 
794
                    <listitem>
 
795
                        <para>Defines the key for the spacingTop style. The
 
796
                            value represents the spacing, in pixels, added to the
 
797
                            top side of a label in a vertex (style applies to
 
798
                            vertices only).
 
799
                        </para>
 
800
                    </listitem>
 
801
                </varlistentry>
 
802
                <varlistentry>
 
803
                    <term>
 
804
                        <literal>"spacingLeft"</literal>
 
805
                    </term>
 
806
                    <listitem>
 
807
                        <para>Defines the key for the spacingLeft style. The
 
808
                            value represents the spacing, in pixels, added to the
 
809
                            left side of a label in a vertex (style applies to
 
810
                            vertices only).
 
811
                        </para>
 
812
                    </listitem>
 
813
                </varlistentry>
 
814
                <varlistentry>
 
815
                    <term>
 
816
                        <literal>"spacingBottom"</literal>
 
817
                    </term>
 
818
                    <listitem>
 
819
                        <para>Defines the key for the spacingBottom style The
 
820
                            value represents the spacing, in pixels, added to the
 
821
                            bottom side of a label in a vertex (style applies to
 
822
                            vertices only).
 
823
                        </para>
 
824
                    </listitem>
 
825
                </varlistentry>
 
826
                <varlistentry>
 
827
                    <term>
 
828
                        <literal>"spacingRight"</literal>
 
829
                    </term>
 
830
                    <listitem>
 
831
                        <para>Defines the key for the spacingRight style The
 
832
                            value represents the spacing, in pixels, added to the
 
833
                            right side of a label in a vertex (style applies to
 
834
                            vertices only).
 
835
                        </para>
 
836
                    </listitem>
 
837
                </varlistentry>
 
838
                <varlistentry>
 
839
                    <term>
 
840
                        <literal>"horizontal"</literal>
 
841
                    </term>
 
842
                    <listitem>
 
843
                        <para>Defines the key for the horizontal style. The
 
844
                            type of this value is 
 
845
                            <link linkend="boolean">boolean</link>. This value only
 
846
                            applies to vertices. If the 
 
847
                            <literal>"shape"</literal>is 
 
848
                            <literal>"swimlane"</literal>a value of 
 
849
                            <literal>false</literal>indicates that the swimlane
 
850
                            should be drawn vertically, 
 
851
                            <literal>true</literal>indicates to draw it
 
852
                            horizontally. If the shape style does not indicate that
 
853
                            this vertex is a swimlane, this value affects only
 
854
                            whether the label is drawn horizontally or
 
855
                            vertically.
 
856
                        </para>
 
857
                    </listitem>
 
858
                </varlistentry>
 
859
                <varlistentry>
 
860
                    <term>
 
861
                        <literal>"direction"</literal>
 
862
                    </term>
 
863
                    <listitem>
 
864
                        <para>Defines the key for the direction style. The
 
865
                            direction style is used to specify the direction of
 
866
                            certain shapes. Possible values are described on the 
 
867
                            <link linkend="jgraphx-style-direction-list">direction
 
868
                                list
 
869
                            </link>
 
870
                            .This value only applies to
 
871
                            vertices.
 
872
                        </para>
 
873
                    </listitem>
 
874
                </varlistentry>
 
875
                <varlistentry>
 
876
                    <term>
 
877
                        <literal>"elbow"</literal>
 
878
                    </term>
 
879
                    <listitem>
 
880
                        <para>Defines the key for the elbow style. Possible
 
881
                            values are 
 
882
                            <literal>"horizontal"</literal>and 
 
883
                            <literal>"vertical"</literal>. Default is 
 
884
                            <literal>"horizontal"</literal>. This defines how the
 
885
                            three segment orthogonal edge style leaves its terminal
 
886
                            vertices. The vertical style leaves the terminal
 
887
                            vertices at the top and bottom sides.
 
888
                        </para>
 
889
                    </listitem>
 
890
                </varlistentry>
 
891
                <varlistentry>
 
892
                    <term>
 
893
                        <literal>"fontColor"</literal>
 
894
                    </term>
 
895
                    <listitem>
 
896
                        <para>Defines the key for the fontColor style. The
 
897
                            value is type String and of the expression described
 
898
                            below.
 
899
                        </para>
 
900
                    </listitem>
 
901
                </varlistentry>
 
902
                <varlistentry>
 
903
                    <term>
 
904
                        <literal>"fontFamily"</literal>
 
905
                    </term>
 
906
                    <listitem>
 
907
                        <para>Defines the key for the fontFamily style.
 
908
                            Possible values are names such as 
 
909
                            <literal>Arial</literal>; 
 
910
                            <literal>Dialog</literal>; 
 
911
                            <literal>Verdana</literal>; 
 
912
                            <literal>Times New Roman</literal>. The value is of
 
913
                            type String.
 
914
                        </para>
 
915
                    </listitem>
 
916
                </varlistentry>
 
917
                <varlistentry>
 
918
                    <term>
 
919
                        <literal>"fontSize"</literal>
 
920
                    </term>
 
921
                    <listitem>
 
922
                        <para>Defines the key for the fontSize style (in
 
923
                            points). The type of the value is int.
 
924
                        </para>
 
925
                    </listitem>
 
926
                </varlistentry>
 
927
                <varlistentry>
 
928
                    <term>
 
929
                        <literal>"fontStyle"</literal>
 
930
                    </term>
 
931
                    <listitem>
 
932
                        <para>Defines the key for the fontStyle style. Values
 
933
                            may be any logical AND (sum) of values on the 
 
934
                            <link linkend="jgraphx-style-font-table">font style
 
935
                                table
 
936
                            </link>
 
937
                            .The type of the value is int.
 
938
                        </para>
 
939
                    </listitem>
 
940
                </varlistentry>
 
941
                <varlistentry>
 
942
                    <term>
 
943
                        <literal>"shape"</literal>
 
944
                    </term>
 
945
                    <listitem>
 
946
                        <para>Defines the key for the shape style. Possible
 
947
                            values are any of 
 
948
                            <link linkend="jgraphx-style-shape-list">shape
 
949
                                list
 
950
                            </link>
 
951
                            .
 
952
                        </para>
 
953
                    </listitem>
 
954
                </varlistentry>
 
955
                <varlistentry>
 
956
                    <term>
 
957
                        <literal>"routingCenterX"</literal>
 
958
                    </term>
 
959
                    <listitem>
 
960
                        <para>Defines the key for the horizontal routing
 
961
                            center. Possible values are between -0.5 and 0.5. This
 
962
                            is the relative offset from the center used for
 
963
                            connecting edges. The type of this value is
 
964
                            float.
 
965
                        </para>
 
966
                    </listitem>
 
967
                </varlistentry>
 
968
                <varlistentry>
 
969
                    <term>
 
970
                        <literal>"routingCenterY"</literal>
 
971
                    </term>
 
972
                    <listitem>
 
973
                        <para>Defines the key for the vertical routing center.
 
974
                            Possible values are between -0.5 and 0.5. This is the
 
975
                            relative offset from the center used for connecting
 
976
                            edges. The type of this value is float;
 
977
                        </para>
 
978
                    </listitem>
 
979
                </varlistentry>
 
980
            </variablelist>
 
981
        </para>
 
982
        <para>
 
983
            <itemizedlist xml:id="jgraphx-style-align-list">
 
984
                <title>JGraphx alignment values</title>
 
985
                <listitem>
 
986
                    <para>
 
987
                        <literal>"left"</literal>- horizontal alignment
 
988
                    </para>
 
989
                </listitem>
 
990
                <listitem>
 
991
                    <para>
 
992
                        <literal>"center"</literal>- horizontal alignment
 
993
                    </para>
 
994
                </listitem>
 
995
                <listitem>
 
996
                    <para>
 
997
                        <literal>"right"</literal>- horizontal alignment
 
998
                    </para>
 
999
                </listitem>
 
1000
                <listitem>
 
1001
                    <para>
 
1002
                        <literal>"top"</literal>- vertical alignment
 
1003
                    </para>
 
1004
                </listitem>
 
1005
                <listitem>
 
1006
                    <para>
 
1007
                        <literal>"middle"</literal>- vertical alignment
 
1008
                    </para>
 
1009
                </listitem>
 
1010
                <listitem>
 
1011
                    <para>
 
1012
                        <literal>"bottom"</literal>- vertical alignment
 
1013
                    </para>
 
1014
                </listitem>
 
1015
            </itemizedlist>
 
1016
            <itemizedlist xml:id="jgraphx-style-arrow-list">
 
1017
                <title>JGraphx arrow values</title>
 
1018
                <listitem>
 
1019
                    <para>
 
1020
                        <literal>"classic"</literal>
 
1021
                    </para>
 
1022
                </listitem>
 
1023
                <listitem>
 
1024
                    <para>
 
1025
                        <literal>"block"</literal>
 
1026
                    </para>
 
1027
                </listitem>
 
1028
                <listitem>
 
1029
                    <para>
 
1030
                        <literal>"oval"</literal>
 
1031
                    </para>
 
1032
                </listitem>
 
1033
                <listitem>
 
1034
                    <para>
 
1035
                        <literal>"diamond"</literal>
 
1036
                    </para>
 
1037
                </listitem>
 
1038
            </itemizedlist>
 
1039
            <itemizedlist xml:id="jgraphx-style-shape-list">
 
1040
                <title>JGraphx shape values</title>
 
1041
                <listitem>
 
1042
                    <para>
 
1043
                        <literal>"rectangle"</literal>
 
1044
                    </para>
 
1045
                </listitem>
 
1046
                <listitem>
 
1047
                    <para>
 
1048
                        <literal>"ellipse"</literal>
 
1049
                    </para>
 
1050
                </listitem>
 
1051
                <listitem>
 
1052
                    <para>
 
1053
                        <literal>"doubleEllipse"</literal>
 
1054
                    </para>
 
1055
                </listitem>
 
1056
                <listitem>
 
1057
                    <para>
 
1058
                        <literal>"rhombus"</literal>
 
1059
                    </para>
 
1060
                </listitem>
 
1061
                <listitem>
 
1062
                    <para>
 
1063
                        <literal>"line"</literal>
 
1064
                    </para>
 
1065
                </listitem>
 
1066
                <listitem>
 
1067
                    <para>
 
1068
                        <literal>"image"</literal>
 
1069
                    </para>
 
1070
                </listitem>
 
1071
                <listitem>
 
1072
                    <para>
 
1073
                        <literal>"arrow"</literal>
 
1074
                    </para>
 
1075
                </listitem>
 
1076
                <listitem>
 
1077
                    <para>
 
1078
                        <literal>"curve"</literal>
 
1079
                    </para>
 
1080
                </listitem>
 
1081
                <listitem>
 
1082
                    <para>
 
1083
                        <literal>"label"</literal>
 
1084
                    </para>
 
1085
                </listitem>
 
1086
                <listitem>
 
1087
                    <para>
 
1088
                        <literal>"cylinder"</literal>
 
1089
                    </para>
 
1090
                </listitem>
 
1091
                <listitem>
 
1092
                    <para>
 
1093
                        <literal>"swimlane"</literal>
 
1094
                    </para>
 
1095
                </listitem>
 
1096
                <listitem>
 
1097
                    <para>
 
1098
                        <literal>"connector"</literal>
 
1099
                    </para>
 
1100
                </listitem>
 
1101
                <listitem>
 
1102
                    <para>
 
1103
                        <literal>"actor"</literal>
 
1104
                    </para>
 
1105
                </listitem>
 
1106
                <listitem>
 
1107
                    <para>
 
1108
                        <literal>"cloud"</literal>
 
1109
                    </para>
 
1110
                </listitem>
 
1111
                <listitem>
 
1112
                    <para>
 
1113
                        <literal>"triangle"</literal>
 
1114
                    </para>
 
1115
                </listitem>
 
1116
                <listitem>
 
1117
                    <para>
 
1118
                        <literal>"hexagon"</literal>
 
1119
                    </para>
 
1120
                </listitem>
 
1121
            </itemizedlist>
 
1122
            <itemizedlist xml:id="jgraphx-style-color-list">
 
1123
                <title>JGraphx valid color values</title>
 
1124
                <listitem>
 
1125
                    <para>Web notation colors - 
 
1126
                        <literal>"#E1E1E1"</literal>for example
 
1127
                    </para>
 
1128
                </listitem>
 
1129
                <listitem>
 
1130
                    <para>Java parseable colors - int values as RGB or sRGB
 
1131
                        colors
 
1132
                    </para>
 
1133
                </listitem>
 
1134
                <listitem>
 
1135
                    <para>
 
1136
                        <literal>"white"</literal>
 
1137
                    </para>
 
1138
                </listitem>
 
1139
                <listitem>
 
1140
                    <para>
 
1141
                        <literal>"black"</literal>
 
1142
                    </para>
 
1143
                </listitem>
 
1144
                <listitem>
 
1145
                    <para>
 
1146
                        <literal>"red"</literal>
 
1147
                    </para>
 
1148
                </listitem>
 
1149
                <listitem>
 
1150
                    <para>
 
1151
                        <literal>"green"</literal>
 
1152
                    </para>
 
1153
                </listitem>
 
1154
                <listitem>
 
1155
                    <para>
 
1156
                        <literal>"blue"</literal>
 
1157
                    </para>
 
1158
                </listitem>
 
1159
                <listitem>
 
1160
                    <para>
 
1161
                        <literal>"orange"</literal>
 
1162
                    </para>
 
1163
                </listitem>
 
1164
                <listitem>
 
1165
                    <para>
 
1166
                        <literal>"yellow"</literal>
 
1167
                    </para>
 
1168
                </listitem>
 
1169
                <listitem>
 
1170
                    <para>
 
1171
                        <literal>"pink"</literal>
 
1172
                    </para>
 
1173
                </listitem>
 
1174
                <listitem>
 
1175
                    <para>
 
1176
                        <literal>"turquoise"</literal>
 
1177
                    </para>
 
1178
                </listitem>
 
1179
                <listitem>
 
1180
                    <para>
 
1181
                        <literal>"gray"</literal>
 
1182
                    </para>
 
1183
                </listitem>
 
1184
            </itemizedlist>
 
1185
            <itemizedlist xml:id="jgraphx-style-direction-list">
 
1186
                <title>JGraphx direction values</title>
 
1187
                <listitem>
 
1188
                    <para>
 
1189
                        <literal>"north"</literal>
 
1190
                    </para>
 
1191
                </listitem>
 
1192
                <listitem>
 
1193
                    <para>
 
1194
                        <literal>"south"</literal>
 
1195
                    </para>
 
1196
                </listitem>
 
1197
                <listitem>
 
1198
                    <para>
 
1199
                        <literal>"east"</literal>
 
1200
                    </para>
 
1201
                </listitem>
 
1202
                <listitem>
 
1203
                    <para>
 
1204
                        <literal>"west"</literal>
 
1205
                    </para>
 
1206
                </listitem>
 
1207
            </itemizedlist>
 
1208
            <itemizedlist xml:id="jgraphx-style-font-table">
 
1209
                <title>JGraphx font modifier values</title>
 
1210
                <listitem>
 
1211
                    <para>bold - 
 
1212
                        <literal>1</literal>
 
1213
                    </para>
 
1214
                </listitem>
 
1215
                <listitem>
 
1216
                    <para>italic - 
 
1217
                        <literal>2</literal>
 
1218
                    </para>
 
1219
                </listitem>
 
1220
                <listitem>
 
1221
                    <para>underline - 
 
1222
                        <literal>4</literal>
 
1223
                    </para>
 
1224
                </listitem>
 
1225
                <listitem>
 
1226
                    <para>shadow - 
 
1227
                        <literal>8</literal>
 
1228
                    </para>
 
1229
                </listitem>
 
1230
            </itemizedlist>
 
1231
        </para>
 
1232
        <para/>
 
1233
    </refsection>
 
1234
    <refsection>
 
1235
        <title>Examples</title>
 
1236
        <para>
 
1237
            <programlisting role="example"><![CDATA[
1238
1238
loadXcosLibs();
1239
1239
pal = xcosPal();
1240
1240
 
1245
1245
pal = xcosPalAddBlock(pal, o2);
1246
1246
 
1247
1247
xcosPalAdd(pal);]]></programlisting>
1248
 
    </para>
1249
 
    <para>
1250
 
      <programlisting role="example"><![CDATA[
 
1248
        </para>
 
1249
        <para>
 
1250
            <programlisting role="example"><![CDATA[
1251
1251
loadXcosLibs;
1252
1252
//Create a simple custom block.
1253
1253
function [x,y,typ]=MyBlock(job,arg1,arg2)
1278
1278
 
1279
1279
//deploy palette
1280
1280
xcosPalAdd(pal);]]></programlisting>
1281
 
    </para>
1282
 
    <para>
1283
 
      <programlisting role="example"><![CDATA[
 
1281
        </para>
 
1282
        <para>
 
1283
            <programlisting role="example"><![CDATA[
1284
1284
loadXcosLibs;
1285
1285
//Create a simple custom block.
1286
1286
function [x,y,typ]=MyBlock(job,arg1,arg2)
1322
1322
 
1323
1323
//deploy palette
1324
1324
xcosPalAdd(pal);]]></programlisting>
1325
 
    </para>
1326
 
  </refsection>
1327
 
  <refsection role="see also">
1328
 
    <title>See Also</title>
1329
 
    <simplelist type="inline">
1330
 
      <member>
1331
 
        <link linkend="xcosPal">xcosPal</link>
1332
 
      </member>
1333
 
      <member>
1334
 
        <link linkend="xcosPalAdd">xcosPalAdd</link>
1335
 
      </member>
1336
 
    </simplelist>
1337
 
  </refsection>
 
1325
        </para>
 
1326
    </refsection>
 
1327
    <refsection role="see also">
 
1328
        <title>See Also</title>
 
1329
        <simplelist type="inline">
 
1330
            <member>
 
1331
                <link linkend="xcosPal">xcosPal</link>
 
1332
            </member>
 
1333
            <member>
 
1334
                <link linkend="xcosPalAdd">xcosPalAdd</link>
 
1335
            </member>
 
1336
        </simplelist>
 
1337
    </refsection>
1338
1338
</refentry>