DasAnnotation anchorType=plot, other annotation clean up

[jbfaden]

DasAnnotation has always had three modes to anchor (position) the annotation: canvas, plot, and data. I think the original idea was that "data" was going to allow anchoring to data, where the bounds of the data were going to be used to position the data. This never happened, and a simple bounding box (xrange = 20 to 25; yrange = 40 to 45) is allowed and Autoplot scripts are used to identify the data bounds. The "plot" mode was going to anchor to axes, but is never used because this is what the data position does. (Canvas just anchors to a row and column, or null values are just the entire canvas.) Further complicating things, we later added a verticalAnchorType which allows the two dimensions to be independently controlled.

I'd like for the "plot" to be made useful, where inside anchorPositions will clip using the plot clip, and outside anchorPositions will clip using reasonable boundaries so that adjacent plots are not affected. (Item 1)

There is additional cleanup which is needed, such as an improved GUI to control it, which Autoplot could use. (It has a quick one I threw together, but I don't think it's very effective.) (Item 2)

One still cannot rotate annotations, and this is an obvious feature that is overdue (Item 3). The properties "url" and "scale" should be deprecated since painters can be used for images (Item 4). "<img>" tags were supposed to be supported as well, but that's a different ticket (Item 5).

Last, there needs to be a clean document describing annotation use (Item 6).

See https://github.com/das-developers/das2java/issues/21, and Autoplot ticket https://sourceforge.net/p/autoplot/bugs/1696/ .

• [x] 1. Precisely define "PLOT" anchorType to mean anchor to a plot row and column, with clipping.
• [ ] 2. Improve GUI for controls
• [ ] 3. Allow for annotation rotation (90 degree, then arbitrary)
• [ ] 4. deprecate "url" and "scale", removing these from GUIs
• [ ] 5. support <img> in GrannyTextRenderer (https://github.com/das-developers/das2java/issues/21)
• [ ] 6. new, accessible, and correct documentation
• [x] 7. correct "point at" which moves the annotation.
• [x] 8. "move annotation" adjusts anchorOffsets, but does not consider splitAnchorType.
• [x] 9. "move annotation" sign errors.
• [x] 10. add "underscore" border type.
• [ ] 11. adjustment for tightness of margins.
• [x] 12. "data" anchors to the pointAt position, not the xrange, yrange box. This is very confusing and it should be the box. (Is this the same as item 7?)
• [x] 13. AnchorType canvas should support pointAt when a plot is identified.
• [ ] 14. The anchor box controls should be similar to the series renderer controls.
• [ ] 15. The editor can have multiple tabs to simplify controls
• [ ] 16. The anchor rectangle can be marked with ellipse

[jbfaden]

Also I'd like for there to be a way to specify how tight the margins are around the text. It looks like it's roughtly 1em right now, but sometimes I'd like to have no margin at all.

[jbfaden]

Also there should be a border type where it is just an underline, which can be used for pointing.

[jbfaden]

The bounds of a plot or data anchored annotation are not clipped properly, and slightly overlap the plot bounds.

[jbfaden]

See also https://github.com/autoplot/dev/blob/master/bugs/2023/20230210/demoAnnotations.jy

[jbfaden]

(Item 7) The "point at" mouse module included within the annotations would adjust the anchorOffsets, incorrectly. The pointAt point is different that the xrange and yrange which position the annotation, and the two should not be coupled.

[jbfaden]

(Item 8) "move annotation" adjusts anchorOffsets, but does not consider splitAnchorType.

[jbfaden]

(Item 9) "move annotation" has a sign error in Y when anchorPosition is OutsideNE. All branches of adjustAnchorOffset should be reviewed.

This script is useful:

from org.das2.graph import AnchorPosition

i=0
for v in AnchorPosition.values():
    annotation( i, anchorPosition=v, text=str(v) )
    i=i+1

[jbfaden]

Item 8 was not a bug. There is no special consideration needed.

[jbfaden]

I realized there is no way to attach an annotation to the data and have it draw outside the plot, like so:

I experimented with this and it seems like we'll need another control. anchorType "data" and "plot" both clip.

[jbfaden]

(7 and 12) I've always found the DATA mode for positioning strange, and I think I've finally figured out why. When "showArrow" was on, it would use the pointAt position to locate, and the xrange,yrange box otherwise. I'm correcting this, but I'm this will likely break existing products. It's always a good idea to favor the simpler code, and this is the simpler solution (and it removes about 12 lines of code).

[jbfaden]

I found that with splitAnchor type and verticalAnchorType=CANVAS, the anchor would still be clipped. This is fixed.

[jbfaden]

https://github.com/das-developers/das2java/issues/92 where GrannyTextRenderer doesn't clip painters properly.