3.1.9.2.15. Options for PlotL2 subfigure

Option aliases:

  • LineOptions0 -> PlotOptions0

  • nPlotFirst -> NPlotFirst

  • nFirst -> NPlotFirst

  • nPlotIters -> NPlotIters

  • nPlotLast -> NPlotLast

  • FigHeight -> FigureHeight

  • FigWidth -> FigureWidth

  • GridStyle -> GridPlotOptions

  • LineOptions -> PlotOptions

  • MinorGridStyle -> MinorGridPlotOptions

  • RestrictionLocation -> RestrictionLoc

  • RestrictionX -> RestrictionXPosition

  • RestrictionY -> RestrictionYPosition

  • dpi -> DPI

  • Parent -> Type

  • parent -> Type

  • pos -> Position

  • type -> Type

  • width -> Width

Recognized options:

Alignment: {'center'} | object

value of option “Alignment”

Caption: {None} | str

subfigure caption

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

MinorGrid: {None} | True | False

whether to show axes minor grid

MinorGridPlotOptions: {{}} | dict

plot options for minor grid, if shown

NPlotFirst: {1} | int

iteration at which to start figure

NPlotIters: {None} | int

value of option “NPlotIters”

NPlotLast: {None} | int

value of option “NPlotLast”

PlotOptions: {None} | ResidPlotOpts

options for main line(s) of plot

PlotOptions0: {None} | ResidPlot0Opts

plot options for initial residual

Position: {'b'} | 'c' | 't'

subfigure vertical alignment

Residual: {'L2'} | str

name of residual field or type to plot

ResidualType: {'state'} | 'turb'

residual type, primary or ‘turb’

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”

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

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