From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/Line3DChart.html | 985 --------------------------------------------- 1 file changed, 985 deletions(-) delete mode 100644 doc/Axlsx/Line3DChart.html (limited to 'doc/Axlsx/Line3DChart.html') diff --git a/doc/Axlsx/Line3DChart.html b/doc/Axlsx/Line3DChart.html deleted file mode 100644 index a0995552..00000000 --- a/doc/Axlsx/Line3DChart.html +++ /dev/null @@ -1,985 +0,0 @@ - - - - - - Class: Axlsx::Line3DChart - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::Line3DChart - - - -

- -
- -
Inherits:
-
- Chart - -
    -
  • Object
    • - - - - - -
- show all - -
- - - - - - - - - -
Defined in:
-
lib/axlsx/drawing/line_3D_chart.rb
- -
-
- -

Overview

-
- -

The Line3DChart is a three dimentional line chart (who would have guessed?) -that you can add to your worksheet.

- - -
-
-
- -
-

Examples:

- -

-

Creating a chart

-

- 
# This example creates a line in a single sheet.
-require "rubygems" # if that is your preferred way to manage gems!
-require "axlsx"
-
-p = Axlsx::Package.new
-ws = p.workbook.add_worksheet
-ws.add_row :values => ["This is a chart with no data in the sheet"]
-
-chart = ws.add_chart(Axlsx::Line3DChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
-chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
-
- -
- - -

See Also:

- - -
-

Constant Summary

- -
- -
GAP_AMOUNT_PERCENT = -
-
- -

validation regex for gap amount percent

- - -
-
-
- - -
-
- 
/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
-
- -
- - - - - - - -

Instance Attribute Summary (collapse)

- - - - - - - - - -

Attributes inherited from Chart

-

graphic_frame, series, series_type, show_legend, style, title, view3D

- - - -

- Instance Method Summary - (collapse) -

- - - - - - - - - - - - -

Methods inherited from Chart

-

#add_series, #end_at, #from, #index, #pn, #start_at, #to

-
-

Constructor Details

- -
-

- - - (Line3DChart) initialize(frame, options = {}) - - - -

-
- -

Creates a new line chart object

- - -
-
-
-

Parameters:

-
    - -
  • - - frame - - - (GraphicFrame) - - - - — -
    -

    The workbook that owns this chart.

    -
    - -
    • - -
  • - - options - - - (Hash) - - - (defaults to: {}) - - - — -
    -

    a customizable set of options

    -
    - -
    • - -
- - - - - - -

Options Hash (options):

-
    - -
  • - title - (Cell, String) - - - - -
    • - -
  • - show_legend - (Boolean) - - - - -
    • - -
  • - grouping - (Symbol) - - - - -
    • - -
  • - gapDepth - (String) - - - - -
    • - -
  • - rotX - (Integer) - - - - -
    • - -
  • - hPercent - (String) - - - - -
    • - -
  • - rotY - (Integer) - - - - -
    • - -
  • - depthPercent - (String) - - - - -
    • - -
  • - rAngAx - (Boolean) - - - - -
    • - -
  • - perspective - (Integer) - - - - -
    • - -
- - - -

See Also:

- - -
- - - - -
- 
-
-
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70
-71
-72
-73
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 61
-
-def initialize(frame, options={})
-  @gapDepth = nil
-  @grouping = :standard
-  @catAxId = rand(8 ** 8)
-  @valAxId = rand(8 ** 8)
-  @serAxId = rand(8 ** 8)
-  @catAxis = CatAxis.new(@catAxId, @valAxId)
-  @valAxis = ValAxis.new(@valAxId, @catAxId)
-  @serAxis = SerAxis.new(@serAxId, @valAxId)
-  super(frame, options)      
-  @series_type = LineSeries
-  @view3D = View3D.new({:perspective=>30}.merge(options))
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (CatAxis) catAxis (readonly) - - - -

-
- -

the category axis

- - -
-
-
- -

Returns:

- - -
- - - - -
- 
-
-
-25
-26
-27
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 25
-
-def catAxis
-  @catAxis
-end
-
-
-
- - - - -
-

- - - (String) gapDepth - - - -

-
- -

space between bar or column clusters, as a percentage of the bar or column -width.

- - -
-
-
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-37
-38
-39
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 37
-
-def gapDepth
-  @gapDepth
-end
-
-
-
- - - - -
-

- - - (Symbol) grouping - - - -

-
- -

grouping for a column, line, or area chart. must be one of -[:percentStacked, :clustered, :standard, :stacked]

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Symbol) - - - -
    • - -
- -
- - - - -
- 
-
-
-42
-43
-44
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 42
-
-def grouping
-  @grouping
-end
-
-
-
- - - - -
-

- - - (Axis) serAxis (readonly) - - - -

-
- -

the category axis

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Axis) - - - -
    • - -
- -
- - - - -
- 
-
-
-33
-34
-35
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 33
-
-def serAxis
-  @serAxis
-end
-
-
-
- - - - -
-

- - - (ValAxis) valAxis (readonly) - - - -

-
- -

the category axis

- - -
-
-
- -

Returns:

- - -
- - - - -
- 
-
-
-29
-30
-31
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 29
-
-def valAxis
-  @valAxis
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

- - - (String) to_xml - - - -

-
- -

Serializes the bar chart

- - -
-
-
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
-100
-101
-102
-103
-104
- 		- 
# File 'lib/axlsx/drawing/line_3D_chart.rb', line 89
-
-def to_xml
-  super() do |xml|
-    xml.send('c:line3DChart') {
-      xml.send('c:grouping', :val=>grouping)
-      xml.send('c:varyColors', :val=>1)
-      @series.each { |ser| ser.to_xml(xml) }
-      xml.send('c:gapDepth', :val=>@gapDepth) unless @gapDepth.nil?
-      xml.send('c:axId', :val=>@catAxId)
-      xml.send('c:axId', :val=>@valAxId)
-      xml.send('c:axId', :val=>@serAxId)
-    }
-    @catAxis.to_xml(xml)
-    @valAxis.to_xml(xml)
-    @serAxis.to_xml(xml)
-  end
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3