WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

$SummaryBoxDataSizeLimit
✖
$SummaryBoxDataSizeLimit

As of Version 12.1 of the Wolfram Language, $SummaryBoxDataSizeLimit has been superseded by $NotebookInlineStorageLimit.

✖
$SummaryBoxDataSizeLimit

specifies the maximum size in bytes of expressions that will be stored in displayed summary boxes.

Details

  • Summary boxes, which display the function name, an icon and key properties instead of the complete expression, are used by functions such as SparseArray, TimeSeries and InterpolatingFunction.
  • Summary boxes for expressions smaller than $SummaryBoxDataSizeLimit contain a full copy of the expression and can be reused as input.
  • Expressions larger than $SummaryBoxDataSizeLimit have summary boxes that do not contain a full copy of the expression, but provide an interface for storing the expression for later reuse.
  • The expression can only be embedded in the summary box while the kernel session that created it is still running and has a reference to the expression, either in a variable or Out[n].

Examples

open allclose all

Basic Examples  (2)Summary of the most common use cases

The default value:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-f3kk87
Out[1]=1

The byte count of this sparse array is less than this limit:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-2cc33d
Out[2]=2

Therefore, the following summary box contains the complete expression:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-xkw2r0
Out[3]=3

This summary box can be copied and used as input:

In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-1q9sp6
Out[4]=4

Set $SummaryBoxDataSizeLimit to a small value:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-wa4cas

The byte count of this sparse array is greater than this limit:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-k2giyf
Out[2]=2

Therefore, the summary box does not store the expression, but provides an interface to do so:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-pme1ah
Out[3]=3

This version of the summary box cannot be used as input by simply copying it:

In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-80rgcv

Copying the summary and box and clicking the "Store now" button will create a usable input:

In[5]:=5
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-f1ukcu
Out[5]=5

Restore the default value of $SummaryBoxDataSizeLimit:

In[6]:=6
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-7hpfo4
Out[6]=6

Scope  (4)Survey of the scope of standard use cases

Numerical functions such as InterpolatingFunction respect $SummaryBoxDataSizeLimit:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-uaac2m
Out[1]=1

Check the byte count of each expression:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-jt4ypf
Out[2]=2

NearestFunction behaves similarly:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-rbmgaw
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-3iivgt
Out[4]=4

Array types that produce summary boxes respect $SummaryBoxDataSizeLimit:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-l7bh1f
Out[1]=1

Check the byte count of each expression:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-h52l70
Out[2]=2

StructuredArray behaves similarly:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-o6f9sz
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-kigd80
Out[4]=4

Statistical functions such as TimeSeries respect $SummaryBoxDataSizeLimit:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-e7pyit
Out[1]=1

Check the byte count of each expression:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-trf6hf
Out[2]=2

WeightedData behaves similarly:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-ckdpxu
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-nbnji0
Out[4]=4

GeoPosition respects $SummaryBoxDataSizeLimit:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-8lagyz
Out[1]=1

Check the byte count of each expression:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-1jsyz2
Out[2]=2

Applications  (2)Sample problems that can be solved with this function

Save space in notebooks by setting $SummaryBoxDataSizeLimit to zero:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-15cpc4
Out[1]=1

Create a summary box, which will not contain the expression, and save a reference to the cell in c1:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-b91ly5
Out[2]=2

Restore the default value of $SummaryBoxDataSizeLimit:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-05yi46
Out[3]=3

Recreate the summary box for if, which now has the expression in it, and save a reference in c2:

In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-ffkpn2
Out[4]=4

Output cell c1 is about nine and a half kilobytes smaller than output cell c2:

In[5]:=5
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-5578va
Out[5]=5

Save memory in a kernel session by setting $HistoryLength to zero:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-zei3w8

Create a large summary box, which will not be saved in the notebook:

In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-jh3fn1
Out[2]=2

Because there is no reference to the output, the "Store now" button cannot work:

In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-rspep2

Create another summary box, but save the result in the variable data:

In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-bopdsu
Out[4]=4

As long as data is not reset, the "Store now" button will continue to work:

In[5]:=5
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-01xmb7
Out[5]=5

Verify that the data was in fact larger than $SummaryBoxDataSizeLimit:

In[6]:=6
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-h7bkpx
Out[6]=6

Restore the default values of $HistoryLength:

In[7]:=7
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-nfly62

Properties & Relations  (1)Properties of the function, and connections to other functions

$SummaryBoxDataSizeLimit only affects summary boxes:

In[1]:=1
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-jeztv5
In[2]:=2
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-i1cpdu
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-igiwk2
Out[3]=3

$OutputSizeLimit affects all outputs:

In[4]:=4
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-1v13wy
In[6]:=6
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-1lsq98
Out[6]=6
In[7]:=7
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-kcokkt
Out[7]=7
In[8]:=8
✖
https://wolfram.com/xid/0d2t8b9yng7rk51lf8fysi-99avv
Wolfram Research (2017), $SummaryBoxDataSizeLimit, Wolfram Language function, https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html.
✖
Wolfram Research (2017), $SummaryBoxDataSizeLimit, Wolfram Language function, https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html.

Text

Wolfram Research (2017), $SummaryBoxDataSizeLimit, Wolfram Language function, https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html.

✖
Wolfram Research (2017), $SummaryBoxDataSizeLimit, Wolfram Language function, https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html.

CMS

Wolfram Language. 2017. "$SummaryBoxDataSizeLimit." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html.

✖
Wolfram Language. 2017. "$SummaryBoxDataSizeLimit." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html.

APA

Wolfram Language. (2017). $SummaryBoxDataSizeLimit. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html

✖
Wolfram Language. (2017). $SummaryBoxDataSizeLimit. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html

BibTeX

@misc{reference.wolfram_2025_$summaryboxdatasizelimit, author="Wolfram Research", title="{$SummaryBoxDataSizeLimit}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html}", note=[Accessed: 27-April-2025 ]}

✖
@misc{reference.wolfram_2025_$summaryboxdatasizelimit, author="Wolfram Research", title="{$SummaryBoxDataSizeLimit}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html}", note=[Accessed: 27-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_$summaryboxdatasizelimit, organization={Wolfram Research}, title={$SummaryBoxDataSizeLimit}, year={2017}, url={https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html}, note=[Accessed: 27-April-2025 ]}

✖
@online{reference.wolfram_2025_$summaryboxdatasizelimit, organization={Wolfram Research}, title={$SummaryBoxDataSizeLimit}, year={2017}, url={https://reference.wolfram.com/language/ref/$SummaryBoxDataSizeLimit.html}, note=[Accessed: 27-April-2025 ]}