AGContourLegend / AGContourLegendObj

Synopsis

draw a legend that matches an AGContour

AGGeometryPrimitive AGContourLegend
{
     geometry = {0,0};
     AGColor fillColor  = "background";
     AGColor frameColor  = "antibackground";
     AGDistance frameWidth  = 0.25;
     AGInt labelDecimals;
     AGFont labelFont  = "Roman-Simplex";
     AGDistance labelHeight  = 2.5;
     AGColor labelColor  = "antibackground";
     AGString title  = "Legend";
     AGFont titleFont  = "Roman-Simplex";
     AGDistance titleHeight  = 3.0;
     AGColor titleColor  = "antibackground";
     AGContour+IPort2+read+opt &contour;
};

Description

AGContourLegend and AGContourLegendObj draw a legend that corresponds to the connected AGContour. AGContourLegendObj includes an AGDataObject for your convenience. The legend for a contour plot only appears when contours are also plotted.

Subobjects

visibility

priority

Inherited from AGPrimitive through AGGeometryPrimitive.

geometry

Inherited from AGGeometryPrimitive.

fillColor

frameColor

frameWidth

Determine the fill color, frame color, and frame width of the rectangular legend area.

labelDecimals

labelFont

labelHeight

labelColor

The number of decimals places, the font, the height, and the color for the numeric leg

end labels.

title

titleFont

titleHeight

titleColor

The text, font, height , and color of the legend title. If the text is a null string or the height is 0.0, no title is plotted.

contour

The AGContour object that the legend is matching. Without this reference connection nothing is plotted.

Example

Libraries.Examples.Annotation_Graphing.contour1

examples/contour1.v

Libraries.Examples.Annotation_Graphing.contour2

examples/contour2.v

File

v/UI.v

See Also Related Modules

AGContour / AGContourObj

AGGeometryPrimitive / AGRenderPrimitive

AGPrimitive