Bio::EnsEMBL::DensityPlot::BinValueSet Class Reference

Public Member Functions
public	new ()
public	add_binvalue ()
public Array	get_binvalues ()
public	size ()
public Value	position ()
public Value	label ()
public Value	label2 ()
public Value	color ()
public Value	shape ()
public Value	stretch ()
public Scale_to_fit	scale_to_fit ()
protected Biggest	_store_biggest ()
protected Smallest	_store_smallest ()

Detailed Description

Synopsis

Description

Definition at line 12 of file BinValueSet.pm.

Member Function Documentation

_store_biggest()

protected Biggest Bio::EnsEMBL::DensityPlot::BinValueSet::_store_biggest

(

)

 Title   : _store_biggest
 Usage   : $self->_store_biggest($newval)
 Function: internal method for storing the largest BinValue->value in this set.
 Returns : biggest value seen so far
 Args    : value

Code:

_store_smallest()

protected Smallest Bio::EnsEMBL::DensityPlot::BinValueSet::_store_smallest

(

)

 Title   : _store_smallest
 Usage   : $self->_store_smallest($newval)
 Function: internal method for storing the smallest BinValue->value in this set.
 Returns : smallest value seen so far
 Args    : value

Code:

add_binvalue()

public Bio::EnsEMBL::DensityPlot::BinValueSet::add_binvalue

(

)

 Title   : add_binValue
 Usage   :
 Function:
 Example :

 Returns : 
 Args    :

Code:

color()

public Value Bio::EnsEMBL::DensityPlot::BinValueSet::color

(

)

 Title   : color
 Usage   : $obj->color($newval)
 Function: 
 Returns : value of color
 Args    : newvalue (optional)

Code:

get_binvalues()

public Array Bio::EnsEMBL::DensityPlot::BinValueSet::get_binvalues

(

)

 Title   : get_binvalues
 Usage   : my @binvalue_objects = $BVSet->get_binvalues
 Function: scales all the binvalues by the scale_factor and returns them.
 Example :

 Returns : array of BinValue objects 
 Args    : none

Code:

label()

public Value Bio::EnsEMBL::DensityPlot::BinValueSet::label

(

)

 Title   : label
 Usage   : $obj->label($newval)
 Function: 
 Returns : value of label
 Args    : newvalue (optional)

Code:

label2()

public Value Bio::EnsEMBL::DensityPlot::BinValueSet::label2

(

)

 Title   : label2
 Usage   : $obj->label2($newval)
 Function: 
 Returns : value of label2
 Args    : newvalue (optional)

Code:

new()

public Bio::EnsEMBL::DensityPlot::BinValueSet::new

(

)

Undocumented method

Code:

position()

public Value Bio::EnsEMBL::DensityPlot::BinValueSet::position

(

)

 Title   : position
 Usage   : $obj->position($newval)
 Function: 
 Returns : value of position
 Args    : newvalue (optional)

Code:

scale_to_fit()

public Scale_to_fit Bio::EnsEMBL::DensityPlot::BinValueSet::scale_to_fit

(

)

 Title   : scale_to_fit
 Usage   : $obj->scale_to_fit($newval)
 Function: gets/sets the number that the BinValues are to be scaled against -
 i.e. the greatest BinValue->value will be scaled to this number, and the rest
 scaled in proportion.
 Returns : scale_to_fit value
 Args    : newvalue (optional)

Code:

shape()

public Value Bio::EnsEMBL::DensityPlot::BinValueSet::shape

(

)

 Title   : shape
 Usage   : $obj->shape($newval)
 Function: 
 Returns : value of shape
 Args    : newvalue (optional)

Code:

size()

public Bio::EnsEMBL::DensityPlot::BinValueSet::size

(

)

Undocumented method

Code:

stretch()

public Value Bio::EnsEMBL::DensityPlot::BinValueSet::stretch

(

)

 Title   : stretch
 Usage   : $obj->stretch($newval)
 Function: gets/sets a boolean for whether we should stretch the data over the
 range (i.e. from min to max rather than absolute numbers).
 Returns : value of _stretch
 Args    : newvalue (optional)

Code:

---

The documentation for this class was generated from the following file:

• ensembl/modules/Bio/EnsEMBL/DensityPlot/BinValueSet.pm