Package uk.ac.starlink.ttools.plot2.geom
Class TimeStackGanger
java.lang.Object
uk.ac.starlink.ttools.plot2.geom.StackGanger<TimeSurfaceFactory.Profile,TimeAspect>
uk.ac.starlink.ttools.plot2.geom.TimeStackGanger
- All Implemented Interfaces:
Ganger<TimeSurfaceFactory.Profile,
TimeAspect>
Ganger that stacks time plots vertically with a shared time axis.
- Since:
- 3 Feb 2016
- Author:
- Mark Taylor
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final GangerFactory
<TimeSurfaceFactory.Profile, TimeAspect> GangerFactory instance that returns TimeStackGangers.Fields inherited from class uk.ac.starlink.ttools.plot2.geom.StackGanger
ZONEGAP_KEY
-
Constructor Summary
ConstructorsConstructorDescriptionTimeStackGanger
(String[] zoneNames, Padding padding, int zoneGap) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionadjustProfiles
(TimeSurfaceFactory.Profile[] profiles) Adjusts plot surface profiles as required for plots appearing in multiple plots within a gang.fixXLimits
(TimeAspect aspect, double xmin, double xmax) Modifies an aspect object to give it fixed data limits on the horizontal axis.double[]
getXLimits
(TimeAspect aspect) Returns the data limits of the horizontal axis defined by a given aspect.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.Methods inherited from class uk.ac.starlink.ttools.plot2.geom.StackGanger
adjustAspects, createApproxGang, createGang, createGang, getZoneCount, getZoneNames
-
Field Details
-
FACTORY
GangerFactory instance that returns TimeStackGangers.
-
-
Constructor Details
-
TimeStackGanger
Constructor.- Parameters:
zoneNames
- zone identifiers, one for each zone in the gangpadding
- defines user preferences, if any, for space reserved outside the whole gangzoneGap
- vertical gap between zones in gang
-
-
Method Details
-
isTrimmingGlobal
public boolean isTrimmingGlobal()Description copied from interface:Ganger
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
public boolean isShadingGlobal()Description copied from interface:Ganger
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:
-
getXLimits
Description copied from class:StackGanger
Returns the data limits of the horizontal axis defined by a given aspect.- Specified by:
getXLimits
in classStackGanger<TimeSurfaceFactory.Profile,
TimeAspect> - Parameters:
aspect
- surface aspect- Returns:
- 2-element array giving (min,max) values of data coordinates on the horizontal axis
-
fixXLimits
Description copied from class:StackGanger
Modifies an aspect object to give it fixed data limits on the horizontal axis.- Specified by:
fixXLimits
in classStackGanger<TimeSurfaceFactory.Profile,
TimeAspect> - Parameters:
aspect
- input surface aspectxmin
- required lower limit on horizontal axisxmax
- required upper limit on horizontal axis- Returns:
- new aspect resembling input aspect but with supplied horizontal axis limits
-
adjustProfiles
Description copied from interface:Ganger
Adjusts plot surface profiles as required for plots appearing in multiple plots within a gang.- Specified by:
adjustProfiles
in interfaceGanger<TimeSurfaceFactory.Profile,
TimeAspect> - Overrides:
adjustProfiles
in classStackGanger<TimeSurfaceFactory.Profile,
TimeAspect> - Parameters:
profiles
- unadjusted profiles- Returns:
- array of consistent profiles based on input array, same size as input
-