## LayoutGrid Type

A plot grid that can contain subplots with shared axes.

### Constructors

 Constructor Description  LayoutGrid()  Full Usage: LayoutGrid() Returns: LayoutGrid Returns: LayoutGrid

### Static members

 Static member Description  LayoutGrid.init (?Rows, ?Columns, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide)  Full Usage: LayoutGrid.init (?Rows, ?Columns, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide) Parameters: ?Rows : int - The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?Columns : int - The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?SubPlots : (LinearAxisId * LinearAxisId)[][] - Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute. ?XAxes : LinearAxisId[] - Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs. ?YAxes : LinearAxisId[] - Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs. ?RowOrder : LayoutGridRowOrder - Is the first row the top or the bottom? Note that columns are always enumerated from left to right. ?Pattern : LayoutGridPattern - If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder. ?XGap : float - Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids. ?YGap : float - Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids. ?Domain : Domain - Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. ?XSide : LayoutGridXSide - Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar. ?YSide : LayoutGridYSide - Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar. Returns: LayoutGrid Initializes a LayoutGrid object ?Rows : int The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?Columns : int The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?SubPlots : (LinearAxisId * LinearAxisId)[][] Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute. ?XAxes : LinearAxisId[] Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs. ?YAxes : LinearAxisId[] Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs. ?RowOrder : LayoutGridRowOrder Is the first row the top or the bottom? Note that columns are always enumerated from left to right. ?Pattern : LayoutGridPattern If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder. ?XGap : float Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids. ?YGap : float Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids. ?Domain : Domain Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. ?XSide : LayoutGridXSide Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar. ?YSide : LayoutGridYSide Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar. Returns: LayoutGrid  LayoutGrid.style (?Rows, ?Columns, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide)  Full Usage: LayoutGrid.style (?Rows, ?Columns, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide) Parameters: ?Rows : int - The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?Columns : int - The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?SubPlots : (LinearAxisId * LinearAxisId)[][] - Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute. ?XAxes : LinearAxisId[] - Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs. ?YAxes : LinearAxisId[] - Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs. ?RowOrder : LayoutGridRowOrder - Is the first row the top or the bottom? Note that columns are always enumerated from left to right. ?Pattern : LayoutGridPattern - If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder. ?XGap : float - Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids. ?YGap : float - Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids. ?Domain : Domain - Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. ?XSide : LayoutGridXSide - Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar. ?YSide : LayoutGridYSide - Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar. Returns: LayoutGrid -> LayoutGrid Returns a function that applies the given styles to a LayoutGrid. ?Rows : int The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?Columns : int The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. ?SubPlots : (LinearAxisId * LinearAxisId)[][] Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute. ?XAxes : LinearAxisId[] Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs. ?YAxes : LinearAxisId[] Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs. ?RowOrder : LayoutGridRowOrder Is the first row the top or the bottom? Note that columns are always enumerated from left to right. ?Pattern : LayoutGridPattern If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder. ?XGap : float Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids. ?YGap : float Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids. ?Domain : Domain Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. ?XSide : LayoutGridXSide Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar. ?YSide : LayoutGridYSide Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar. Returns: LayoutGrid -> LayoutGrid