DOC: Add index/label details in data table representation (#62466)

gnkl · web-flow · commit 576d05fc8d65 · 2025-12-15T09:32:31.000-08:00
diff --git a/doc/source/_static/schemas/01_table_dataframe.svg b/doc/source/_static/schemas/01_table_dataframe.svg
@@ -1,262 +1,48 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   width="143.19496mm"
-   height="104.30615mm"
-   viewBox="0 0 143.19496 104.30615"
-   version="1.1"
-   id="svg10280"
-   inkscape:version="0.92.4 (f8dce91, 2019-08-02)"
-   sodipodi:docname="01_table_dataframe.svg">
-  <defs
-     id="defs10274" />
-  <sodipodi:namedview
-     id="base"
-     pagecolor="#ffffff"
-     bordercolor="#666666"
-     borderopacity="1.0"
-     inkscape:pageopacity="0.0"
-     inkscape:pageshadow="2"
-     inkscape:zoom="0.7"
-     inkscape:cx="355.65317"
-     inkscape:cy="142.80245"
-     inkscape:document-units="mm"
-     inkscape:current-layer="layer1"
-     showgrid="false"
-     inkscape:window-width="1551"
-     inkscape:window-height="849"
-     inkscape:window-x="49"
-     inkscape:window-y="27"
-     inkscape:window-maximized="1"
-     fit-margin-top="0"
-     fit-margin-left="0"
-     fit-margin-right="0"
-     fit-margin-bottom="0" />
-  <metadata
-     id="metadata10277">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title />
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <g
-     inkscape:label="Layer 1"
-     inkscape:groupmode="layer"
-     id="layer1"
-     transform="translate(-22.613419,-96.097789)">
-    <g
-       id="g888"
-       transform="matrix(0.89990753,0,0,0.9,9.4364163,14.825088)"
-       style="stroke-width:1.11116815">
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 23.647349,141.16281 H 48.53529 V 128.97485 H 23.647349 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-7"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 50.063339,127.4468 H 74.951291 V 115.25884 H 50.063339 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 50.063339,141.16281 H 74.951291 V 128.97485 H 50.063339 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-2"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 23.647339,153.86281 H 48.53529 V 141.67486 H 23.647339 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-7-5"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 50.063339,153.86281 H 74.951291 V 141.67486 H 50.063339 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-6"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 75.463341,127.4468 H 100.3513 V 115.25884 H 75.463341 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-5"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 75.463341,141.16281 H 100.3513 V 128.97485 H 75.463341 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-2-3"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 75.463341,153.86281 H 100.3513 V 141.67486 H 75.463341 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-7-5"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 23.647349,179.26284 H 48.53529 V 167.07487 H 23.647349 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-8-0"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 50.063339,179.26284 H 74.951291 V 167.07487 H 50.063339 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-7-8-5"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 75.463341,179.26284 H 100.3513 V 167.07487 H 75.463341 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-7-5-2"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 23.647349,191.96284 H 48.53529 V 179.77488 H 23.647349 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-8-0-7"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 50.063339,191.96284 H 74.951291 V 179.77488 H 50.063339 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-7-8-5-2"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="M 75.463341,191.96284 H 100.3513 V 179.77488 H 75.463341 Z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-7-8"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 100.86334,127.4468 h 24.88794 v -12.18796 h -24.88794 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-4"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 100.86335,141.16281 h 24.88793 v -12.18796 h -24.88793 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-7-5-5"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 100.86334,153.86281 h 24.88794 v -12.18795 h -24.88794 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-8-2-7"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 100.86335,179.26284 h 24.88793 v -12.18797 h -24.88793 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-8-2-7-1"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 100.86335,191.96284 h 24.88793 v -12.18796 h -24.88793 z" />
-      <g
-         id="g935"
-         style="stroke-width:1.11116815">
-        <path
-           d="M 23.647349,166.56283 H 48.53529 V 154.37487 H 23.647349 Z"
-           style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-           id="path4891-1-50-8-2-1-7"
-           inkscape:connector-curvature="0" />
-        <path
-           d="M 50.063339,166.56283 H 74.951291 V 154.37487 H 50.063339 Z"
-           style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-           id="path4891-1-50-8-2-1-9-8"
-           inkscape:connector-curvature="0" />
-        <path
-           d="M 75.463341,166.56283 H 100.3513 V 154.37487 H 75.463341 Z"
-           style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-           id="path4891-1-50-8-2-1-7-8"
-           inkscape:connector-curvature="0" />
-        <path
-           d="m 100.86335,166.56283 h 24.88793 v -12.18796 h -24.88793 z"
-           style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-           id="path4891-1-50-8-2-1-9-8-2"
-           inkscape:connector-curvature="0" />
-        <path
-           d="m 126.26334,166.56283 h 24.88792 v -12.18796 h -24.88792 z"
-           style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-           id="path4891-1-50-8-2-1-9-8-2-4"
-           inkscape:connector-curvature="0" />
-      </g>
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-7-8-2"
-         style="fill:#afabab;fill-opacity:1;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 126.26333,127.4468 h 24.88793 v -12.18796 h -24.88793 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-4-2"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 126.26334,141.16281 h 24.88792 v -12.18796 h -24.88792 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-7-5-5-1"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 126.26333,153.86281 h 24.88793 v -12.18795 h -24.88793 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-8-2-7-6"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 126.26334,179.26284 h 24.88792 v -12.18797 h -24.88792 z" />
-      <path
-         inkscape:connector-curvature="0"
-         id="path4891-1-50-8-2-1-9-8-2-7-1-2"
-         style="fill:#afabab;fill-opacity:0.39215686;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.56897205;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-         d="m 126.26334,191.96284 h 24.88792 v -12.18796 h -24.88792 z" />
-      <text
-         id="text47247-9"
-         y="200.30403"
-         x="100.55013"
-         style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.29399657"
-         xml:space="preserve"><tspan
-           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.05555534px;font-family:monospace;-inkscape-font-specification:monospace;stroke-width:0.29399657"
-           y="200.30403"
-           x="100.55013"
-           id="tspan47245-7"
-           sodipodi:role="line">column</tspan></text>
-      <text
-         id="text47247-1"
-         y="103.81308"
-         x="76.306671"
-         style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.29399657"
-         xml:space="preserve"><tspan
-           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10.58333302px;font-family:monospace;-inkscape-font-specification:monospace;stroke-width:0.29399657"
-           y="103.81308"
-           x="76.306671"
-           id="tspan47245-3"
-           sodipodi:role="line">DataFrame</tspan></text>
-      <rect
-         y="113.61689"
-         x="100.55073"
-         height="79.987907"
-         width="25.513165"
-         id="rect850"
-         style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.29399657;stroke-opacity:1" />
-      <rect
-         y="154.10715"
-         x="22.74571"
-         height="12.771029"
-         width="129.30719"
-         id="rect850-3"
-         style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.29399657;stroke-opacity:1" />
-      <text
-         id="text47247-9-6"
-         y="162.41847"
-         x="153.07187"
-         style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.29399657"
-         xml:space="preserve"><tspan
-           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.05555534px;font-family:monospace;-inkscape-font-specification:monospace;stroke-width:0.29399657"
-           y="162.41847"
-           x="153.07187"
-           id="tspan47245-7-7"
-           sodipodi:role="line">row</tspan></text>
-    </g>
-  </g>
-</svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="1047" height="768" viewBox="0 0 1047 768">
+<rect x="28" y="28" width="991" height="712" fill="none" rx="16" ry="16"/>
+<text x="523.5" y="120" text-anchor="middle" font-family="monospace" font-size="96" font-weight="normal" fill="#000000">DataFrame</text>
+<rect x="354.5" y="237.0" width="168" height="78" fill="#aaaaaa"/>
+<rect x="524.5" y="237.0" width="168" height="78" fill="#aaaaaa"/>
+<rect x="694.5" y="237.0" width="168" height="78" fill="#aaaaaa"/>
+<rect x="184.5" y="317.0" width="168" height="88" fill="#aaaaaa"/>
+<rect x="184.5" y="407.0" width="168" height="88" fill="#aaaaaa"/>
+<rect x="184.5" y="497.0" width="168" height="88" fill="#aaaaaa"/>
+<rect x="184.5" y="587.0" width="168" height="88" fill="#aaaaaa"/>
+<rect x="354.5" y="317.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="524.5" y="317.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="694.5" y="317.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="354.5" y="407.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="524.5" y="407.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="694.5" y="407.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="354.5" y="497.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="524.5" y="497.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="694.5" y="497.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="354.5" y="587.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="524.5" y="587.0" width="168" height="88" fill="#d8d8d880"/>
+<rect x="694.5" y="587.0" width="168" height="88" fill="#d8d8d880"/>
+<line x1="353.5" y1="236.0" x2="353.5" y2="676.0" stroke="#none" stroke-width="6"/>
+<line x1="523.5" y1="236.0" x2="523.5" y2="676.0" stroke="#none" stroke-width="6"/>
+<line x1="693.5" y1="236.0" x2="693.5" y2="676.0" stroke="#none" stroke-width="6"/>
+<line x1="863.5" y1="236.0" x2="863.5" y2="676.0" stroke="#none" stroke-width="6"/>
+<line x1="183.5" y1="236.0" x2="863.5" y2="236.0" stroke="#none" stroke-width="6"/>
+<line x1="183.5" y1="316.0" x2="863.5" y2="316.0" stroke="#none" stroke-width="6"/>
+<line x1="183.5" y1="406.0" x2="863.5" y2="406.0" stroke="#none" stroke-width="6"/>
+<line x1="183.5" y1="496.0" x2="863.5" y2="496.0" stroke="#none" stroke-width="6"/>
+<line x1="183.5" y1="586.0" x2="863.5" y2="586.0" stroke="#none" stroke-width="6"/>
+<rect x="183.5" y="236.0" width="680" height="440" fill="none" stroke="#none" stroke-width="6"/>
+<text x="438.5" y="286.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">Name</text>
+<text x="608.5" y="286.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">Age</text>
+<text x="778.5" y="286.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">Sex</text>
+<text x="268.5" y="371.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">0</text>
+<text x="268.5" y="461.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">1</text>
+<text x="268.5" y="551.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">2</text>
+<text x="268.5" y="641.0" text-anchor="middle" font-family="monospace" font-size="28" font-weight="normal" fill="#000000">3</text>
+<rect x="693.5" y="236.0" width="170" height="440" fill="none" stroke="#000080" stroke-width="2.0"/>
+<text x="778.5" y="721.0" text-anchor="middle" font-family="monospace" font-size="40" font-weight="normal" fill="#000080">column</text>
+<rect x="183.5" y="406.0" width="680" height="90" fill="none" stroke="#800000" stroke-width="2.0"/>
+<text x="938.5" y="461.0" text-anchor="middle" font-family="monospace" font-size="40" font-weight="normal" fill="#800000">row</text>
+<rect x="183.5" y="316.0" width="170" height="360" fill="none" stroke="#3b3b3b" stroke-width="4"/>
+<text x="268.5" y="721.0" text-anchor="middle" font-family="monospace" font-size="40" font-weight="normal" fill="#000000">index</text>
+<rect x="353.5" y="236.0" width="510" height="80" fill="none" stroke="#3b3b3b" stroke-width="4"/>
+<text x="933.5" y="296.0" text-anchor="middle" font-family="monospace" font-size="40" font-weight="normal" fill="#000000">label</text>
+</svg>
diff --git a/doc/source/getting_started/intro_tutorials/01_table_oriented.rst b/doc/source/getting_started/intro_tutorials/01_table_oriented.rst
@@ -72,6 +72,8 @@ SQL table or the ``data.frame`` in `R <https://www.r-project.org/>`__.
 -  The column ``Name`` consists of textual data with each value a
    string, the column ``Age`` are numbers and the column ``Sex`` is
    textual data.
+-  The index labels each row. By default, this is a sequence of integers
+   starting at 0.
 
 In spreadsheet software, the table representation of our data would look
 very similar:
