Class Name

---

  MGHgrPalette

Purpose

---

  An MGHgrPalette is an IDLgrPalette with a few enhancements to the
  Init method.
  OBJECT CREATION SEQUENCE:
  palette = obj_new('MGHgrPalette', 10)
  palette = obj_new('MGHgrPalette', 'MGH Special 2')
  palette = obj_new('MGHgrPalette', mgh_color(['red','white','blue']))

Superclasses

---

  IDLgrPalette
  POSITIONAL PARAMETERS (Init method):
  tbl
    Synonym for TABLE property.

Properties

---

  The following properties (ie keywords to the Init, GetProperty &
  SetProperty methods) are supported in addition to those inherited
  from IDLgrPalette:
    REVERSE (Init)
      Set this property to reverse the colour table.
    SYSTEM (Init)
      This keyword has an effect only if the TABLE parameter is a
      scalar integer or string. It is passed to the MGH_GET_CT
      function and determines whether the user-default (SYSTEM=0) or
      system (SYSTEM=1) colour table file is to be read.
    TABLE (Init)
      Specify the colour table associated with the palette in one
      of the following forms:
        Scalar structure: The red, green and blue vectors of the
          palette's colour table are specified via the RED, GREEN and
          BLUE tags of the structure.
        Integer array [3,n]: The red, green and blue vectors of the
          palette's colour table are specified via the respective
          rows of the array.
        Scalar integer or string: The color table is read from the colour
          table file by function MGH_GET_CT; the table parameter
          specifies the zero-based index (numeric) or table name
          (string) of the colour table to be read.
###########################################################################
  This software is provided subject to the following conditions:
  1. NIWA makes no representations or warranties regarding the
    accuracy of the software, the use to which the software may
    be put or the results to be obtained from the use of the
    software. Accordingly NIWA accepts no liability for any loss
    or damage (whether direct of indirect) incurred by any person
    through the use of or reliance on the software.
  2. NIWA is to be acknowledged as the original author of the
    software where the software is used or presented in any form.
###########################################################################

Modification History

---

  Mark Hadfield, 2001-11:
    Written.
  Mark Hadfield, 2002-06:
    Changed initialisation options: reduced maximum number of
    positional parameters from 3 to 1 and added TABLE keyword.