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 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.booleanIndicates whether shared Aux colour ramps are to be applied to each zone individually or to the whole plot.booleanIndicates whether Trimming objects (legend and title) are to be applied to each zone individually or to the whole plot.Methods inherited from class StackGanger
adjustAspects, createApproxGang, createGang, createGang, getZoneCount, getZoneNames
-
Field Details
-
FACTORY
GangerFactory instance that returns TimeStackGangers.
-
-
Constructor Details
-
TimeStackGanger
-
-
Method Details
-
isTrimmingGlobal
public boolean isTrimmingGlobal()Description copied from interface:GangerIndicates 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:GangerIndicates 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:StackGangerReturns the data limits of the horizontal axis defined by a given aspect.- Specified by:
getXLimitsin 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:StackGangerModifies an aspect object to give it fixed data limits on the horizontal axis.- Specified by:
fixXLimitsin 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:GangerAdjusts plot surface profiles as required for plots appearing in multiple plots within a gang.- Specified by:
adjustProfilesin interfaceGanger<TimeSurfaceFactory.Profile, TimeAspect>- Overrides:
adjustProfilesin classStackGanger<TimeSurfaceFactory.Profile, TimeAspect>- Parameters:
profiles- unadjusted profiles- Returns:
- array of consistent profiles based on input array, same size as input
-