ノートブックフロントエンドの設定

注釈

ノートブックのフロントエンドのUIと環境設定を構成する機能はまだ進行中です。

このドキュメントでは、ノートブックJavascriptの設定オプションを保持する方法について簡単に説明します。

ほとんどのオプションが他のライブラリに渡されるので、すべての設定オプションの網羅的なリストではありません。つまり、有効でない設定はエラーメッセージ無しで無視できます。

フロントエンドの設定方法

フロントエンド設定システムは次のように動作します:

• 設定可能なJavaScriptオブジェクトのハンドルを取得します。
• その構成属性にアクセスします。
• その構成属性をJSONパッチで更新します。

例 - ノートブックのデフォルトのインデントを変更する

この例では、CodeMirrorコードセルのデフォルト設定 indentUnit を変更する方法について説明します:

var cell = Jupyter.notebook.get_selected_cell();
var config = cell.config;
var patch = {
      CodeCell:{
        cm_config:{indentUnit:2}
      }
    }
config.update(patch)

以前のスニペットをブラウザのJavaScriptコンソールに一度入力することができます。ここで、好ましいインデント単位は2つのスペースと等しくなければなりません。カスタム設定が維持され、新しいノートブックにパッチを再発行する必要はありません。

この例で使用される indentUnit は、設定に使用できる多くの CodeMirror options オプションの一つです。

例 - ノートブックのデフォルトインデントを復元する

ノートブックフロントエンドのプリファレンスをデフォルト値に戻したい場合は、プリフェレンス設定の null 値のJSONパッチを入力します。

例えば、インデント設定 indentUnit をデフォルトの4つのスペースに戻してみましょう。JavaScriptコンソールに次のコードスニペットを入力します:

var cell = Jupyter.notebook.get_selected_cell();
var config = cell.config;
var patch = {
      CodeCell:{
        cm_config:{indentUnit: null} // only change here.
      }
    }
config.update(patch)

ブラウザでノートブックをリロードすると、デフォルトのインデントは再び2つのスペースになります。

構成設定を維持する

Under the hood, Jupyter will persist the preferred configuration settings in ~/.jupyter/nbconfig/<section>.json, with <section> taking various value depending on the page where the configuration is issued. <section> can take various values like notebook, tree, and editor. A common section contains configuration settings shared by all pages.