axlsx 1.0.10 → 1.0.11
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.md +14 -0
- data/Gemfile +3 -7
- data/Gemfile.lock +17 -8
- data/README.md +88 -59
- data/axlsx.gemspec +9 -3
- data/doc/Axlsx.html +482 -248
- data/doc/Axlsx/App.html +237 -159
- data/doc/Axlsx/Axis.html +75 -51
- data/doc/Axlsx/Bar3DChart.html +75 -53
- data/doc/Axlsx/BarSeries.html +45 -31
- data/doc/Axlsx/Border.html +70 -50
- data/doc/Axlsx/BorderPr.html +80 -62
- data/doc/Axlsx/CatAxis.html +62 -43
- data/doc/Axlsx/CatAxisData.html +23 -16
- data/doc/Axlsx/Cell.html +2022 -393
- data/doc/Axlsx/CellAlignment.html +103 -75
- data/doc/Axlsx/CellProtection.html +44 -30
- data/doc/Axlsx/CellStyle.html +66 -46
- data/doc/Axlsx/Chart.html +159 -108
- data/doc/Axlsx/Color.html +73 -52
- data/doc/Axlsx/ContentType.html +20 -14
- data/doc/Axlsx/Core.html +29 -20
- data/doc/Axlsx/DataTypeValidator.html +27 -19
- data/doc/Axlsx/Default.html +39 -27
- data/doc/Axlsx/Drawing.html +104 -70
- data/doc/Axlsx/Fill.html +33 -23
- data/doc/Axlsx/Font.html +132 -98
- data/doc/Axlsx/GradientFill.html +70 -48
- data/doc/Axlsx/GradientStop.html +31 -21
- data/doc/Axlsx/GraphicFrame.html +40 -27
- data/doc/Axlsx/Line3DChart.html +62 -43
- data/doc/Axlsx/LineSeries.html +37 -25
- data/doc/Axlsx/Marker.html +63 -43
- data/doc/Axlsx/NumFmt.html +79 -65
- data/doc/Axlsx/OneCellAnchor.html +78 -54
- data/doc/Axlsx/Override.html +39 -27
- data/doc/Axlsx/Package.html +103 -163
- data/doc/Axlsx/Parser.html +549 -0
- data/doc/Axlsx/PatternFill.html +66 -51
- data/doc/Axlsx/Pic.html +230 -123
- data/doc/Axlsx/PictureLocking.html +1159 -0
- data/doc/Axlsx/Pie3DChart.html +23 -16
- data/doc/Axlsx/PieSeries.html +44 -30
- data/doc/Axlsx/RegexValidator.html +14 -10
- data/doc/Axlsx/Relationship.html +40 -27
- data/doc/Axlsx/Relationships.html +20 -14
- data/doc/Axlsx/RestrictionValidator.html +25 -17
- data/doc/Axlsx/Row.html +73 -53
- data/doc/Axlsx/Scaling.html +46 -31
- data/doc/Axlsx/SerAxis.html +49 -33
- data/doc/Axlsx/Series.html +51 -35
- data/doc/Axlsx/SeriesTitle.html +14 -10
- data/doc/Axlsx/Styles.html +210 -156
- data/doc/Axlsx/TableStyle.html +47 -32
- data/doc/Axlsx/TableStyleElement.html +75 -61
- data/doc/Axlsx/TableStyles.html +42 -28
- data/doc/Axlsx/Title.html +36 -25
- data/doc/Axlsx/TwoCellAnchor.html +83 -58
- data/doc/Axlsx/ValAxis.html +35 -24
- data/doc/Axlsx/ValAxisData.html +13 -9
- data/doc/Axlsx/View3D.html +64 -43
- data/doc/Axlsx/Workbook.html +305 -147
- data/doc/Axlsx/Worksheet.html +567 -271
- data/doc/Axlsx/Xf.html +114 -77
- data/doc/_index.html +15 -1
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +1 -1
- data/doc/file.LICENSE.html +25 -21
- data/doc/file.README.html +89 -66
- data/doc/index.html +89 -66
- data/doc/js/app.js +4 -4
- data/doc/method_list.html +717 -413
- data/doc/top-level-namespace.html +1 -1
- data/examples/example.rb +52 -25
- data/examples/follow_20111202.xlsx +0 -0
- data/lib/axlsx.rb +14 -1
- data/lib/axlsx/drawing/chart.rb +20 -4
- data/lib/axlsx/drawing/drawing.rb +1 -1
- data/lib/axlsx/drawing/pic.rb +5 -2
- data/lib/axlsx/drawing/picture_locking.rb +72 -0
- data/lib/axlsx/package.rb +9 -7
- data/lib/axlsx/stylesheet/color.rb +19 -9
- data/lib/axlsx/stylesheet/styles.rb +2 -0
- data/lib/axlsx/util/constants.rb +6 -0
- data/lib/axlsx/util/parser.rb +43 -0
- data/lib/axlsx/version.rb +1 -1
- data/lib/axlsx/workbook/workbook.rb +21 -1
- data/lib/axlsx/workbook/worksheet/cell.rb +159 -7
- data/lib/axlsx/workbook/worksheet/row.rb +4 -2
- data/lib/axlsx/workbook/worksheet/worksheet.rb +38 -4
- data/test/drawing/tc_picture_locking.rb +73 -0
- data/test/rels/tc_relationships.rb +0 -1
- data/test/stylesheet/tc_styles.rb +0 -12
- data/test/tc_package.rb +5 -3
- data/test/workbook/tc_workbook.rb +7 -0
- data/test/workbook/worksheet/tc_cell.rb +102 -1
- data/test/workbook/worksheet/tc_worksheet.rb +17 -0
- metadata +79 -19
- data/doc/Axlsx/Ar.html +0 -196
- data/doc/Axlsx/Ar/ClassMethods.html +0 -188
- data/doc/Axlsx/Ar/InstanceMethods.html +0 -108
- data/doc/Axlsx/Ar/SingletonMethods.html +0 -312
data/doc/Axlsx/PatternFill.html
CHANGED
@@ -97,13 +97,15 @@
|
|
97
97
|
|
98
98
|
<div class="note notetag">
|
99
99
|
<strong>Note:</strong>
|
100
|
-
<div class='inline'>
|
101
|
-
|
100
|
+
<div class='inline'><p>
|
101
|
+
The recommended way to manage styles is with Styles#add_style
|
102
|
+
</p>
|
102
103
|
</div>
|
103
104
|
</div>
|
104
105
|
|
105
|
-
|
106
|
-
|
106
|
+
<p>
|
107
|
+
A PatternFill is the pattern and solid fill styling for a cell.
|
108
|
+
</p>
|
107
109
|
|
108
110
|
|
109
111
|
</div>
|
@@ -142,8 +144,9 @@
|
|
142
144
|
|
143
145
|
|
144
146
|
|
145
|
-
<span class="summary_desc"><div class='inline'>
|
146
|
-
|
147
|
+
<span class="summary_desc"><div class='inline'><p>
|
148
|
+
The color to use for the background of the fill when the type is not solid.
|
149
|
+
</p>
|
147
150
|
</div></span>
|
148
151
|
|
149
152
|
</li>
|
@@ -168,8 +171,9 @@
|
|
168
171
|
|
169
172
|
|
170
173
|
|
171
|
-
<span class="summary_desc"><div class='inline'>
|
172
|
-
|
174
|
+
<span class="summary_desc"><div class='inline'><p>
|
175
|
+
The color to use for the the background in solid fills.
|
176
|
+
</p>
|
173
177
|
</div></span>
|
174
178
|
|
175
179
|
</li>
|
@@ -194,8 +198,9 @@
|
|
194
198
|
|
195
199
|
|
196
200
|
|
197
|
-
<span class="summary_desc"><div class='inline'>
|
198
|
-
|
201
|
+
<span class="summary_desc"><div class='inline'><p>
|
202
|
+
The pattern type to use.
|
203
|
+
</p>
|
199
204
|
</div></span>
|
200
205
|
|
201
206
|
</li>
|
@@ -232,8 +237,9 @@
|
|
232
237
|
|
233
238
|
|
234
239
|
|
235
|
-
<span class="summary_desc"><div class='inline'>
|
236
|
-
|
240
|
+
<span class="summary_desc"><div class='inline'><p>
|
241
|
+
Creates a new PatternFill Object.
|
242
|
+
</p>
|
237
243
|
</div></span>
|
238
244
|
|
239
245
|
</li>
|
@@ -255,8 +261,9 @@
|
|
255
261
|
|
256
262
|
|
257
263
|
|
258
|
-
<span class="summary_desc"><div class='inline'>
|
259
|
-
|
264
|
+
<span class="summary_desc"><div class='inline'><p>
|
265
|
+
Serializes the pattern fill.
|
266
|
+
</p>
|
260
267
|
</div></span>
|
261
268
|
|
262
269
|
</li>
|
@@ -277,8 +284,9 @@
|
|
277
284
|
|
278
285
|
</p><div class="docstring">
|
279
286
|
<div class="discussion">
|
280
|
-
|
281
|
-
|
287
|
+
<p>
|
288
|
+
Creates a new PatternFill Object
|
289
|
+
</p>
|
282
290
|
|
283
291
|
|
284
292
|
</div>
|
@@ -299,8 +307,9 @@
|
|
299
307
|
|
300
308
|
|
301
309
|
—
|
302
|
-
<div class='inline'>
|
303
|
-
|
310
|
+
<div class='inline'><p>
|
311
|
+
a customizable set of options
|
312
|
+
</p>
|
304
313
|
</div>
|
305
314
|
|
306
315
|
</li>
|
@@ -389,8 +398,9 @@
|
|
389
398
|
|
390
399
|
</p><div class="docstring">
|
391
400
|
<div class="discussion">
|
392
|
-
|
393
|
-
|
401
|
+
<p>
|
402
|
+
The color to use for the background of the fill when the type is not solid.
|
403
|
+
</p>
|
394
404
|
|
395
405
|
|
396
406
|
</div>
|
@@ -445,8 +455,9 @@
|
|
445
455
|
|
446
456
|
</p><div class="docstring">
|
447
457
|
<div class="discussion">
|
448
|
-
|
449
|
-
|
458
|
+
<p>
|
459
|
+
The color to use for the the background in solid fills.
|
460
|
+
</p>
|
450
461
|
|
451
462
|
|
452
463
|
</div>
|
@@ -504,34 +515,36 @@
|
|
504
515
|
|
505
516
|
<div class="note notetag">
|
506
517
|
<strong>Note:</strong>
|
507
|
-
<div class='inline'>
|
508
|
-
|
509
|
-
|
510
|
-
<pre class="code"
|
511
|
-
<span class='symbol val'>:
|
512
|
-
<span class='symbol val'>:
|
513
|
-
<span class='symbol val'>:
|
514
|
-
<span class='symbol val'>:
|
515
|
-
<span class='symbol val'>:
|
516
|
-
<span class='symbol val'>:
|
517
|
-
<span class='symbol val'>:
|
518
|
-
<span class='symbol val'>:
|
519
|
-
<span class='symbol val'>:
|
520
|
-
<span class='symbol val'>:
|
521
|
-
<span class='symbol val'>:
|
522
|
-
<span class='symbol val'>:
|
523
|
-
<span class='symbol val'>:
|
524
|
-
<span class='symbol val'>:
|
525
|
-
<span class='symbol val'>:
|
526
|
-
<span class='symbol val'>:
|
527
|
-
<span class='symbol val'>:
|
528
|
-
<span class='symbol val'>:
|
518
|
+
<div class='inline'><p>
|
519
|
+
patternType must be one of
|
520
|
+
</p>
|
521
|
+
<pre class="code">
|
522
|
+
<span class='symbol val'>:none</span>
|
523
|
+
<span class='symbol val'>:solid</span>
|
524
|
+
<span class='symbol val'>:mediumGray</span>
|
525
|
+
<span class='symbol val'>:darkGray</span>
|
526
|
+
<span class='symbol val'>:lightGray</span>
|
527
|
+
<span class='symbol val'>:darkHorizontal</span>
|
528
|
+
<span class='symbol val'>:darkVertical</span>
|
529
|
+
<span class='symbol val'>:darkDown</span>
|
530
|
+
<span class='symbol val'>:darkUp</span>
|
531
|
+
<span class='symbol val'>:darkGrid</span>
|
532
|
+
<span class='symbol val'>:darkTrellis</span>
|
533
|
+
<span class='symbol val'>:lightHorizontal</span>
|
534
|
+
<span class='symbol val'>:lightVertical</span>
|
535
|
+
<span class='symbol val'>:lightDown</span>
|
536
|
+
<span class='symbol val'>:lightUp</span>
|
537
|
+
<span class='symbol val'>:lightGrid</span>
|
538
|
+
<span class='symbol val'>:lightTrellis</span>
|
539
|
+
<span class='symbol val'>:gray125</span>
|
540
|
+
<span class='symbol val'>:gray0625</span>
|
529
541
|
</pre>
|
530
542
|
</div>
|
531
543
|
</div>
|
532
544
|
|
533
|
-
|
534
|
-
|
545
|
+
<p>
|
546
|
+
The pattern type to use
|
547
|
+
</p>
|
535
548
|
|
536
549
|
|
537
550
|
</div>
|
@@ -584,8 +597,9 @@
|
|
584
597
|
|
585
598
|
</p><div class="docstring">
|
586
599
|
<div class="discussion">
|
587
|
-
|
588
|
-
|
600
|
+
<p>
|
601
|
+
Serializes the pattern fill
|
602
|
+
</p>
|
589
603
|
|
590
604
|
|
591
605
|
</div>
|
@@ -604,8 +618,9 @@
|
|
604
618
|
|
605
619
|
|
606
620
|
—
|
607
|
-
<div class='inline'>
|
608
|
-
|
621
|
+
<div class='inline'><p>
|
622
|
+
The document builder instance this objects xml will be added to.
|
623
|
+
</p>
|
609
624
|
</div>
|
610
625
|
|
611
626
|
</li>
|
@@ -657,7 +672,7 @@
|
|
657
672
|
</div>
|
658
673
|
|
659
674
|
<div id="footer">
|
660
|
-
Generated on
|
675
|
+
Generated on Mon Dec 5 14:21:12 2011 by
|
661
676
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
662
677
|
0.7.3 (ruby-1.8.7).
|
663
678
|
</div>
|
data/doc/Axlsx/Pic.html
CHANGED
@@ -94,9 +94,10 @@
|
|
94
94
|
|
95
95
|
<h2>Overview</h2><div class="docstring">
|
96
96
|
<div class="discussion">
|
97
|
-
|
98
|
-
|
99
|
-
the recommended way to manage images in your sheets
|
97
|
+
<p>
|
98
|
+
a Pic object represents an image in your worksheet Worksheet#add_image is
|
99
|
+
the recommended way to manage images in your sheets
|
100
|
+
</p>
|
100
101
|
|
101
102
|
|
102
103
|
</div>
|
@@ -119,8 +120,9 @@ the recommended way to manage images in your sheets</p>
|
|
119
120
|
<dt id="ALLOWED_EXTENSIONS-constant" class="">ALLOWED_EXTENSIONS =
|
120
121
|
<div class="docstring">
|
121
122
|
<div class="discussion">
|
122
|
-
|
123
|
-
|
123
|
+
<p>
|
124
|
+
allowed file extenstions
|
125
|
+
</p>
|
124
126
|
|
125
127
|
|
126
128
|
</div>
|
@@ -159,8 +161,9 @@ the recommended way to manage images in your sheets</p>
|
|
159
161
|
|
160
162
|
|
161
163
|
|
162
|
-
<span class="summary_desc"><div class='inline'>
|
163
|
-
|
164
|
+
<span class="summary_desc"><div class='inline'><p>
|
165
|
+
The anchor for this image.
|
166
|
+
</p>
|
164
167
|
</div></span>
|
165
168
|
|
166
169
|
</li>
|
@@ -185,8 +188,9 @@ the recommended way to manage images in your sheets</p>
|
|
185
188
|
|
186
189
|
|
187
190
|
|
188
|
-
<span class="summary_desc"><div class='inline'>
|
189
|
-
|
191
|
+
<span class="summary_desc"><div class='inline'><p>
|
192
|
+
A description of the picture.
|
193
|
+
</p>
|
190
194
|
</div></span>
|
191
195
|
|
192
196
|
</li>
|
@@ -211,9 +215,10 @@ the recommended way to manage images in your sheets</p>
|
|
211
215
|
|
212
216
|
|
213
217
|
|
214
|
-
<span class="summary_desc"><div class='inline'>
|
215
|
-
|
216
|
-
at this time and only jpg support
|
218
|
+
<span class="summary_desc"><div class='inline'><p>
|
219
|
+
The path to the image you want to include Only local images are supported
|
220
|
+
at this time and only jpg support.
|
221
|
+
</p>
|
217
222
|
</div></span>
|
218
223
|
|
219
224
|
</li>
|
@@ -238,8 +243,36 @@ at this time and only jpg support.</p>
|
|
238
243
|
|
239
244
|
|
240
245
|
|
241
|
-
<span class="summary_desc"><div class='inline'>
|
242
|
-
|
246
|
+
<span class="summary_desc"><div class='inline'><p>
|
247
|
+
The name to use for this picture.
|
248
|
+
</p>
|
249
|
+
</div></span>
|
250
|
+
|
251
|
+
</li>
|
252
|
+
|
253
|
+
|
254
|
+
<li class="public ">
|
255
|
+
<span class="summary_signature">
|
256
|
+
|
257
|
+
<a href="#picture_locking-instance_method" title="#picture_locking (instance method)">- (Object) <strong>picture_locking</strong> </a>
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
</span>
|
262
|
+
|
263
|
+
|
264
|
+
<span class="note title readonly">readonly</span>
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
<span class="summary_desc"><div class='inline'><p>
|
274
|
+
The picture locking attributes for this picture.
|
275
|
+
</p>
|
243
276
|
</div></span>
|
244
277
|
|
245
278
|
</li>
|
@@ -274,8 +307,9 @@ at this time and only jpg support.</p>
|
|
274
307
|
|
275
308
|
|
276
309
|
|
277
|
-
<span class="summary_desc"><div class='inline'>
|
278
|
-
|
310
|
+
<span class="summary_desc"><div class='inline'><p>
|
311
|
+
returns the extension of image_src without the preceeding ’.’.
|
312
|
+
</p>
|
279
313
|
</div></span>
|
280
314
|
|
281
315
|
</li>
|
@@ -297,8 +331,9 @@ at this time and only jpg support.</p>
|
|
297
331
|
|
298
332
|
|
299
333
|
|
300
|
-
<span class="summary_desc"><div class='inline'>
|
301
|
-
|
334
|
+
<span class="summary_desc"><div class='inline'><p>
|
335
|
+
The file name of image_src without any path information.
|
336
|
+
</p>
|
302
337
|
</div></span>
|
303
338
|
|
304
339
|
</li>
|
@@ -320,8 +355,9 @@ at this time and only jpg support.</p>
|
|
320
355
|
|
321
356
|
|
322
357
|
|
323
|
-
<span class="summary_desc"><div class='inline'>
|
324
|
-
|
358
|
+
<span class="summary_desc"><div class='inline'><p>
|
359
|
+
providing access to update the anchor’s height attribute.
|
360
|
+
</p>
|
325
361
|
</div></span>
|
326
362
|
|
327
363
|
</li>
|
@@ -364,8 +400,9 @@ at this time and only jpg support.</p>
|
|
364
400
|
|
365
401
|
|
366
402
|
|
367
|
-
<span class="summary_desc"><div class='inline'>
|
368
|
-
|
403
|
+
<span class="summary_desc"><div class='inline'><p>
|
404
|
+
The index of this image in the workbooks images collections.
|
405
|
+
</p>
|
369
406
|
</div></span>
|
370
407
|
|
371
408
|
</li>
|
@@ -389,8 +426,9 @@ at this time and only jpg support.</p>
|
|
389
426
|
|
390
427
|
|
391
428
|
|
392
|
-
<span class="summary_desc"><div class='inline'>
|
393
|
-
|
429
|
+
<span class="summary_desc"><div class='inline'><p>
|
430
|
+
Creates a new Pic(ture) object.
|
431
|
+
</p>
|
394
432
|
</div></span>
|
395
433
|
|
396
434
|
</li>
|
@@ -412,9 +450,10 @@ at this time and only jpg support.</p>
|
|
412
450
|
|
413
451
|
|
414
452
|
|
415
|
-
<span class="summary_desc"><div class='inline'>
|
416
|
-
|
417
|
-
building
|
453
|
+
<span class="summary_desc"><div class='inline'><p>
|
454
|
+
The part name for this image used in serialization and relationship
|
455
|
+
building.
|
456
|
+
</p>
|
418
457
|
</div></span>
|
419
458
|
|
420
459
|
</li>
|
@@ -436,10 +475,11 @@ building.</p>
|
|
436
475
|
|
437
476
|
|
438
477
|
|
439
|
-
<span class="summary_desc"><div class='inline'>
|
440
|
-
|
478
|
+
<span class="summary_desc"><div class='inline'><p>
|
479
|
+
This is a short cut method to set the start anchor position If you need
|
441
480
|
finer granularity in positioning use graphic_frame.anchor.from.colOff /
|
442
|
-
rowOff
|
481
|
+
rowOff.
|
482
|
+
</p>
|
443
483
|
</div></span>
|
444
484
|
|
445
485
|
</li>
|
@@ -461,8 +501,9 @@ rowOff.</p>
|
|
461
501
|
|
462
502
|
|
463
503
|
|
464
|
-
<span class="summary_desc"><div class='inline'>
|
465
|
-
|
504
|
+
<span class="summary_desc"><div class='inline'><p>
|
505
|
+
Serializes the picture.
|
506
|
+
</p>
|
466
507
|
</div></span>
|
467
508
|
|
468
509
|
</li>
|
@@ -484,8 +525,9 @@ rowOff.</p>
|
|
484
525
|
|
485
526
|
|
486
527
|
|
487
|
-
<span class="summary_desc"><div class='inline'>
|
488
|
-
|
528
|
+
<span class="summary_desc"><div class='inline'><p>
|
529
|
+
providing access to the anchor’s width attribute.
|
530
|
+
</p>
|
489
531
|
</div></span>
|
490
532
|
|
491
533
|
</li>
|
@@ -527,8 +569,9 @@ rowOff.</p>
|
|
527
569
|
|
528
570
|
</p><div class="docstring">
|
529
571
|
<div class="discussion">
|
530
|
-
|
531
|
-
|
572
|
+
<p>
|
573
|
+
Creates a new Pic(ture) object
|
574
|
+
</p>
|
532
575
|
|
533
576
|
|
534
577
|
</div>
|
@@ -547,8 +590,9 @@ rowOff.</p>
|
|
547
590
|
|
548
591
|
|
549
592
|
—
|
550
|
-
<div class='inline'>
|
551
|
-
|
593
|
+
<div class='inline'><p>
|
594
|
+
the anchor that holds this image
|
595
|
+
</p>
|
552
596
|
</div>
|
553
597
|
|
554
598
|
</li>
|
@@ -565,8 +609,9 @@ rowOff.</p>
|
|
565
609
|
|
566
610
|
|
567
611
|
—
|
568
|
-
<div class='inline'>
|
569
|
-
|
612
|
+
<div class='inline'><p>
|
613
|
+
a customizable set of options
|
614
|
+
</p>
|
570
615
|
</div>
|
571
616
|
|
572
617
|
</li>
|
@@ -664,8 +709,9 @@ rowOff.</p>
|
|
664
709
|
|
665
710
|
|
666
711
|
—
|
667
|
-
<div class='inline'>
|
668
|
-
|
712
|
+
<div class='inline'><p>
|
713
|
+
the object that the method was called on
|
714
|
+
</p>
|
669
715
|
</div>
|
670
716
|
|
671
717
|
</li>
|
@@ -678,18 +724,19 @@ rowOff.</p>
|
|
678
724
|
<pre class="lines">
|
679
725
|
|
680
726
|
|
681
|
-
38
|
682
|
-
39
|
683
727
|
40
|
684
728
|
41
|
685
729
|
42
|
686
730
|
43
|
687
731
|
44
|
688
732
|
45
|
689
|
-
46
|
733
|
+
46
|
734
|
+
47
|
735
|
+
48
|
736
|
+
49</pre>
|
690
737
|
</td>
|
691
738
|
<td>
|
692
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
739
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 40</span>
|
693
740
|
|
694
741
|
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='anchor identifier id'>anchor</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
695
742
|
<span class='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span>
|
@@ -699,6 +746,7 @@ rowOff.</p>
|
|
699
746
|
<span class='end end kw'>end</span>
|
700
747
|
<span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span>
|
701
748
|
<span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
|
749
|
+
<span class='@picture_locking ivar id'>@picture_locking</span> <span class='assign token'>=</span> <span class='PictureLocking constant id'>PictureLocking</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
702
750
|
<span class='end end kw'>end</span>
|
703
751
|
</pre>
|
704
752
|
</td>
|
@@ -723,8 +771,9 @@ rowOff.</p>
|
|
723
771
|
|
724
772
|
</p><div class="docstring">
|
725
773
|
<div class="discussion">
|
726
|
-
|
727
|
-
|
774
|
+
<p>
|
775
|
+
The anchor for this image
|
776
|
+
</p>
|
728
777
|
|
729
778
|
|
730
779
|
</div>
|
@@ -779,8 +828,9 @@ rowOff.</p>
|
|
779
828
|
|
780
829
|
</p><div class="docstring">
|
781
830
|
<div class="discussion">
|
782
|
-
|
783
|
-
|
831
|
+
<p>
|
832
|
+
A description of the picture
|
833
|
+
</p>
|
784
834
|
|
785
835
|
|
786
836
|
</div>
|
@@ -835,9 +885,10 @@ rowOff.</p>
|
|
835
885
|
|
836
886
|
</p><div class="docstring">
|
837
887
|
<div class="discussion">
|
838
|
-
|
839
|
-
|
840
|
-
at this time and only jpg support
|
888
|
+
<p>
|
889
|
+
The path to the image you want to include Only local images are supported
|
890
|
+
at this time and only jpg support
|
891
|
+
</p>
|
841
892
|
|
842
893
|
|
843
894
|
</div>
|
@@ -892,8 +943,9 @@ at this time and only jpg support</p>
|
|
892
943
|
|
893
944
|
</p><div class="docstring">
|
894
945
|
<div class="discussion">
|
895
|
-
|
896
|
-
|
946
|
+
<p>
|
947
|
+
The name to use for this picture
|
948
|
+
</p>
|
897
949
|
|
898
950
|
|
899
951
|
</div>
|
@@ -936,6 +988,50 @@ at this time and only jpg support</p>
|
|
936
988
|
</table>
|
937
989
|
</div>
|
938
990
|
|
991
|
+
|
992
|
+
<span id=""></span>
|
993
|
+
<span id="picture_locking-instance_method"></span>
|
994
|
+
<div class="method_details ">
|
995
|
+
<p class="signature " id="picture_locking-instance_method">
|
996
|
+
|
997
|
+
- (<tt>Object</tt>) <strong>picture_locking</strong> <span class="extras">(readonly)</span>
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
</p><div class="docstring">
|
1002
|
+
<div class="discussion">
|
1003
|
+
<p>
|
1004
|
+
The picture locking attributes for this picture
|
1005
|
+
</p>
|
1006
|
+
|
1007
|
+
|
1008
|
+
</div>
|
1009
|
+
</div>
|
1010
|
+
<div class="tags">
|
1011
|
+
|
1012
|
+
|
1013
|
+
</div><table class="source_code">
|
1014
|
+
<tr>
|
1015
|
+
<td>
|
1016
|
+
<pre class="lines">
|
1017
|
+
|
1018
|
+
|
1019
|
+
30
|
1020
|
+
31
|
1021
|
+
32</pre>
|
1022
|
+
</td>
|
1023
|
+
<td>
|
1024
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 30</span>
|
1025
|
+
|
1026
|
+
<span class='def def kw'>def</span> <span class='picture_locking identifier id'>picture_locking</span>
|
1027
|
+
<span class='@picture_locking ivar id'>@picture_locking</span>
|
1028
|
+
<span class='end end kw'>end</span>
|
1029
|
+
</pre>
|
1030
|
+
</td>
|
1031
|
+
</tr>
|
1032
|
+
</table>
|
1033
|
+
</div>
|
1034
|
+
|
939
1035
|
</div>
|
940
1036
|
|
941
1037
|
|
@@ -952,8 +1048,9 @@ at this time and only jpg support</p>
|
|
952
1048
|
|
953
1049
|
</p><div class="docstring">
|
954
1050
|
<div class="discussion">
|
955
|
-
|
956
|
-
|
1051
|
+
<p>
|
1052
|
+
returns the extension of image_src without the preceeding ’.’
|
1053
|
+
</p>
|
957
1054
|
|
958
1055
|
|
959
1056
|
</div>
|
@@ -980,12 +1077,12 @@ at this time and only jpg support</p>
|
|
980
1077
|
<pre class="lines">
|
981
1078
|
|
982
1079
|
|
983
|
-
|
984
|
-
|
985
|
-
|
1080
|
+
73
|
1081
|
+
74
|
1082
|
+
75</pre>
|
986
1083
|
</td>
|
987
1084
|
<td>
|
988
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1085
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 73</span>
|
989
1086
|
|
990
1087
|
<span class='def def kw'>def</span> <span class='extname identifier id'>extname</span>
|
991
1088
|
<span class='File constant id'>File</span><span class='dot token'>.</span><span class='extname identifier id'>extname</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'.'</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
@@ -1005,8 +1102,9 @@ at this time and only jpg support</p>
|
|
1005
1102
|
|
1006
1103
|
</p><div class="docstring">
|
1007
1104
|
<div class="discussion">
|
1008
|
-
|
1009
|
-
|
1105
|
+
<p>
|
1106
|
+
The file name of image_src without any path information
|
1107
|
+
</p>
|
1010
1108
|
|
1011
1109
|
|
1012
1110
|
</div>
|
@@ -1033,12 +1131,12 @@ at this time and only jpg support</p>
|
|
1033
1131
|
<pre class="lines">
|
1034
1132
|
|
1035
1133
|
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1134
|
+
67
|
1135
|
+
68
|
1136
|
+
69</pre>
|
1039
1137
|
</td>
|
1040
1138
|
<td>
|
1041
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1139
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 67</span>
|
1042
1140
|
|
1043
1141
|
<span class='def def kw'>def</span> <span class='file_name identifier id'>file_name</span>
|
1044
1142
|
<span class='File constant id'>File</span><span class='dot token'>.</span><span class='basename identifier id'>basename</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
@@ -1058,8 +1156,9 @@ at this time and only jpg support</p>
|
|
1058
1156
|
|
1059
1157
|
</p><div class="docstring">
|
1060
1158
|
<div class="discussion">
|
1061
|
-
|
1062
|
-
|
1159
|
+
<p>
|
1160
|
+
providing access to update the anchor’s height attribute
|
1161
|
+
</p>
|
1063
1162
|
|
1064
1163
|
|
1065
1164
|
</div>
|
@@ -1095,12 +1194,12 @@ at this time and only jpg support</p>
|
|
1095
1194
|
<pre class="lines">
|
1096
1195
|
|
1097
1196
|
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1197
|
+
104
|
1198
|
+
105
|
1199
|
+
106</pre>
|
1101
1200
|
</td>
|
1102
1201
|
<td>
|
1103
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1202
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 104</span>
|
1104
1203
|
|
1105
1204
|
<span class='def def kw'>def</span> <span class='height identifier id'>height</span>
|
1106
1205
|
<span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span>
|
@@ -1140,12 +1239,12 @@ at this time and only jpg support</p>
|
|
1140
1239
|
<pre class="lines">
|
1141
1240
|
|
1142
1241
|
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1242
|
+
109
|
1243
|
+
110
|
1244
|
+
111</pre>
|
1146
1245
|
</td>
|
1147
1246
|
<td>
|
1148
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1247
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 109</span>
|
1149
1248
|
|
1150
1249
|
<span class='def def kw'>def</span> <span class='height= identifier id'>height=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span>
|
1151
1250
|
<span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span>
|
@@ -1165,8 +1264,9 @@ at this time and only jpg support</p>
|
|
1165
1264
|
|
1166
1265
|
</p><div class="docstring">
|
1167
1266
|
<div class="discussion">
|
1168
|
-
|
1169
|
-
|
1267
|
+
<p>
|
1268
|
+
The index of this image in the workbooks images collections
|
1269
|
+
</p>
|
1170
1270
|
|
1171
1271
|
|
1172
1272
|
</div>
|
@@ -1193,12 +1293,12 @@ at this time and only jpg support</p>
|
|
1193
1293
|
<pre class="lines">
|
1194
1294
|
|
1195
1295
|
|
1196
|
-
|
1197
|
-
|
1198
|
-
|
1296
|
+
79
|
1297
|
+
80
|
1298
|
+
81</pre>
|
1199
1299
|
</td>
|
1200
1300
|
<td>
|
1201
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1301
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 79</span>
|
1202
1302
|
|
1203
1303
|
<span class='def def kw'>def</span> <span class='index identifier id'>index</span>
|
1204
1304
|
<span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span>
|
@@ -1218,9 +1318,10 @@ at this time and only jpg support</p>
|
|
1218
1318
|
|
1219
1319
|
</p><div class="docstring">
|
1220
1320
|
<div class="discussion">
|
1221
|
-
|
1222
|
-
|
1223
|
-
building
|
1321
|
+
<p>
|
1322
|
+
The part name for this image used in serialization and relationship
|
1323
|
+
building
|
1324
|
+
</p>
|
1224
1325
|
|
1225
1326
|
|
1226
1327
|
</div>
|
@@ -1247,12 +1348,12 @@ building</p>
|
|
1247
1348
|
<pre class="lines">
|
1248
1349
|
|
1249
1350
|
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1351
|
+
85
|
1352
|
+
86
|
1353
|
+
87</pre>
|
1253
1354
|
</td>
|
1254
1355
|
<td>
|
1255
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1356
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 85</span>
|
1256
1357
|
|
1257
1358
|
<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span>
|
1258
1359
|
<span class='dstring node'>"#{IMAGE_PN % [(index+1), extname]}"</span>
|
@@ -1272,10 +1373,11 @@ building</p>
|
|
1272
1373
|
|
1273
1374
|
</p><div class="docstring">
|
1274
1375
|
<div class="discussion">
|
1275
|
-
|
1276
|
-
|
1376
|
+
<p>
|
1377
|
+
This is a short cut method to set the start anchor position If you need
|
1277
1378
|
finer granularity in positioning use graphic_frame.anchor.from.colOff /
|
1278
|
-
rowOff
|
1379
|
+
rowOff
|
1380
|
+
</p>
|
1279
1381
|
|
1280
1382
|
|
1281
1383
|
</div>
|
@@ -1294,8 +1396,9 @@ rowOff</p>
|
|
1294
1396
|
|
1295
1397
|
|
1296
1398
|
—
|
1297
|
-
<div class='inline'>
|
1298
|
-
|
1399
|
+
<div class='inline'><p>
|
1400
|
+
The column
|
1401
|
+
</p>
|
1299
1402
|
</div>
|
1300
1403
|
|
1301
1404
|
</li>
|
@@ -1310,8 +1413,9 @@ rowOff</p>
|
|
1310
1413
|
|
1311
1414
|
|
1312
1415
|
—
|
1313
|
-
<div class='inline'>
|
1314
|
-
|
1416
|
+
<div class='inline'><p>
|
1417
|
+
The row
|
1418
|
+
</p>
|
1315
1419
|
</div>
|
1316
1420
|
|
1317
1421
|
</li>
|
@@ -1338,13 +1442,13 @@ rowOff</p>
|
|
1338
1442
|
<pre class="lines">
|
1339
1443
|
|
1340
1444
|
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1344
|
-
|
1445
|
+
119
|
1446
|
+
120
|
1447
|
+
121
|
1448
|
+
122</pre>
|
1345
1449
|
</td>
|
1346
1450
|
<td>
|
1347
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1451
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 119</span>
|
1348
1452
|
|
1349
1453
|
<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span>
|
1350
1454
|
<span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span>
|
@@ -1365,8 +1469,9 @@ rowOff</p>
|
|
1365
1469
|
|
1366
1470
|
</p><div class="docstring">
|
1367
1471
|
<div class="discussion">
|
1368
|
-
|
1369
|
-
|
1472
|
+
<p>
|
1473
|
+
Serializes the picture
|
1474
|
+
</p>
|
1370
1475
|
|
1371
1476
|
|
1372
1477
|
</div>
|
@@ -1385,8 +1490,9 @@ rowOff</p>
|
|
1385
1490
|
|
1386
1491
|
|
1387
1492
|
—
|
1388
|
-
<div class='inline'>
|
1389
|
-
|
1493
|
+
<div class='inline'><p>
|
1494
|
+
The document builder instance this objects xml will be added to.
|
1495
|
+
</p>
|
1390
1496
|
</div>
|
1391
1497
|
|
1392
1498
|
</li>
|
@@ -1413,9 +1519,6 @@ rowOff</p>
|
|
1413
1519
|
<pre class="lines">
|
1414
1520
|
|
1415
1521
|
|
1416
|
-
124
|
1417
|
-
125
|
1418
|
-
126
|
1419
1522
|
127
|
1420
1523
|
128
|
1421
1524
|
129
|
@@ -1437,17 +1540,20 @@ rowOff</p>
|
|
1437
1540
|
145
|
1438
1541
|
146
|
1439
1542
|
147
|
1440
|
-
148
|
1543
|
+
148
|
1544
|
+
149
|
1545
|
+
150
|
1546
|
+
151</pre>
|
1441
1547
|
</td>
|
1442
1548
|
<td>
|
1443
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1549
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 127</span>
|
1444
1550
|
|
1445
1551
|
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
|
1446
1552
|
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:pic'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
1447
1553
|
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:nvPicPr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
1448
1554
|
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='string val'>"2"</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:descr=</span><span class='gt op'>></span><span class='descr identifier id'>descr</span><span class='rparen token'>)</span>
|
1449
1555
|
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvPicPr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
1450
|
-
<span class='
|
1556
|
+
<span class='picture_locking identifier id'>picture_locking</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
|
1451
1557
|
<span class='rbrace token'>}</span>
|
1452
1558
|
<span class='rbrace token'>}</span>
|
1453
1559
|
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:blipFill'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
@@ -1482,8 +1588,9 @@ rowOff</p>
|
|
1482
1588
|
|
1483
1589
|
</p><div class="docstring">
|
1484
1590
|
<div class="discussion">
|
1485
|
-
|
1486
|
-
|
1591
|
+
<p>
|
1592
|
+
providing access to the anchor’s width attribute
|
1593
|
+
</p>
|
1487
1594
|
|
1488
1595
|
|
1489
1596
|
</div>
|
@@ -1519,12 +1626,12 @@ rowOff</p>
|
|
1519
1626
|
<pre class="lines">
|
1520
1627
|
|
1521
1628
|
|
1522
|
-
|
1523
|
-
|
1524
|
-
|
1629
|
+
92
|
1630
|
+
93
|
1631
|
+
94</pre>
|
1525
1632
|
</td>
|
1526
1633
|
<td>
|
1527
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1634
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 92</span>
|
1528
1635
|
|
1529
1636
|
<span class='def def kw'>def</span> <span class='width identifier id'>width</span>
|
1530
1637
|
<span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span>
|
@@ -1564,12 +1671,12 @@ rowOff</p>
|
|
1564
1671
|
<pre class="lines">
|
1565
1672
|
|
1566
1673
|
|
1567
|
-
|
1568
|
-
|
1569
|
-
|
1674
|
+
97
|
1675
|
+
98
|
1676
|
+
99</pre>
|
1570
1677
|
</td>
|
1571
1678
|
<td>
|
1572
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line
|
1679
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 97</span>
|
1573
1680
|
|
1574
1681
|
<span class='def def kw'>def</span> <span class='width= identifier id'>width=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span>
|
1575
1682
|
<span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span>
|
@@ -1585,7 +1692,7 @@ rowOff</p>
|
|
1585
1692
|
</div>
|
1586
1693
|
|
1587
1694
|
<div id="footer">
|
1588
|
-
Generated on
|
1695
|
+
Generated on Mon Dec 5 14:21:19 2011 by
|
1589
1696
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1590
1697
|
0.7.3 (ruby-1.8.7).
|
1591
1698
|
</div>
|