Skip to main content

functions - How to create expanding summary boxes like the ones displayed for InterpolatingFunction, NearestFunction, etc.?


The display forms for objects like ClassifierFunction are nice clickable summary boxes


enter image description here


I like this, and now I'm trying to create my a custom version of this for my functions, so I dissected the code in the output cell and trimmed it down to this:


CellPrint@
Cell[BoxData[
InterpretationBox[
RowBox[{DynamicModuleBox[{Typeset`open$$ = True},

PanelBox[
PaneSelectorBox[{False ->
GridBox[{{PaneBox[
ButtonBox[
DynamicBox[
FEPrivate`FrontEndResource["FEBitmaps",
"SquarePlusIconMedium"],
ImageSizeCache -> {12., {0., 12.}}],
Appearance -> None,
ButtonFunction :> (Typeset`open$$ = True),

Evaluator -> Automatic, Method -> "Preemptive"],
Alignment -> {Center, Center},
ImageSize ->
Dynamic[{Automatic,
3.5 (CurrentValue["FontCapHeight"]/
AbsoluteCurrentValue[Magnification])}]],
GridBox[{{RowBox[{TagBox["\<\"Collapsed Form!\"\>",
"SummaryItemAnnotation"]}]}},
BaseStyle -> {ShowStringCharacters -> False,
NumberMarks -> False, PrintPrecision -> 3,

ShowSyntaxStyles -> False},
GridBoxAlignment -> {"Columns" -> {{Left}},
"Rows" -> {{Automatic}}},
GridBoxItemSize -> {"Columns" -> {{Automatic}},
"Rows" -> {{Automatic}}},
GridBoxSpacings -> {"Columns" -> {{2}},
"Rows" -> {{Automatic}}}]}}, AutoDelete -> False,
BaselinePosition -> {1, 1},
GridBoxAlignment -> {"Rows" -> {{Center}}},
GridBoxItemSize -> {"Columns" -> {{Automatic}},

"Rows" -> {{Automatic}}}],
True -> GridBox[{{PaneBox[
ButtonBox[
DynamicBox[
FEPrivate`FrontEndResource["FEBitmaps",
"SquareMinusIconMedium"],
ImageSizeCache -> {12., {0., 12.}}],
Appearance -> None,
ButtonFunction :> (Typeset`open$$ = False),
Evaluator -> Automatic, Method -> "Preemptive"],

Alignment -> {Center, Center},
ImageSize ->
Dynamic[{Automatic,
3.5 (CurrentValue["FontCapHeight"]/
AbsoluteCurrentValue[Magnification])}]],
GridBox[{{RowBox[{TagBox["\<\"Open Form\"\>",
"SummaryItemAnnotation"]}]}, {RowBox[{TagBox[
"\<\"Open Form\"\>",
"SummaryItemAnnotation"]}]}, {RowBox[{TagBox[
"\<\"Open Form\"\>", "SummaryItemAnnotation"]}]}},

BaseStyle -> {ShowStringCharacters -> False,
NumberMarks -> False, PrintPrecision -> 3,
ShowSyntaxStyles -> False},
GridBoxAlignment -> {"Columns" -> {{Left}},
"Rows" -> {{Automatic}}},
GridBoxItemSize -> {"Columns" -> {{Automatic}},
"Rows" -> {{Automatic}}},
GridBoxSpacings -> {"Columns" -> {{2}},
"Rows" -> {{Automatic}}}]}}, AutoDelete -> False,
BaselinePosition -> {1, 1},

GridBoxAlignment -> {"Rows" -> {{Center}}},
GridBoxItemSize -> {"Columns" -> {{Automatic}},
"Rows" -> {{Automatic}}}]}, Dynamic[Typeset`open$$],
ImageSize -> Automatic], BaselinePosition -> Baseline],
DynamicModuleValues :> {}]}], Missing[]]], "Output",
ImageSize -> {350, 47}, ImageMargins -> {{0, 0}, {0, 0}},
ImageRegion -> {{0, 1}, {0, 1}}]

This code is a bit confusing to me and sadly many of the functions used have no documentation like DynamicBox, PanelBox, PaneSelectorBox... Perhaps there is a more convenient way of doing this than resorting to esoteric boxes?



Answer




Mathematica does it internally by using BoxForm`ArrangeSummaryBox, which is quite straightforward to figure out.


Example


ClearAll[MyObject];

MyObject /: MakeBoxes[obj : MyObject[asc_? myObjectAscQ], form : (StandardForm | TraditionalForm)] :=
Module[{above, below},
above = { (* example grid *)
{BoxForm`SummaryItem[{"Name: ", asc["Name"]}], SpanFromLeft},
{BoxForm`SummaryItem[{"Variables: ", asc["Variables"]}], BoxForm`SummaryItem[{"Length: ", asc["Length"]}]}
};

below = { (* example column *)
BoxForm`SummaryItem[{"Date: ", asc["Date"]}],
BoxForm`SummaryItem[{"Metadata: ", asc[MetaInformation]}]
};
BoxForm`ArrangeSummaryBox[
MyObject, (* head *)
obj, (* interpretation *)
$icon, (* icon, use None if not needed *)
(* above and below must be in a format suitable for Grid or Column *)
above, (* always shown content *)

below, (* expandable content *)
form,
"Interpretable" -> Automatic
]
];

It is useful to define a function to test whether MyObject is in the correct format (and whether a summary box can be generated with no errors).


myObjectAscQ[asc_?AssociationQ] := AllTrue[{"Name", "Variables", "Date", "Length", MetaInformation}, KeyExistsQ[asc, #]&]
myObjectAscQ[_] = False;


Summary boxes typically have icons of a certain size:


$icon = 
Graphics[{Red,Disk[]},
ImageSize -> Dynamic[{ (* this seems to be the standard icon size *)
Automatic,
3.5 CurrentValue["FontCapHeight"]/AbsoluteCurrentValue[Magnification]
}]
];

Let us test it:



MyObject[<|
"Name" -> "My particular object",
"Length" -> 10,
"Variables" -> {a,b,c},
"Date" -> Today,
MetaInformation -> "more info..." |>]

Mathematica graphics


In its expanded form it looks like this:


Mathematica graphics



The "Interpretable" option


If "Interpretable" is set to True, the formatted object can be used directly as input, and will be interpreted as the second argument of ArrangeSummaryBox.


If "Interpretable" is set to Automatic, Mathematica 11.2 and later will decide whether to embed the data into the displayed form of the object based on $SummaryBoxDataSizeLimit. When this size is exceeded, there will be a button that can be used to embed the data.


Mathematica graphics


Usage


Let us define a property retrieval interface, so out MyObject actually does something:


MyObject[asc_?AssociationQ][prop_] := Lookup[asc, prop]

Let's copy-paste the formatted object from above as new input:


Mathematica graphics



Comments

Popular posts from this blog

plotting - How to draw lines between specified dots on ListPlot?

I would like to create a plot where I have unconnected dots and some connected. So far, I have figured out how to draw the dots. My code is the following: ListPlot[{{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4,13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full] I have thought using ListLinePlot command, but I don't know how to specify to the command to draw only selected lines between the dots. Do have any suggestions/hints on how to do that? Thank you. Answer One possibility would be to use Epilog with Line : ListPlot[ {{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4, 13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full, Epilog -> { Line[ ...

calculus and analysis - Integral of the Sinc product

Let us consider the following integral $$ B_n = \int_0^\infty \prod_{k=1,3,5,\dots}^n\frac{\sin (x/k)}{x/k}dx $$ By definition, Sinc[x] == Sin[x]/x , therefore B[n_?OddQ] := Integrate[Product[Sinc[x/k], {k, 1, n, 2}], {x, 0, Infinity}] B /@ Range[1, 13, 2] {Pi/2, Pi/2, Pi/2, Pi/2, Pi/2, Pi/2, Pi/2} OK, everything is fine. But... B[15] 467807924713440738696537864469 Pi/935615849440640907310521750000 What's going on? Answer As Eckhard wrote in comments B[n] is the n-th Borwein integral . (The letter B was not accidental :) ) This funny properties of Borwein integrals is related to the Fourier transform of Sinc function FourierTransform[Sinc[x], x, k] 1/2 Sqrt[Pi/2] (Sign[1 - k] + Sign[1 + k]) Plot[%, {k, -2, 2}, Filling -> 0] which is the box function. The result is $\pi/2$ while the sum $$ 1/3+1/5+\dots+1/n $$ B_n = \frac{\pi}{2} - \pi \bigg(\sum_{k=3,5,\ldots}^n\frac{1}{k} -1\biggr)^\frac{n-1}{2}\prod_{k=3,5,\dots}^n\frac{k}{k-1}. $$ For $n=15$ it is equal to $$ \frac{46780...

list manipulation - Selecting multiple columns from a matrix?

Sample data: data = { {{2013, 1, 1}, 24.13, 167.67, 231.82}, {{2013, 1, 2}, 32.15, 170.92, 225.99}, {{2013, 1, 3}, 35.43, 172.68, 221.67}, {{2013, 1, 4}, 36.73, 173.05, 218.32}, {{2013, 1, 5}, 58.19, 165.96, 197.05}, {{2013, 1, 6}, 69.99, 163.50, 187.52}, {{2013, 1, 7}, 71.37, 154.21, 175.58}, {{2013, 1, 8}, 72.51, 149.66, 163.25}}; I want a DateListPlot with three graphs, so for a matrix formed by columns 1 and 2, one for columns 1 and 3, and 1 for columns 1 and 4. At the moment I'm using this code: data2 = Transpose[{data[[All, 1]], data[[All, 2]]}]; data3 = Transpose[{data[[All, 1]], data[[All, 3]]}]; data4 = Transpose[{data[[All, 1]], data[[All, 4]]}]; DateListPlot[{data2, data3, data4}, Joined -> True, Filling -> {3 -> {1}}] but I have a hunch that this can be done more efficiently. I don't like the Transpose s in particular. Any ideas? edit (for extra credit) What if I need to multiply the second column by 2, which in my solution is simp...