DiagramTable of Contents

INTERNAL METHODSMETHODSNAMENAMEDiagram - a package to display SEED diagrams

METHODSadd_note (type, id, note)calculate_scale ()color_item (type, id, color_name)colors ()get_diagram_image ()get_overlay_image ()has_item (type, id)height ()html ()image_file ()image_map ()image_map_file ()item_ids_of_type (type)items ()max_height (max_height)max_width (max_width)min_scale (min_scale)new (subsystem_name, path)parse_image_map ()scale (scale)subsystem_name ()width ()Adds a tooltip note to the item specified by type and id. note has to b

Colors the item specified by type and id with the color color_name.

If the method is not called on a diagram, the default value MAX_HEIGHT will be used.

If the method is not called on a diagram, the default value MAX_WIDTH will be used.

If the method is not called on a diagram, the default value MIN_SCALE will be used.

Reads the image map file and (1) populates the internal item hash and

Returns a hash reference to the items.

Returns a new Diagram object. Mandatory parameters are the name of the

Returns a reference to a hash of acceptable color names.

Returns a reference to a list of ids of a given type type contained in th

Returns reference to self if the diagram has an item of type with the id id.

Returns the diagram (together with it's image map) as html code. The image

Returns the height of the diagram image

Returns the html code of the image map. Currently the javascript needed for the

Returns the maximal height of the resulting diagram image. Images will be rescaled to fit that size

Returns the maximal width of the resulting diagram image. Images will be rescaled to fit that size

Returns the minimal scaling modifier allowed for the diagram as a float between 0 and 1.

Returns the name of the subsystem.

Returns the path to the image file.

Returns the path to the image map file.

Returns the reference to the Image::Magick instance of the diagram image file

Returns the reference to the Image::Magick instance of the overlay (an

Returns the scaling factor based on the image size, the supposed maximal widt

Returns the width of the diagram image

Scales the image and recalculates the internal item coordinates by the

Set to 1.0 if you like to turn off scaling.

type and id are mandatory. Returns undef else.

min_scale should be 0. If the optional parameter max_height is provided, the maximal height will be set.

max_width is provided, the maximal width will be set.

min_scale is provided, the minimal scaling modifier will be set.

new().

min_scale).

max_width and max_height) and the minimal scaling creates it if necessary).

type is mandaotry. Returns an empty list if the factor scale given as parameter.

subsystem_name and the path to the diagram path wit tag get the id='diagram' to be able to add CSS styles or javascript.

INTERNAL METHODSInternal or overwritten default perl methods. Do not use from outside!