rate_dataset::set_layout

Source: dataset/rate/rate_dataset__set_layout.pro

 rate_dataset::set_layout
        Set the plot layout of the plot for a rates dataset.

 Usage:
        dsref -> set_layout[, layout, <keys>]

 Argument:
        layout  int     Either a 2-element array giving the number of
                        columns and row, or a single integer giving
                        the number of columns (the number of rows is
                        then computed from the dataset properties).

 Keywords:
        default         Set the layout to the default for this
                        dataset. This is called whenever streams are
                        added or the sectoring options are changed.
        colour          Use colour to distinguish different traces on
                        a single panel. If this is specified without
                        any arguments, then for a dataset with only 1
                        stream or for an unsectored dataset the layout
                        is changed to plot all the traces on a single
                        panel.
        linestyle       Similar to the colour key, except that
                        linestyles are used in place of colours.
        in_columns      Set the priority of rows and columns.
        by_sector       For a dataset with both multiple sectors and
                        multiple streams, put all the sectors of each
                        stream in a single plot.
        with_headers    If set, then add boxes top & bottom with
                        details of the plot.
        verify          If set, then check whether the current layout
                        settings are valid for the dataset as it now
                        stands (e.g. if you've added a stream since
                        the last time the layout was set).
        lock_columns    If set, then the default and verify settings
                        will not change the number of columns. (use
                        lock_columns=0 to unset this).

 Notes:
        If the plot must have multiple traces per panel, then setting
        both colour and linestyle to zero will produce colour
        differentiation if the output has a colour table and linestyle
        if not.

 History:
        Original: 20/1/00; SJT
        Add verify option: 28/1/00; SJT
        Internal improvements: 16/2/00; SJT
        Change default to "by_sector" and other loose ends: 27/6/00;
        SJT
        Add lock_columns: 20/4/01; SJT
        Move simple settings to the top to try to avoid losing
        sectoring: 9/7/01; SJT