diff options
| author | <> | 2022-08-09 13:05:05 +0000 |
|---|---|---|
| committer | <> | 2022-08-09 13:05:05 +0000 |
| commit | 6b699dbe4b30c57ae0a19e477060e807e7d00b4f (patch) | |
| tree | c648e76b531d40d67c9f5af073d0174137127e63 /frame-methods | |
| download | izuku.js-gh-pages.tar.xz izuku.js-gh-pages.zip | |
Deployed 2689fb9 with MkDocs version: 1.3.1gh-pages
Diffstat (limited to 'frame-methods')
| -rw-r--r-- | frame-methods/index.html | 829 |
1 files changed, 829 insertions, 0 deletions
diff --git a/frame-methods/index.html b/frame-methods/index.html new file mode 100644 index 0000000..d3f7463 --- /dev/null +++ b/frame-methods/index.html @@ -0,0 +1,829 @@ + +<!doctype html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + + + + <link rel="icon" href="../assets/logo.png"> + <meta name="generator" content="mkdocs-1.3.1, mkdocs-material-8.3.9"> + + + + <title>Frame Methods - Izuku Documentation</title> + + + + <link rel="stylesheet" href="../assets/stylesheets/main.1d29e8d0.min.css"> + + + <link rel="stylesheet" href="../assets/stylesheets/palette.cbb835fc.min.css"> + + + + + + + + + + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> + + + + <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + + + + + + </head> + + + + + + + + <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none"> + + + + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" for="__drawer"></label> + <div data-md-component="skip"> + + + <a href="#frame-methods" class="md-skip"> + Skip to content + </a> + + </div> + <div data-md-component="announce"> + + </div> + + + + +<header class="md-header" data-md-component="header"> + <nav class="md-header__inner md-grid" aria-label="Header"> + <a href=".." title="Izuku Documentation" class="md-header__button md-logo" aria-label="Izuku Documentation" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + + </a> + <label class="md-header__button md-icon" for="__drawer"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> + </label> + <div class="md-header__title" data-md-component="header-title"> + <div class="md-header__ellipsis"> + <div class="md-header__topic"> + <span class="md-ellipsis"> + Izuku Documentation + </span> + </div> + <div class="md-header__topic" data-md-component="header-topic"> + <span class="md-ellipsis"> + + Frame Methods + + </span> + </div> + </div> + </div> + + + + <label class="md-header__button md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> + </label> + <div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> + <label class="md-search__icon md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </label> + <nav class="md-search__options" aria-label="Search"> + + <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> + </button> + </nav> + + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="search-result"> + <div class="md-search-result__meta"> + Initializing search + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + + <div class="md-header__source"> + <a href="https://github.com/luciferreeves/izuku.js" title="Go to repository" class="md-source" data-md-component="source"> + <div class="md-source__icon md-icon"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> + </div> + <div class="md-source__repository"> + luciferreeves/izuku.js + </div> +</a> + </div> + + </nav> + +</header> + + <div class="md-container" data-md-component="container"> + + + + + + + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> + + + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + + + + + +<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href=".." title="Izuku Documentation" class="md-nav__button md-logo" aria-label="Izuku Documentation" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + + </a> + Izuku Documentation + </label> + + <div class="md-nav__source"> + <a href="https://github.com/luciferreeves/izuku.js" title="Go to repository" class="md-source" data-md-component="source"> + <div class="md-source__icon md-icon"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> + </div> + <div class="md-source__repository"> + luciferreeves/izuku.js + </div> +</a> + </div> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + + <li class="md-nav__item"> + <a href=".." class="md-nav__link"> + Home + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../getting-started/" class="md-nav__link"> + Getting Started + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../frame-properties/" class="md-nav__link"> + Frame Properties + </a> + </li> + + + + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Frame Methods + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> + Frame Methods + </a> + + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#data" class="md-nav__link"> + data() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#header" class="md-nav__link"> + header() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#title" class="md-nav__link"> + title() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#column" class="md-nav__link"> + column() + </a> + + <nav class="md-nav" aria-label="column()"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#get-a-single-column" class="md-nav__link"> + Get a single column + </a> + +</li> + + <li class="md-nav__item"> + <a href="#get-multiple-columns" class="md-nav__link"> + Get multiple columns + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#row" class="md-nav__link"> + row() + </a> + + <nav class="md-nav" aria-label="row()"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#get-a-single-row" class="md-nav__link"> + Get a single row + </a> + +</li> + + <li class="md-nav__item"> + <a href="#get-multiple-rows" class="md-nav__link"> + Get multiple rows + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fromjson" class="md-nav__link"> + fromJSON() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#fromcsv" class="md-nav__link"> + fromCSV() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find" class="md-nav__link"> + find() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sort" class="md-nav__link"> + sort() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#removeduplicates" class="md-nav__link"> + removeDuplicates() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#head" class="md-nav__link"> + head() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#tail" class="md-nav__link"> + tail() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#show" class="md-nav__link"> + show() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#showall" class="md-nav__link"> + showAll() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#info" class="md-nav__link"> + info() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#rangeindex" class="md-nav__link"> + rangeIndex() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#tojson" class="md-nav__link"> + toJSON() + </a> + +</li> + + <li class="md-nav__item"> + <a href="#tocsv" class="md-nav__link"> + toCSV() + </a> + +</li> + + </ul> + +</nav> + + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../helper-methods/" class="md-nav__link"> + Helper Methods + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../chaining-methods/" class="md-nav__link"> + Chaining Methods + </a> + </li> + + + + </ul> +</nav> + </div> + </div> + </div> + + + + <div class="md-content" data-md-component="content"> + <article class="md-content__inner md-typeset"> + + + <a href="https://github.com/luciferreeves/izuku.js/edit/main/docs/frame-methods.md" title="Edit this page" class="md-content__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg> + </a> + + + +<h1 id="frame-methods">Frame Methods</h1> +<p>There are some methods attached to the frame class. You can tap into those methods by using the dot (.) notation. Most of the methods are <a href="../chaining-methods">chainable</a>.</p> +<h3 id="data"><code>data()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>data()</code> method is used to modify the data in the frame. It takes the same data argument as the constructor – which is an array of arrays.</p> +<blockquote> +<p><strong>Note:</strong> If you use data method without passing any argument, it will simply return the frame.</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kd">const</span><span class="w"> </span><span class="nx">data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[[...],</span><span class="w"> </span><span class="p">[...],</span><span class="w"> </span><span class="p">...];</span><span class="w"></span> +<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Frame</span><span class="p">();</span><span class="w"></span> +<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="nx">data</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> +<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="c1">// modify the data</span><span class="w"></span> +<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="kd">const</span><span class="w"> </span><span class="nx">newData</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[[...],</span><span class="w"> </span><span class="p">[...],</span><span class="w"> </span><span class="p">[...],</span><span class="w"> </span><span class="p">[...],</span><span class="w"> </span><span class="p">...];</span><span class="w"></span> +<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="nx">newData</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="header"><code>header()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>header()</code> method is used to modify the column names in the frame. It takes the same header argument as the constructor – which is an array of strings.</p> +<blockquote> +<p><strong>Note:</strong> If you use header method without passing any argument, it will reset the column names to default header (Remember: header is optional).</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1">// modify the header</span><span class="w"></span> +<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">newHeader</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[...];</span><span class="w"></span> +<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">header</span><span class="p">(</span><span class="nx">newHeader</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a> +<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="c1">// Reset the header to default</span><span class="w"></span> +<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">header</span><span class="p">();</span><span class="w"></span> +<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a> +<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="c1">// You can use any empty value to reset the header to default, for example:</span><span class="w"></span> +<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="c1">// frame.header('');</span><span class="w"></span> +<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="c1">// frame.header(null);</span><span class="w"></span> +<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="c1">// frame.header(undefined);</span><span class="w"></span> +<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="c1">// frame.header([]);</span><span class="w"></span> +</code></pre></div> +<h3 id="title"><code>title()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>title()</code> method is used to modify the title of the frame. Title is optional.</p> +<blockquote> +<p><strong>Note:</strong> If you use title method without passing any argument, it will reset the title to default title (Remember: title is optional).</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1">// modify the title</span><span class="w"></span> +<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">newTitle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'New Title'</span><span class="p">;</span><span class="w"></span> +<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">title</span><span class="p">(</span><span class="nx">newTitle</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a> +<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="c1">// Reset the title to default</span><span class="w"></span> +<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">title</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h3 id="column"><code>column()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>column()</code> method is used to get the column data of a particular column. It takes the column name or the index as an argument. It can also take an array of column names or indexes as an argument to get multiple columns.</p> +<p>The <code>column()</code> method returns a new frame with extracted column data as the data of the frame. You can chain other frame methods on the returned frame.</p> +<h4 id="get-a-single-column">Get a single column</h4> +<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1">// get a single column on Index 2 (Index starts from 0)</span><span class="w"></span> +<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">column</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">column</span><span class="p">(</span><span class="mf">2</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> +<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="c1">// Alternatively, you can use the column name</span><span class="w"></span> +<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="kd">const</span><span class="w"> </span><span class="nx">column</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">column</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a> +<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="c1">// print the column</span><span class="w"></span> +<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="nx">column</span><span class="p">.</span><span class="nx">show</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h4 id="get-multiple-columns">Get multiple columns</h4> +<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1">// get multiple columns on Index 2 and 3 (Index starts from 0)</span><span class="w"></span> +<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">columns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">column</span><span class="p">([</span><span class="mf">2</span><span class="p">,</span><span class="w"> </span><span class="mf">3</span><span class="p">]);</span><span class="w"></span> +<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a> +<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="c1">// Alternatively, you can use the column names</span><span class="w"></span> +<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="kd">const</span><span class="w"> </span><span class="nx">columns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">column</span><span class="p">([</span><span class="s1">'Name'</span><span class="p">,</span><span class="w"> </span><span class="s1">'Age'</span><span class="p">]);</span><span class="w"></span> +<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a> +<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="c1">// print the columns</span><span class="w"></span> +<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="nx">columns</span><span class="p">.</span><span class="nx">show</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h3 id="row"><code>row()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>row()</code> method is used to get the row data of a particular row. It takes the row index as an argument. It can also take an array of row indexes as an argument to get multiple rows.</p> +<p>The <code>row()</code> method returns a new frame with extracted row data as the data of the frame. You can chain other frame methods on the returned frame.</p> +<h4 id="get-a-single-row">Get a single row</h4> +<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1">// get a single row on Index 2 (Index starts from 0)</span><span class="w"></span> +<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">row</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">row</span><span class="p">(</span><span class="mf">2</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a> +<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1">// print the row</span><span class="w"></span> +<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="nx">row</span><span class="p">.</span><span class="nx">show</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h4 id="get-multiple-rows">Get multiple rows</h4> +<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1">// get multiple rows on Index 2 and 3 (Index starts from 0)</span><span class="w"></span> +<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">rows</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">row</span><span class="p">([</span><span class="mf">2</span><span class="p">,</span><span class="w"> </span><span class="mf">3</span><span class="p">]);</span><span class="w"></span> +<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a> +<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1">// print the rows</span><span class="w"></span> +<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="nx">rows</span><span class="p">.</span><span class="nx">show</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h3 id="fromjson"><code>fromJSON()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>fromJSON()</code> method is used to create a frame from a JSON object. It takes the JSON object as an argument. <code>fromJSON()</code> method returns a new frame. You can chain other frame methods on the returned frame.</p> +<blockquote> +<p><strong>Note:</strong> The <code>fromJSON()</code> method does not take nested JSON objects as an argument. If you have a nested JSON object, flatten it using the <code>flattenJSON()</code> helper function first.</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="kd">const</span><span class="w"> </span><span class="nx">json</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[{...},</span><span class="w"> </span><span class="p">{...},</span><span class="w"> </span><span class="p">...];</span><span class="w"></span> +<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Frame</span><span class="p">().</span><span class="nx">fromJSON</span><span class="p">(</span><span class="nx">json</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a> +<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="c1">// ...continue with other frame methods</span><span class="w"></span> +</code></pre></div> +<h3 id="fromcsv"><code>fromCSV()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>fromCSV()</code> method is used to create a frame from a CSV string. It takes the CSV string as an argument. <code>fromCSV()</code> method returns a new frame. You can chain other frame methods on the returned frame.</p> +<blockquote> +<p><strong>Note:</strong> The <code>fromCSV()</code> automatically assigns the column names from the first row of the CSV string. If you do not want to use the column names, you can use the <code>header()</code> method to assign the column names first.</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="kd">const</span><span class="w"> </span><span class="nx">path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">require</span><span class="p">(</span><span class="s1">'path'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">csvPath</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">__dirname</span><span class="p">,</span><span class="w"> </span><span class="s1">'data.csv'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a> +<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="c1">// Sets the column names from the first row of the CSV</span><span class="w"></span> +<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="kd">const</span><span class="w"> </span><span class="nx">frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Frame</span><span class="p">().</span><span class="nx">fromCSV</span><span class="p">(</span><span class="nx">csvPath</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a> +<a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a><span class="c1">// Define the column names manually</span><span class="w"></span> +<a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a><span class="kd">const</span><span class="w"> </span><span class="nx">headers</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[...];</span><span class="w"></span> +<a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a> +<a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a><span class="c1">// Set the header first (important) then read the CSV</span><span class="w"></span> +<a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a><span class="kd">const</span><span class="w"> </span><span class="nx">frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Frame</span><span class="p">().</span><span class="nx">header</span><span class="p">(</span><span class="nx">headers</span><span class="p">).</span><span class="nx">fromCSV</span><span class="p">(</span><span class="nx">csvPath</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="find"><code>find()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>find()</code> method is used to find the rows that match the given condition. It takes a string or a number as an argument which is needed to be found in the frame. Optionally, it also takes an <code>options</code> object as as the second argument.</p> +<p>The valid options are defined below:</p> +<ul> +<li><code>row</code>: The row index to seach in. Can also be an array of row indexes.</li> +<li><code>column</code>: The column name or index to search in. Can also be an array of column names or indexes.</li> +<li><code>strict</code>: If <code>true</code>, the search will be performed on the exact value. If <code>false</code>, the search will be performed on the value as a substring. Default is <code>false</code>.</li> +</ul> +<blockquote> +<p><strong>Hint</strong>: You can also combine the <code>range()</code> helper method to pass a range of rows or columns.</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="c1">// find all the rows with value 'John' in column 'Name'</span><span class="w"></span> +<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="kd">const</span><span class="w"> </span><span class="nx">row</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="s1">'John'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="nx">column</span><span class="o">:</span><span class="w"> </span><span class="s1">'Name'</span><span class="p">});</span><span class="w"></span> +<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a> +<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="c1">// find all the rows with value 'John' in columns 0, 1 and 2. Perform a strict search</span><span class="w"></span> +<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="kd">const</span><span class="w"> </span><span class="nx">row</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="s1">'John'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="nx">column</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="mf">0</span><span class="p">,</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span><span class="w"> </span><span class="mf">2</span><span class="p">],</span><span class="w"> </span><span class="nx">strict</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">});</span><span class="w"></span> +<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a> +<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="c1">// find all the rows with value 'John' in columns 0, 1 and 2 and rows 3, 4 and 5.</span><span class="w"></span> +<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="c1">// Perform a non-strict search</span><span class="w"></span> +<a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="kd">const</span><span class="w"> </span><span class="nx">row</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">frame</span><span class="p">.</span><span class="nx">find</span><span class="p">(</span><span class="s1">'John'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="nx">column</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="mf">0</span><span class="p">,</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span><span class="w"> </span><span class="mf">2</span><span class="p">],</span><span class="w"> </span><span class="nx">row</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="mf">3</span><span class="p">,</span><span class="w"> </span><span class="mf">4</span><span class="p">,</span><span class="w"> </span><span class="mf">5</span><span class="p">],</span><span class="w"> </span><span class="nx">strict</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span><span class="p">});</span><span class="w"></span> +</code></pre></div> +<h3 id="sort"><code>sort()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>sort()</code> method is used to sort the rows in the frame. It takes the column name or the index as an argument. It also takes an optional <code>ascending</code> or <code>descending</code> argument to sort the rows in ascending or descending order. Default is <code>ascending</code>.</p> +<blockquote> +<p><strong>Note</strong>: <code>sort()</code> method permanently modifies the frame. You can chain other frame methods on the returned frame.</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="c1">// sort the rows in the frame with column 'Name' </span><span class="w"></span> +<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">sort</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a> +<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="c1">// sort the rows in the frame with column 'Name' in descending order</span><span class="w"></span> +<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">sort</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span><span class="w"> </span><span class="s1">'descending'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a> +<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="c1">// sort the rows in the frame with column index 0 in ascending order</span><span class="w"></span> +<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">sort</span><span class="p">(</span><span class="mf">0</span><span class="p">,</span><span class="w"> </span><span class="s1">'ascending'</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="removeduplicates"><code>removeDuplicates()</code> <img alt="" src="https://img.shields.io/badge/chainable-green.svg?style=plastic" /></h3> +<p>The <code>removeDuplicates()</code> method is used to remove duplicate rows from the frame. It takes a <code>column</code> argument to remove duplicate rows based on the value in the column.</p> +<ul> +<li><code>column</code>: The column name or index to remove duplicate rows based on the value in the column.</li> +</ul> +<blockquote> +<p><strong>Note</strong>: <code>removeDuplicates()</code> permanently modifies the frame. You can chain other frame methods on the returned frame.</p> +</blockquote> +<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="c1">// remove duplicate rows based on the value in column 'Name'</span><span class="w"></span> +<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">removeDuplicates</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a> +<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="c1">// remove duplicate rows based on the value in column index 0</span><span class="w"></span> +<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">removeDuplicates</span><span class="p">(</span><span class="mf">0</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="head"><code>head()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>head()</code> method is used to get the first <code>n</code> rows of the frame. It takes the number of rows as an argument. If no argument is passed, it will return the first 5 rows. If the argument is greater than the number of rows in the frame, it will return the entire frame.</p> +<p><code>head()</code> is a print method and it does not return a new frame and therefore it is not chainable.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="c1">// get the first 5 rows</span><span class="w"></span> +<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">head</span><span class="p">();</span><span class="w"></span> +<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a> +<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="c1">// get the first 10 rows</span><span class="w"></span> +<a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">head</span><span class="p">(</span><span class="mf">10</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="tail"><code>tail()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>tail()</code> method is used to get the last <code>n</code> rows of the frame. It takes the number of rows as an argument. If no argument is passed, it will return the last 5 rows. If the argument is greater than the number of rows in the frame, it will return the entire frame.</p> +<p><code>tail()</code> is a print method and it does not return a new frame and therefore it is not chainable.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="c1">// get the last 5 rows</span><span class="w"></span> +<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">tail</span><span class="p">();</span><span class="w"></span> +<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a> +<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="c1">// get the last 10 rows</span><span class="w"></span> +<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">tail</span><span class="p">(</span><span class="mf">10</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="show"><code>show()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>show()</code> method is used to print the frame. It takes no argument.</p> +<p><code>show()</code> is a print method and it does not return a new frame and therefore it is not chainable.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="c1">// print the frame</span><span class="w"></span> +<a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">show</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h3 id="showall"><code>showAll()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>showAll()</code> method is used to print the frame with all the rows. It takes no argument.</p> +<p><code>showAll()</code> is a print method and it does not return a new frame and therefore it is not chainable.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="c1">// print the frame with all the rows</span><span class="w"></span> +<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">showAll</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<h3 id="info"><code>info()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>info()</code> method is used to print the frame information. It takes no argument.</p> +<p><code>info()</code> is a print method and it does not return a new frame and therefore it is not chainable.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="c1">// print the frame information</span><span class="w"></span> +<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">info</span><span class="p">();</span><span class="w"></span> +</code></pre></div> +<p>If you run the <code>info()</code> method on the frame with <a href="https://github.com/luciferreeves/izuku.js/wiki/Getting-Started">data defined in the Getting Started Section</a>, it will print the following information:</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>RangeIndex: 35 elements, 0 to 34 +<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>Shape: 9 rows, 4 columns +<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>╔═══╤═════════════╤══════════════════╤══════════════╗ +<a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>║ # │ Column Name │ Types │ Empty Values ║ +<a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a>╟───┼─────────────┼──────────────────┼──────────────╢ +<a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>║ 0 │ Name │ string │ false ║ +<a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a>╟───┼─────────────┼──────────────────┼──────────────╢ +<a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a>║ 1 │ Age │ number,object │ true ║ +<a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a>╟───┼─────────────┼──────────────────┼──────────────╢ +<a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a>║ 2 │ Gender │ string │ false ║ +<a id="__codelineno-17-11" name="__codelineno-17-11" href="#__codelineno-17-11"></a>╟───┼─────────────┼──────────────────┼──────────────╢ +<a id="__codelineno-17-12" name="__codelineno-17-12" href="#__codelineno-17-12"></a>║ 3 │ Country │ string,undefined │ true ║ +<a id="__codelineno-17-13" name="__codelineno-17-13" href="#__codelineno-17-13"></a>╚═══╧═════════════╧══════════════════╧══════════════╝ +<a id="__codelineno-17-14" name="__codelineno-17-14" href="#__codelineno-17-14"></a>Data Types: string(26), number(8), object(1), undefined(1) +<a id="__codelineno-17-15" name="__codelineno-17-15" href="#__codelineno-17-15"></a>Memory Usage: 550 bytes +</code></pre></div> +<h3 id="rangeindex"><code>rangeIndex()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>rangeIndex()</code> method is used to get the element at a particular index if the complete data was flattened. It takes an index as an argument. Index is zero-based.</p> +<p><code>rangeIndex()</code> does not return a new frame and therefore it is not chainable. It returns the element at the index and therefore a <code>console.log</code> is required to print the element.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="c1">// get the element at index 2</span><span class="w"></span> +<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">frame</span><span class="p">.</span><span class="nx">rangeIndex</span><span class="p">(</span><span class="mf">2</span><span class="p">));</span><span class="w"></span> +</code></pre></div> +<p>There are some helper methods which will make your workflow easier. Take a look at the <a href="../helper-methods">Helper Methods</a> section.</p> +<h3 id="tojson"><code>toJSON()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>toJSON()</code> method is used to convert the frame to a JSON file. It takes an optional path as an argument. If no argument is passed, it will save the JSON file in the current directory. It also takes an optional file name as an argument. If no argument is passed, it will save the JSON file with the name <code>data.json</code>.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="c1">// save the frame as a JSON file</span><span class="w"></span> +<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">toJSON</span><span class="p">();</span><span class="w"></span> +<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a> +<a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a><span class="c1">// save the frame as a JSON file with the name 'frame.json' in the current directory</span><span class="w"></span> +<a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">toJSON</span><span class="p">(</span><span class="kc">undefined</span><span class="p">,</span><span class="w"> </span><span class="s1">'frame.json'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a> +<a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a><span class="c1">// save the frame as a JSON file with the name 'data.json' in the directory './data'</span><span class="w"></span> +<a id="__codelineno-19-8" name="__codelineno-19-8" href="#__codelineno-19-8"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">toJSON</span><span class="p">(</span><span class="s1">'./data'</span><span class="p">,</span><span class="w"> </span><span class="s1">'data.json'</span><span class="p">);</span><span class="w"></span> +</code></pre></div> +<h3 id="tocsv"><code>toCSV()</code> <img alt="" src="https://img.shields.io/badge/not%20chainable-red.svg?style=plastic" /></h3> +<p>The <code>toCSV()</code> method is used to convert the frame to a CSV file. It takes an optional path as an argument. If no argument is passed, it will save the CSV file in the current directory. It also takes an optional file name as an argument. If no argument is passed, it will save the CSV file with the name <code>data.csv</code>.</p> +<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="c1">// save the frame as a CSV file</span><span class="w"></span> +<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">toCSV</span><span class="p">();</span><span class="w"></span> +<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a> +<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="c1">// save the frame as a CSV file with the name 'frame.csv' in the current directory</span><span class="w"></span> +<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">toCSV</span><span class="p">(</span><span class="kc">undefined</span><span class="p">,</span><span class="w"> </span><span class="s1">'frame.csv'</span><span class="p">);</span><span class="w"></span> +<a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-6"></a> +<a id="__codelineno-20-7" name="__codelineno-20-7" href="#__codelineno-20-7"></a><span class="c1">// save the frame as a CSV file with the name 'data.csv' in the directory './data'</span><span class="w"></span> +<a id="__codelineno-20-8" name="__codelineno-20-8" href="#__codelineno-20-8"></a><span class="nx">frame</span><span class="p">.</span><span class="nx">toCSV</span><span class="p">(</span><span class="s1">'./data'</span><span class="p">,</span><span class="w"> </span><span class="s1">'data.csv'</span><span class="p">);</span><span class="w"></span> +</code></pre></div> + + + </article> + + </div> + </div> + + <a href="#" class="md-top md-icon" data-md-component="top" hidden> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> + Back to top + </a> + + </main> + + <footer class="md-footer"> + + + <nav class="md-footer__inner md-grid" aria-label="Footer" > + + + <a href="../frame-properties/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Frame Properties" rel="prev"> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </div> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Previous + </span> + Frame Properties + </div> + </div> + </a> + + + + <a href="../helper-methods/" class="md-footer__link md-footer__link--next" aria-label="Next: Helper Methods" rel="next"> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Next + </span> + Helper Methods + </div> + </div> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> + </div> + </a> + + </nav> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-copyright"> + + <div class="md-copyright__highlight"> + Copyright © 2022 Izuku. Licensed under the MIT License. + </div> + + +</div> + + </div> + </div> +</footer> + + </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> + <script id="__config" type="application/json">{"base": "..", "features": ["navigation.expand", "navigation.top", "toc.integrate"], "search": "../assets/javascripts/workers/search.b97dbffb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + + + <script src="../assets/javascripts/bundle.6c7ad80a.min.js"></script> + + + </body> +</html>
\ No newline at end of file |