Module RailsERD

  1. lib/rails_erd/diagram/graphviz.rb
  2. lib/rails_erd/diagram.rb
  3. lib/rails_erd/domain/attribute.rb
  4. lib/rails_erd/domain/entity.rb
  5. lib/rails_erd/domain/relationship/cardinality.rb
  6. lib/rails_erd/domain/relationship.rb
  7. lib/rails_erd/domain/specialization.rb
  8. lib/rails_erd/domain.rb
  9. lib/rails_erd/railtie.rb
  10. lib/rails_erd.rb
  11. show all

Welcome to the API documentation of Rails ERD. If you wish to extend or customise the output that is generated by Rails ERD, you have come to the right place.

Creating custom output

If you want to create your own kind of diagrams, or some other output, a good starting point is the RailsERD::Diagram class. It can serve as the base of your output generation code.

Options

Rails ERD provides several options that allow you to customise the generation of the diagram and the domain model itself. For an overview of all options available in Rails ERD, see README.rdoc.

You can specify the option on the command line if you use Rails ERD with Rake: 

% rake erd orientation=vertical title='My model diagram'

When using Rails ERD from within Ruby, you can set the options on the RailsERD namespace module: 

RailsERD.options.orientation = :vertical
RailsERD.options.title = "My model diagram"

Classes and Modules

Class RailsERD::Diagram
Class RailsERD::Domain
Class RailsERD::Railtie

Attributes

options [RW] Access to default options. Any instance of RailsERD::Domain and RailsERD::Diagram will use these options unless overridden.