figureone
    Preparing search index...

    CollectionsPlotLegend options object that extends OBJ_Collection options object (without parent).

    A legend consists of a number of trace samples and their corresponding names, and may have an encompassing frame with a border and fill.

    • position TypeParsablePoint — position of the first trace in the legend
    • length number — length of the line sample
    • space number — space between the line and the text
    • offset TypeParsablePoint | TypeParsablePoint[] — offset between trace samples - can be used to space out a legend, or make it horizontal
    • font OBJ_Font — default font for trace sample text
    • fontColorIsLineColor boolean — set the trace sample text color to the same as the line sample
    • frame number[] | OBJ_PlotFrame — frame around the legend - specifying just a color will create a solid fill rectangle of that color
    • show number[] — array of which trace indeces to show if only some should be shown
    • hide number[] — array of which trace indeces to hide if some should be hidden
    • custom OBJ_PlotLegendCustom — customizations to specific trace samples
    • traces COL_Trace[] — the traces from the plot that this legend will display. This is used by CollectionsPlot and should not be used by the user.