Interface Ganger<P,A>
- All Known Implementing Classes:
MatrixGanger
,StackGanger
,TimeStackGanger
- Since:
- 25 Jan 2016
- Author:
- Mark Taylor
-
Method Summary
Modifier and TypeMethodDescriptionA[]
adjustAspects
(A[] aspects, int iz) Adjusts plot surface aspects as required to ensure that plot data regions in a ganged set of zones are consistent.P[]
adjustProfiles
(P[] profiles) Adjusts plot surface profiles as required for plots appearing in multiple plots within a gang.createApproxGang
(Rectangle extBounds) Constructs an approximate gang instance given only minimal information.createGang
(Rectangle[] zonePlotBounds) Creates a gang given the graphics coordinates of the individual zones.createGang
(Rectangle extBounds, SurfaceFactory<P, A> surfFact, ZoneContent<P, A>[] zoneContents, Trimming[] trimmings, ShadeAxis[] shadeAxes, boolean withScroll) Creates a gang given the external bounds for the whole plotting area and other required information that characterises each zone.int
Returns the number of zones in gangs produced by this ganger.boolean
Indicates whether shared Aux colour ramps are to be applied to each zone individually or to the whole plot.boolean
Indicates whether Trimming objects (legend and title) are to be applied to each zone individually or to the whole plot.
-
Method Details
-
getZoneCount
int getZoneCount()Returns the number of zones in gangs produced by this ganger.- Returns:
- zone count
-
isTrimmingGlobal
boolean isTrimmingGlobal()Indicates whether Trimming objects (legend and title) are to be applied to each zone individually or to the whole plot. For a single-zone ganger it ought not to make a difference, but false should be returned.- Returns:
- true for per-gang trimmings, false for per-zone trimmings
- See Also:
-
isShadingGlobal
boolean isShadingGlobal()Indicates whether shared Aux colour ramps are to be applied to each zone individually or to the whole plot. For a single-zone ganger it ought not to make a difference, but false should be returned.- Returns:
- true for per-gang shade axis, false for per-zone shade axis
- See Also:
-
createGang
Creates a gang given the graphics coordinates of the individual zones. This can be used if the layout of the zones is already known.The supplied rectangle arguments give the bounds of the data area for each zone. This does not include any space for axis labels and other annotations, which are assumed to be available as required.
- Parameters:
zonePlotBounds
- array of data bounds, one for each zone- Returns:
- new gang
-
createGang
Gang createGang(Rectangle extBounds, SurfaceFactory<P, A> surfFact, ZoneContent<P, A>[] zoneContents, Trimming[] trimmings, ShadeAxis[] shadeAxes, boolean withScroll) Creates a gang given the external bounds for the whole plotting area and other required information that characterises each zone. The supplied aspects are not modified by this method; any required aspect resolution should be performed before calling it.The form of the
trimmings
andshadeAxes
arrays are as determined by theisTrimmingGlobal()
andisShadingGlobal()
methods; the length of each respective array must be one for the global case, and the same as the length of thezoneContents
array in the per-zone case.- Parameters:
extBounds
- total area enclosing all zones and associated axis labels, annotations etcsurfFact
- surface factoryzoneContents
- plot content for each zone (nz-element array)trimmings
- additional decorations (1- or nz-element array, elements may be null)shadeAxes
- shading axes (1- or nz-element array, elements may be null)withScroll
- true if the positioning should work well even after some user scrolling- Returns:
- new gang
-
createApproxGang
Constructs an approximate gang instance given only minimal information. This may be sufficient for passing the user a visual indication of roughly how zones are arranged, or making initial guesses at zone dimensions.- Parameters:
extBounds
- total area enclosing all zones and associated axis labels, annotations etc- Returns:
- new approximate gang
-
adjustAspects
Adjusts plot surface aspects as required to ensure that plot data regions in a ganged set of zones are consistent.If a reference index greater than or equal to zero is supplied, this denotes the "master" zone, to which the other aspects should be adjusted. Otherwise, the aspects should be adjusted more democratically, treating all their requirements equally. With a reference index the other aspects might be adjusted to equal the master one, and without they might all be adjusted to cover the union of the ranges defined. If the reference index is >= the number of zones, behaviour is undefined.
- Parameters:
aspects
- unadjusted aspectsiz
- index of reference aspect in array, or -1 for no reference- Returns:
- array of consistent aspects based on input array, same size as input
-
adjustProfiles
Adjusts plot surface profiles as required for plots appearing in multiple plots within a gang.- Parameters:
profiles
- unadjusted profiles- Returns:
- array of consistent profiles based on input array, same size as input
-