3.1.9.2.13. Options for PlotContourSweep
subfigure¶
Option aliases:
ColorMap -> ContourColorMap
PlotType -> LineType
XAxis -> XCol
YAxis -> YCol
xcol -> XCol
xk -> XCol
ycol -> YCol
yk -> YCol
FigHeight -> FigureHeight
FigWidth -> FigureWidth
GridStyle -> GridPlotOptions
LineOptions -> PlotOptions
MinorGridStyle -> MinorGridPlotOptions
RestrictionLocation -> RestrictionLoc
RestrictionX -> RestrictionXPosition
RestrictionY -> RestrictionYPosition
dpi -> DPI
nPlotFirst -> NPlotFirst
nFirst -> NPlotFirst
Parent -> Type
parent -> Type
pos -> Position
type -> Type
width -> Width
Recognized options:
- Alignment: {
'center'
} |object
value of option “Alignment”
- AxisEqual: {
True
} |False
option to scale x and y axes with common scale
- Caption: {
None
} |str
subfigure caption
- ColorBar: {
True
} |False
option to turn on color bar (scale)
- Component: {
'entire'
} |str
config component to plot
- ContourColorMap: {
'jet'
} |str
name of color map to use w/ contour plots
- ContourOptions: {
None
} |dict
options passed to contour plot function
- ContourType:
'tricontour'
| {'tricontourf'
} |'tripcolor'
contour plotting function/type to use
- DPI: {
150
} |int
dots per inch if saving as rasterized image
- FigureHeight: {
4.5
} |float
height of subfigure graphics in inches
- FigureWidth: {
6.0
} |float
width of subfigure graphics in inches
- Format:
'jpeg'
|'jpg'
| {'pdf'
} |'png'
|'svg'
image file format
- Grid: {
None
} |True
|False
whether to show axes grid in background
- GridPlotOptions: {
{}
} |dict
plot options for major grid, if shown
- LineType: {
'plot'
} |'triplot'
plot function to use to mark data points
- MinorGrid: {
None
} |True
|False
whether to show axes minor grid
- MinorGridPlotOptions: {
{}
} |dict
plot options for minor grid, if shown
- NPlotFirst: {
None
} |object
iteration at which to start figure
- PlotOptions: {
None
} |ContourCoeffPlotOpts
options for main line(s) of plot
- Position: {
'b'
} |'c'
|'t'
subfigure vertical alignment
- Restriction: {
''
} |str
data restriction to place on figure
- RestrictionLoc:
'bottom'
|'bottom left'
|'bottom right'
|'left'
|'lower left'
|'lower right'
|'right'
| {'top'
} |'top left'
|'top right'
|'upper left'
|'upper right'
location for subfigure restriction text
- RestrictionOptions: {
{}
} |dict
additional opts to
text()
for restriction- RestrictionXPosition: {
None
} |float
explicit x-coord of restriction
- RestrictionYPosition: {
None
} |float
explicit y-coord of restriction
- TickLabelOptions: {
None
} |dict
common options for ticks of both axes
- TickLabels: {
None
} |True
|False
common value(s) for ticks of both axes
- Ticks: {
None
} |True
|False
value of option “Ticks”
- Type: {
None
} |str
subfigure type or parent
- Width: {
0.33
} |float
value of option “Width”
- XCol: {
None
} |str
run matrix key to use for x-axis
- XLabel: {
None
} |str
manual label for x-axis
- XLabelOptions: {
None
} |dict
text options for x-axis label
- XLim: {
None
} |object
explicit min and max limits for x-axis
- XLimMax: {
None
} |object
outer limits for min and max x-axis limits
- XMax: {
None
} |float
explicit upper limit for x-axis limits
- XMin: {
None
} |float
explicit lower limit for x-axis limits
- XTickLabelOptions: {
None
} |dict
text options for x-axis tick labels
- XTickLabels: {
None
} |True
|False
|float
|str
option to turn off x-axis tick labels or set values
- XTicks: {
None
} |True
|False
|float
option to turn off x-axis ticks or set values
- YCol: {
None
} |str
run matrix key to use for y-axis
- YLabel: {
None
} |str
manual label for y-axis
- YLabelOptions: {
None
} |dict
text options for y-axis label
- YLim: {
None
} |object
explicit min and max limits for y-axis
- YLimMax: {
None
} |object
outer limits for min and max y-axis limits
- YMax: {
None
} |float
explicit upper limit for y-axis limits
- YMin: {
None
} |float
explicit lower limit for y-axis limits
- YTickLabelOptions: {
None
} |dict
text options for y-axis tick labels
- YTickLabels: {
None
} |True
|False
|float
|str
option to turn off x-axis tick labels or set values
- YTicks: {
None
} |True
|False
|float
option to turn off y-axis ticks or set values