Prawn::Graphics::Dash

Public Instance Methods

dash(length=nil, options={}) click to toggle source

Sets the dash pattern for stroked lines and curves

  length is the length of the dash. If options is not present,
  or options[:space] is nil, then length is also the length of
  the space between dashes

  options may contain :space and :phase
     :space is the space between the dashes
     :phase is where in the cycle to begin dashing. For
            example, a phase of 0 starts at the beginning of
            the dash; whereas, if the phase is equal to the
            length of the dash, then stroking will begin at
            the beginning of the space. Default is 0

  integers or floats may be used for length and the options

  dash units are in PDF points ( 1/72 in )

    # File lib/prawn/graphics/dash.rb, line 31
31:       def dash(length=nil, options={})        
32:         return current_dash_state || undash_hash if length.nil?
33: 
34:         self.current_dash_state = { :dash  => length, 
35:                   :space => options[:space] || length, 
36:                   :phase => options[:phase] || 0 }
37: 
38:         write_stroke_dash
39:       end

Also aliased as: dash=

dash=(length=nil, options={}) click to toggle source

Alias for: dash

dashed?() click to toggle source

Returns when stroke is dashed, false otherwise

    # File lib/prawn/graphics/dash.rb, line 52
52:       def dashed?
53:         current_dash_state != undashed_setting
54:       end

undash() click to toggle source

Stops dashing, restoring solid stroked lines and curves

    # File lib/prawn/graphics/dash.rb, line 45
45:       def undash
46:         self.current_dash_state = undashed_setting
47:         write_stroke_dash
48:       end

write_stroke_dash() click to toggle source

    # File lib/prawn/graphics/dash.rb, line 56
56:       def write_stroke_dash
57:         add_content dash_setting
58:       end

Private Instance Methods

current_dash_state() click to toggle source

    # File lib/prawn/graphics/dash.rb, line 72
72:       def current_dash_state
73:         graphic_state.dash
74:       end

current_dash_state=(dash_options) click to toggle source

    # File lib/prawn/graphics/dash.rb, line 68
68:       def current_dash_state=(dash_options)  
69:         graphic_state.dash = dash_options
70:       end

dash_setting() click to toggle source

    # File lib/prawn/graphics/dash.rb, line 76
76:       def dash_setting
77:         graphic_state.dash_setting
78:       end

undashed_setting() click to toggle source

    # File lib/prawn/graphics/dash.rb, line 62
62:       def undashed_setting
63:         { :dash => nil, :space => nil, :phase => 0 }
64:       end

Home Classes Methods

In Files

Methods

Files

Class Index

Prawn::Graphics::Dash

Public Instance Methods

Private Instance Methods