Class enthought.​chaco.​scales.​formatters.​OffsetFormatter

Contents:
• Base classes
• Attributes
• Methods

Inherits from

• BasicFormatter: enthought.chaco.scales.formatters.BasicFormatter

Attributes

• end_label_format

  Determines which format to use to display the end labels. Can be "offset" or "sci".

  end_label_format = 'offset'
  
  

• offset

  The offset generated by the last call to format()

  offset = None
  
  

• offset_display

  Determines which ticks to display the offset value at. Can be "all", "firstlast", or "none".

  offset_display = 'firstlast'
  
  

• offset_format

  There are two possible formats for the offset.

  "sci"

  uses scientific notation for the offset

  "decimal"

  pads with zeroes left or right until the decimal

  The following table shows some example ranges and how an intermediate tick will be displayed. These all assume an offset_display value of "none" or "firstlast".

  start	end	sci	decimal
  90.0004	90.0008	5.0e-4	.0005
  90.0004	90.0015	1.2e-3	.0012
  -1200015	-1200003	12	12
  2300015000	2300015030	1.502e4	15020

  offset_format = 'sci'
  
  

• offset_limits

  Specifies the threshold values

  offset_limits = (-Const(3), 4)
  
  

• offset_threshold

  The threshold ratio of the data range to the average data value, below which "offset" display mode will be used if use_offset is True.

  offset_threshold = 0.001
  
  

• use_offset

  Whether or not to use offsets when labelling the ticks. Note that even if this is true, offset are only used when the ratio of the data range to the average data value is smaller than a threshold.

  use_offset = False
  
  

Method summary

• estimate_width(self, start, end, numlabels = None, char_width = None, fill_ratio = 0.29999999999999999, ticker = None)
• format(self, ticks, numlabels = None, char_width = None)

Methods

• estimate_width(self, start, end, numlabels = None, char_width = None, fill_ratio = 0.29999999999999999, ticker = None)
• format(self, ticks, numlabels = None, char_width = None)