<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

itools/

mgitwritesparkline__define.pro

Last modification:
Fri Aug 25 18:02:37 2006
A FileWriter for the iTools system to create PNG sparkline files from plot data (IDLVECTOR data).

Routine summary

result = mgitwritesparkline::setData(oPlotData)

Do the output.

mgitwritesparkline::setProperty[, width=integer][, height=integer][, color=bytarr(3)][, /transparent_background][, background=bytarr(3)][, /use_range_band][, band_color=bytarr(3)][, endpoint_color=bytarr(3)], _ref_extra=_ref_extra

Set properties of the object.

mgitwritesparkline::getProperty[, width=variable][, height=variable][, color=variable][, transparent_background=variable][, background=variable][, use_range_band=variable][, band_color=variable][, endpoint_color=variable], _ref_extra=_ref_extra

Get properties of the object.

mgitwritesparkline::cleanup

Free resources.

result = mgitwritesparkline::init([_ref_extra=keyword])

Initialize MGitWriteSparkline object.

mgitwritesparkline__define

Define instance variables.

topmgitwritesparkline::setData

result = mgitwritesparkline::setData(oPlotData)

Do the output.

Return value

1 for success, 0 otherwise

Parameters

oPlotData        in required type: object

data object

Statistics

McCabe cyclic 5
McCabe essential 1
McCabe modular design 1

topmgitwritesparkline::setProperty

mgitwritesparkline::setProperty[, width=integer][, height=integer][, color=bytarr(3)][, /transparent_background][, background=bytarr(3)][, /use_range_band][, band_color=bytarr(3)][, endpoint_color=bytarr(3)], _ref_extra=_ref_extra

Set properties of the object.

Keywords

width        in optional type: integer

width in pixels of the output

height        in optional type: integer

height in pixels of the output

color        in optional type: bytarr(3)

color of the plot

transparent_background        in optional type: boolean

set if a transparent background should be used

background        in optional type: bytarr(3)

background color (if not transparent)

use_range_band        in optional type: boolean

set if a range band should be used

band_color        in optional type: bytarr(3)

color of the range band

endpoint_color        in optional type: bytarr(3)

color of the endpoint

_ref_extra       

Statistics

McCabe cyclic 10
McCabe essential 1
McCabe modular design 1

topmgitwritesparkline::getProperty

mgitwritesparkline::getProperty[, width=variable][, height=variable][, color=variable][, transparent_background=variable][, background=variable][, use_range_band=variable][, band_color=variable][, endpoint_color=variable], _ref_extra=_ref_extra

Get properties of the object.

Keywords

width        out optional type: integer

width in pixels of the output

height        out optional type: integer

height in pixels of the output

color        out optional type: bytarr(3)

color of the plot

transparent_background        out optional type: booolean

set if a transparent background should be used

background        out optional type: background(3)

background color (if not transparent)

use_range_band        out optional type: boolean

set if a range band should be used

band_color        out optional type: bytarr(3)

color of the range band

endpoint_color        out optional type: bytarr(3)

color of the endpoint

_ref_extra       

Statistics

McCabe cyclic 10
McCabe essential 1
McCabe modular design 1

topmgitwritesparkline::cleanup

mgitwritesparkline::cleanup

Free resources.

Statistics

McCabe cyclic 1
McCabe essential 1
McCabe modular design 1

topmgitwritesparkline::init

result = mgitwritesparkline::init([_ref_extra=keyword])

Initialize MGitWriteSparkline object.

Return value

1 for success, 0 otherwise

Keywords

_ref_extra        in optional type: keyword

keywords of IDLitWriter::init

Statistics

McCabe cyclic 2
McCabe essential 1
McCabe modular design 1

topmgitwritesparkline__define

mgitwritesparkline__define

Define instance variables.

Statistics

McCabe cyclic 1
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0 on Wed Apr 25 22:45:39 2007.