[{"data":1,"prerenderedAt":2714},["ShallowReactive",2],{"navigation_docs":3,"-pybrowzarr-api-reference":159,"-pybrowzarr-api-reference-surround":2709},[4,25,60,85,120,135],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting Started",false,"\u002Fgetting-started","1.getting-started",[10,15,20],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction","i-lucide-soup",{"title":16,"path":17,"stem":18,"icon":19},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation","i-lucide-download",{"title":21,"path":22,"stem":23,"icon":24},"Crash Course","\u002Fgetting-started\u002Flanding","1.getting-started\u002F3.landing","i-lucide-plane-landing",{"title":26,"path":27,"stem":28,"children":29,"page":6},"Menus","\u002Fmenus","2.Menus",[30,35,40,45,50,55],{"title":31,"path":32,"stem":33,"icon":34},"Dataset loading","\u002Fmenus\u002Fdataset-loading","2.Menus\u002F1.dataset-loading","i-lucide-database",{"title":36,"path":37,"stem":38,"icon":39},"Variable selection","\u002Fmenus\u002Fvariable-selection","2.Menus\u002F2.variable-selection","i-lucide-variable",{"title":41,"path":42,"stem":43,"icon":44},"Plot types","\u002Fmenus\u002Fplot-types","2.Menus\u002F3.plot-types","i-lucide-chart-scatter",{"title":46,"path":47,"stem":48,"icon":49},"Colorbar","\u002Fmenus\u002Fcolorbar","2.Menus\u002F4.colorbar","i-lucide-paint-bucket",{"title":51,"path":52,"stem":53,"icon":54},"Plot settings","\u002Fmenus\u002Fplot-settings","2.Menus\u002F5.plot-settings","i-heroicons-adjustments-horizontal",{"title":56,"path":57,"stem":58,"icon":59},"Analytics","\u002Fmenus\u002Fanalytics","2.Menus\u002F6.analytics","i-ph-math-operations-bold",{"title":61,"icon":6,"path":62,"stem":63,"children":64,"page":6},"Guides","\u002Fguides","3.guides",[65,70,75,80],{"title":66,"path":67,"stem":68,"icon":69},"Remote data","\u002Fguides\u002Fremote-data","3.guides\u002F1.remote-data","i-lucide-cloud",{"title":71,"path":72,"stem":73,"icon":74},"Local data","\u002Fguides\u002Flocal-data","3.guides\u002F2.local-data","i-lucide-hard-drive",{"title":76,"path":77,"stem":78,"icon":79},"Bivariate colormaps","\u002Fguides\u002Fbivariate-colormaps","3.guides\u002F3.bivariate-colormaps","i-lucide-palette",{"title":81,"path":82,"stem":83,"icon":84},"Animation and export","\u002Fguides\u002Fanimation-and-export","3.guides\u002F4.animation-and-export","i-lucide-image",{"title":86,"icon":6,"path":87,"stem":88,"children":89,"page":6},"pyBrowzarr","\u002Fpybrowzarr","4.pyBrowzarr",[90,95,100,105,110,115],{"title":91,"path":92,"stem":93,"icon":94},"Overview","\u002Fpybrowzarr\u002Foverview","4.pyBrowzarr\u002F1.overview","i-lucide-terminal",{"title":96,"path":97,"stem":98,"icon":99},"Quickstart","\u002Fpybrowzarr\u002Fquickstart","4.pyBrowzarr\u002F2.quickstart","i-lucide-rocket",{"title":101,"path":102,"stem":103,"icon":104},"Export & Animation","\u002Fpybrowzarr\u002Fexport","4.pyBrowzarr\u002F4.export","i-lucide-clapperboard",{"title":106,"path":107,"stem":108,"icon":109},"Environments","\u002Fpybrowzarr\u002Fenvironment","4.pyBrowzarr\u002F5.environment","i-lucide-monitor",{"title":111,"path":112,"stem":113,"icon":114},"Build & Update","\u002Fpybrowzarr\u002Fbuild-and-update","4.pyBrowzarr\u002F6.build-and-update","i-lucide-refresh-cw",{"title":116,"path":117,"stem":118,"icon":119},"API Reference","\u002Fpybrowzarr\u002Fapi-reference","4.pyBrowzarr\u002F7.api-reference","i-lucide-book-open",{"title":121,"icon":6,"path":122,"stem":123,"children":124,"page":6},"Community","\u002Fcommunity","5.community",[125,130],{"title":126,"path":127,"stem":128,"icon":129},"Contributing","\u002Fcommunity\u002Fcontributing","5.community\u002F1.contributing","i-lucide-git-pull-request-arrow",{"title":131,"path":132,"stem":133,"icon":134},"About","\u002Fcommunity\u002Fabout","5.community\u002F2.about","i-lucide-badge-info",{"title":136,"icon":6,"path":137,"stem":138,"children":139,"page":6},"Reference","\u002Freference","6.reference",[140,145,149,154],{"title":141,"path":142,"stem":143,"icon":144},"Supported formats","\u002Freference\u002Fsupported-formats","6.reference\u002F2.supported-formats","i-lucide-file-box",{"title":146,"path":147,"stem":148,"icon":109},"Browser support","\u002Freference\u002Fbrowser-support","6.reference\u002F3.browser-support",{"title":150,"path":151,"stem":152,"icon":153},"Troubleshooting","\u002Freference\u002Ftroubleshooting","6.reference\u002F4.troubleshooting","i-lucide-wrench",{"title":155,"path":156,"stem":157,"icon":158},"FAQ","\u002Freference\u002Ffaq","6.reference\u002F5.faq","i-lucide-message-circle-question",{"id":160,"title":116,"body":161,"description":2702,"extension":2703,"links":2704,"meta":2705,"navigation":2706,"path":117,"seo":2707,"stem":118,"__hash__":2708},"docs\u002F4.pyBrowzarr\u002F7.api-reference.md",{"type":162,"value":163,"toc":2679},"minimark",[164,173,178,223,303,307,317,322,430,433,439,516,521,525,532,620,634,713,717,758,768,866,872,968,971,1064,1074,1157,1163,1166,1169,1173,1190,1726,1735,1845,1847,1853,1954,1962,2063,2065,2070,2142,2149,2237,2241,2244,2341,2351,2360,2431,2437,2471,2475,2481,2490,2493,2531,2535,2540,2543,2569,2582,2609,2612,2617,2623,2649,2654,2658,2664,2675],[165,166,167,168,172],"p",{},"This page documents the public, user-facing API. Everything lives under the ",[169,170,171],"code",{},"browzarr","\npackage.",[174,175,177],"h2",{"id":176},"exports","Exports",[179,180,185],"pre",{"className":181,"code":182,"language":183,"meta":184,"style":184},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","from browzarr import Browzarr, build_browzarr, update_browzarr, main\n","python","",[169,186,187],{"__ignoreMap":184},[188,189,192,196,200,203,206,210,213,215,218,220],"span",{"class":190,"line":191},"line",1,[188,193,195],{"class":194},"s7zQu","from",[188,197,199],{"class":198},"sTEyZ"," browzarr ",[188,201,202],{"class":194},"import",[188,204,205],{"class":198}," Browzarr",[188,207,209],{"class":208},"sMK4o",",",[188,211,212],{"class":198}," build_browzarr",[188,214,209],{"class":208},[188,216,217],{"class":198}," update_browzarr",[188,219,209],{"class":208},[188,221,222],{"class":198}," main\n",[224,225,226,242],"table",{},[227,228,229],"thead",{},[230,231,232,236,239],"tr",{},[233,234,235],"th",{},"Name",[233,237,238],{},"Kind",[233,240,241],{},"Purpose",[243,244,245,259,272,288],"tbody",{},[230,246,247,253,256],{},[248,249,250],"td",{},[169,251,252],{},"Browzarr",[248,254,255],{},"class",[248,257,258],{},"The user-facing configuration object.",[230,260,261,266,269],{},[248,262,263],{},[169,264,265],{},"build_browzarr()",[248,267,268],{},"function",[248,270,271],{},"Rebuild the bundled frontend from the upstream source.",[230,273,274,279,281],{},[248,275,276],{},[169,277,278],{},"update_browzarr()",[248,280,268],{},[248,282,283,284,287],{},"Update the bundled frontend from the prebuilt ",[169,285,286],{},"python-dist"," branch.",[230,289,290,295,297],{},[248,291,292],{},[169,293,294],{},"main()",[248,296,268],{},[248,298,299,300,302],{},"Command-line entry point (",[169,301,171],{}," launcher).",[174,304,305],{"id":171},[169,306,252],{},[165,308,309,310,312,313,316],{},"A ",[169,311,252],{}," object holds the configuration for a single visualization. Set attributes\nor pass them as keyword arguments, chain a plot type, then call ",[169,314,315],{},".plot()",".",[318,319,321],"h3",{"id":320},"constructor","Constructor",[179,323,325],{"className":181,"code":324,"language":183,"meta":184,"style":184},"Browzarr(\n    dataset,                       # str, required\n    variable,                      # str, required\n    x_slice=(0, None),             # tuple[int, int | None]\n    y_slice=(0, None),             # tuple[int, int | None]\n    z_slice=(0, None),             # tuple[int, int | None]\n    extra_params={},               # dict[str, Any]\n)\n",[169,326,327,335,347,358,380,396,412,424],{"__ignoreMap":184},[188,328,329,332],{"class":190,"line":191},[188,330,252],{"class":331},"s2Zo4",[188,333,334],{"class":208},"(\n",[188,336,338,341,343],{"class":190,"line":337},2,[188,339,340],{"class":331},"    dataset",[188,342,209],{"class":208},[188,344,346],{"class":345},"sHwdD","                       # str, required\n",[188,348,350,353,355],{"class":190,"line":349},3,[188,351,352],{"class":331},"    variable",[188,354,209],{"class":208},[188,356,357],{"class":345},"                      # str, required\n",[188,359,361,365,368,372,374,377],{"class":190,"line":360},4,[188,362,364],{"class":363},"sHdIc","    x_slice",[188,366,367],{"class":208},"=(",[188,369,371],{"class":370},"sbssI","0",[188,373,209],{"class":208},[188,375,376],{"class":208}," None),",[188,378,379],{"class":345},"             # tuple[int, int | None]\n",[188,381,383,386,388,390,392,394],{"class":190,"line":382},5,[188,384,385],{"class":363},"    y_slice",[188,387,367],{"class":208},[188,389,371],{"class":370},[188,391,209],{"class":208},[188,393,376],{"class":208},[188,395,379],{"class":345},[188,397,399,402,404,406,408,410],{"class":190,"line":398},6,[188,400,401],{"class":363},"    z_slice",[188,403,367],{"class":208},[188,405,371],{"class":370},[188,407,209],{"class":208},[188,409,376],{"class":208},[188,411,379],{"class":345},[188,413,415,418,421],{"class":190,"line":414},7,[188,416,417],{"class":363},"    extra_params",[188,419,420],{"class":208},"={},",[188,422,423],{"class":345},"               # dict[str, Any]\n",[188,425,427],{"class":190,"line":426},8,[188,428,429],{"class":208},")\n",[165,431,432],{},"All fields are also accessible as attributes after construction.",[165,434,435,438],{},[169,436,437],{},"extra_params"," is a catch-all dictionary that gets merged into the final plot state.\nUse it to pass any option not explicitly modeled — keys are camel-cased automatically.",[179,440,442],{"className":181,"code":441,"language":183,"meta":184,"style":184},"bz = Browzarr(dataset=\"gs:\u002F\u002Fstore\", variable=\"temp\")\nbz.extra_params[\"myCustomOption\"] = True\n",[169,443,444,487],{"__ignoreMap":184},[188,445,446,449,452,454,457,460,462,465,469,471,473,476,478,480,483,485],{"class":190,"line":191},[188,447,448],{"class":198},"bz ",[188,450,451],{"class":208},"=",[188,453,205],{"class":331},[188,455,456],{"class":208},"(",[188,458,459],{"class":363},"dataset",[188,461,451],{"class":208},[188,463,464],{"class":208},"\"",[188,466,468],{"class":467},"sfazB","gs:\u002F\u002Fstore",[188,470,464],{"class":208},[188,472,209],{"class":208},[188,474,475],{"class":363}," variable",[188,477,451],{"class":208},[188,479,464],{"class":208},[188,481,482],{"class":467},"temp",[188,484,464],{"class":208},[188,486,429],{"class":208},[188,488,489,492,494,497,500,502,505,507,510,513],{"class":190,"line":337},[188,490,491],{"class":198},"bz",[188,493,316],{"class":208},[188,495,437],{"class":496},"swJcz",[188,498,499],{"class":208},"[",[188,501,464],{"class":208},[188,503,504],{"class":467},"myCustomOption",[188,506,464],{"class":208},[188,508,509],{"class":208},"]",[188,511,512],{"class":208}," =",[188,514,515],{"class":208}," True\n",[517,518,520],"callout",{"icon":519},"i-lucide-shield-alert","There is no keyword validation — any unexpected keyword on a plot method is silently\nserialized rather than raising. Be careful with typos.",[318,522,524],{"id":523},"plot-methods","Plot methods",[165,526,527,528,531],{},"Each of these records the plot configuration and returns ",[169,529,530],{},"self",", so calls can be chained\nor stored.",[179,533,535],{"className":181,"code":534,"language":183,"meta":184,"style":184},"def volume(**kwargs) -> Browzarr   # 3D volume render\ndef points(**kwargs) -> Browzarr   # point cloud\ndef flat(**kwargs)   -> Browzarr   # flat surface (can be displaced)\ndef sphere(**kwargs) -> Browzarr   # globe\u002Fsphere\n",[169,536,537,564,583,602],{"__ignoreMap":184},[188,538,539,543,546,549,552,555,558,561],{"class":190,"line":191},[188,540,542],{"class":541},"spNyl","def",[188,544,545],{"class":331}," volume",[188,547,548],{"class":208},"(**",[188,550,551],{"class":363},"kwargs",[188,553,554],{"class":208},")",[188,556,557],{"class":208}," ->",[188,559,560],{"class":198}," Browzarr   ",[188,562,563],{"class":345},"# 3D volume render\n",[188,565,566,568,571,573,575,577,580],{"class":190,"line":337},[188,567,542],{"class":194},[188,569,570],{"class":331}," points",[188,572,548],{"class":208},[188,574,551],{"class":331},[188,576,554],{"class":208},[188,578,579],{"class":198}," -> Browzarr   ",[188,581,582],{"class":345},"# point cloud\n",[188,584,585,587,590,592,594,596,599],{"class":190,"line":349},[188,586,542],{"class":194},[188,588,589],{"class":331}," flat",[188,591,548],{"class":208},[188,593,551],{"class":331},[188,595,554],{"class":208},[188,597,598],{"class":198},"   -> Browzarr   ",[188,600,601],{"class":345},"# flat surface (can be displaced)\n",[188,603,604,606,609,611,613,615,617],{"class":190,"line":360},[188,605,542],{"class":194},[188,607,608],{"class":331}," sphere",[188,610,548],{"class":208},[188,612,551],{"class":331},[188,614,554],{"class":208},[188,616,579],{"class":198},[188,618,619],{"class":345},"# globe\u002Fsphere\n",[165,621,622,623,627,628,633],{},"Only the ",[624,625,626],"em",{},"last"," plot method called takes effect. See the ",[629,630,632],"a",{"href":631},"#common-options","common options","\nand the plot-type-specific sections below for the accepted keyword arguments.",[179,635,637],{"className":181,"code":636,"language":183,"meta":184,"style":184},"bz = Browzarr(dataset=\"gs:\u002F\u002Fstore\", variable=\"temp\")\nbz.volume(transparency=0.5).points(point_size=3)   # points() wins — last call\n",[169,638,639,673],{"__ignoreMap":184},[188,640,641,643,645,647,649,651,653,655,657,659,661,663,665,667,669,671],{"class":190,"line":191},[188,642,448],{"class":198},[188,644,451],{"class":208},[188,646,205],{"class":331},[188,648,456],{"class":208},[188,650,459],{"class":363},[188,652,451],{"class":208},[188,654,464],{"class":208},[188,656,468],{"class":467},[188,658,464],{"class":208},[188,660,209],{"class":208},[188,662,475],{"class":363},[188,664,451],{"class":208},[188,666,464],{"class":208},[188,668,482],{"class":467},[188,670,464],{"class":208},[188,672,429],{"class":208},[188,674,675,677,679,682,684,687,689,692,695,698,700,703,705,708,710],{"class":190,"line":337},[188,676,491],{"class":198},[188,678,316],{"class":208},[188,680,681],{"class":331},"volume",[188,683,456],{"class":208},[188,685,686],{"class":363},"transparency",[188,688,451],{"class":208},[188,690,691],{"class":370},"0.5",[188,693,694],{"class":208},").",[188,696,697],{"class":331},"points",[188,699,456],{"class":208},[188,701,702],{"class":363},"point_size",[188,704,451],{"class":208},[188,706,707],{"class":370},"3",[188,709,554],{"class":208},[188,711,712],{"class":345},"   # points() wins — last call\n",[318,714,716],{"id":715},"export-method","Export method",[179,718,720],{"className":181,"code":719,"language":183,"meta":184,"style":184},"def export(open_browser: bool = True, **kwargs) -> Browzarr\n",[169,721,722],{"__ignoreMap":184},[188,723,724,726,729,731,734,737,741,743,746,749,751,753,755],{"class":190,"line":191},[188,725,542],{"class":541},[188,727,728],{"class":331}," export",[188,730,456],{"class":208},[188,732,733],{"class":363},"open_browser",[188,735,736],{"class":208},":",[188,738,740],{"class":739},"sBMFI"," bool",[188,742,512],{"class":208},[188,744,745],{"class":208}," True,",[188,747,748],{"class":208}," **",[188,750,551],{"class":363},[188,752,554],{"class":208},[188,754,557],{"class":208},[188,756,757],{"class":198}," Browzarr\n",[165,759,760,761,763,764,767],{},"Configures an export (with optional animation) and immediately launches the plot by\ncalling ",[169,762,315],{},". See ",[629,765,101],{"href":766},"\u002FpyBrowzarr\u002Fexport"," for the accepted keyword\narguments.",[179,769,771],{"className":181,"code":770,"language":183,"meta":184,"style":184},"Browzarr(dataset=\"gs:\u002F\u002Fstore\", variable=\"temp\").volume().export(\n    main_title=\"My Map\",\n    animate=True,\n    frames=120,\n    frame_rate=30,\n)\n",[169,772,773,813,830,838,850,862],{"__ignoreMap":184},[188,774,775,777,779,781,783,785,787,789,791,793,795,797,799,801,803,805,808,811],{"class":190,"line":191},[188,776,252],{"class":331},[188,778,456],{"class":208},[188,780,459],{"class":363},[188,782,451],{"class":208},[188,784,464],{"class":208},[188,786,468],{"class":467},[188,788,464],{"class":208},[188,790,209],{"class":208},[188,792,475],{"class":363},[188,794,451],{"class":208},[188,796,464],{"class":208},[188,798,482],{"class":467},[188,800,464],{"class":208},[188,802,694],{"class":208},[188,804,681],{"class":331},[188,806,807],{"class":208},"().",[188,809,810],{"class":331},"export",[188,812,334],{"class":208},[188,814,815,818,820,822,825,827],{"class":190,"line":337},[188,816,817],{"class":363},"    main_title",[188,819,451],{"class":208},[188,821,464],{"class":208},[188,823,824],{"class":467},"My Map",[188,826,464],{"class":208},[188,828,829],{"class":208},",\n",[188,831,832,835],{"class":190,"line":349},[188,833,834],{"class":363},"    animate",[188,836,837],{"class":208},"=True,\n",[188,839,840,843,845,848],{"class":190,"line":360},[188,841,842],{"class":363},"    frames",[188,844,451],{"class":208},[188,846,847],{"class":370},"120",[188,849,829],{"class":208},[188,851,852,855,857,860],{"class":190,"line":382},[188,853,854],{"class":363},"    frame_rate",[188,856,451],{"class":208},[188,858,859],{"class":370},"30",[188,861,829],{"class":208},[188,863,864],{"class":190,"line":398},[188,865,429],{"class":208},[318,867,869],{"id":868},"plot",[169,870,871],{},"plot()",[179,873,875],{"className":181,"code":874,"language":183,"meta":184,"style":184},"def plot(\n    width=720,\n    height=720,\n    give_url: bool = False,\n    external_browser: bool = False,\n    wait: float = 0.3,\n) -> str | None\n",[169,876,877,886,898,909,923,936,953],{"__ignoreMap":184},[188,878,879,881,884],{"class":190,"line":191},[188,880,542],{"class":541},[188,882,883],{"class":331}," plot",[188,885,334],{"class":208},[188,887,888,891,893,896],{"class":190,"line":337},[188,889,890],{"class":363},"    width",[188,892,451],{"class":208},[188,894,895],{"class":370},"720",[188,897,829],{"class":208},[188,899,900,903,905,907],{"class":190,"line":349},[188,901,902],{"class":363},"    height",[188,904,451],{"class":208},[188,906,895],{"class":370},[188,908,829],{"class":208},[188,910,911,914,916,918,920],{"class":190,"line":360},[188,912,913],{"class":363},"    give_url",[188,915,736],{"class":208},[188,917,740],{"class":739},[188,919,512],{"class":208},[188,921,922],{"class":208}," False,\n",[188,924,925,928,930,932,934],{"class":190,"line":382},[188,926,927],{"class":363},"    external_browser",[188,929,736],{"class":208},[188,931,740],{"class":739},[188,933,512],{"class":208},[188,935,922],{"class":208},[188,937,938,941,943,946,948,951],{"class":190,"line":398},[188,939,940],{"class":363},"    wait",[188,942,736],{"class":208},[188,944,945],{"class":739}," float",[188,947,512],{"class":208},[188,949,950],{"class":370}," 0.3",[188,952,829],{"class":208},[188,954,955,957,959,962,965],{"class":190,"line":414},[188,956,554],{"class":208},[188,958,557],{"class":208},[188,960,961],{"class":739}," str",[188,963,964],{"class":208}," |",[188,966,967],{"class":208}," None\n",[165,969,970],{},"Launches (or reuses) the local Browzarr server and opens the view configured on this\nobject.",[224,972,973,986],{},[227,974,975],{},[230,976,977,980,983],{},[233,978,979],{},"Argument",[233,981,982],{},"Default",[233,984,985],{},"Description",[243,987,988,1002,1016,1035,1049],{},[230,989,990,995,999],{},[248,991,992],{},[169,993,994],{},"width",[248,996,997],{},[169,998,895],{},[248,1000,1001],{},"Iframe width in Jupyter\u002FColab.",[230,1003,1004,1009,1013],{},[248,1005,1006],{},[169,1007,1008],{},"height",[248,1010,1011],{},[169,1012,895],{},[248,1014,1015],{},"Iframe height in Jupyter\u002FColab.",[230,1017,1018,1023,1028],{},[248,1019,1020],{},[169,1021,1022],{},"give_url",[248,1024,1025],{},[169,1026,1027],{},"False",[248,1029,1030,1031,1034],{},"When ",[169,1032,1033],{},"True",", returns the hosted URL string instead of opening anything.",[230,1036,1037,1042,1046],{},[248,1038,1039],{},[169,1040,1041],{},"external_browser",[248,1043,1044],{},[169,1045,1027],{},[248,1047,1048],{},"Force opening in an external browser, bypassing environment detection.",[230,1050,1051,1056,1061],{},[248,1052,1053],{},[169,1054,1055],{},"wait",[248,1057,1058],{},[169,1059,1060],{},"0.3",[248,1062,1063],{},"Seconds to wait before opening, so the server is ready.",[165,1065,1066,1067,1070,1071,316],{},"Return value: the URL string when ",[169,1068,1069],{},"give_url=True",", otherwise ",[169,1072,1073],{},"None",[179,1075,1077],{"className":181,"code":1076,"language":183,"meta":184,"style":184},"bz.plot()\nbz.plot(give_url=True)          # -> \"https:\u002F\u002Fbrowzarr.io\u002Flatest\u002F?data=...\"\nbz.plot(width=900, height=600)  # larger iframe in notebooks\nbz.plot(external_browser=True)  # always open in the OS browser\n",[169,1078,1079,1090,1108,1140],{"__ignoreMap":184},[188,1080,1081,1083,1085,1087],{"class":190,"line":191},[188,1082,491],{"class":198},[188,1084,316],{"class":208},[188,1086,868],{"class":331},[188,1088,1089],{"class":208},"()\n",[188,1091,1092,1094,1096,1098,1100,1102,1105],{"class":190,"line":337},[188,1093,491],{"class":198},[188,1095,316],{"class":208},[188,1097,868],{"class":331},[188,1099,456],{"class":208},[188,1101,1022],{"class":363},[188,1103,1104],{"class":208},"=True)",[188,1106,1107],{"class":345},"          # -> \"https:\u002F\u002Fbrowzarr.io\u002Flatest\u002F?data=...\"\n",[188,1109,1110,1112,1114,1116,1118,1120,1122,1125,1127,1130,1132,1135,1137],{"class":190,"line":349},[188,1111,491],{"class":198},[188,1113,316],{"class":208},[188,1115,868],{"class":331},[188,1117,456],{"class":208},[188,1119,994],{"class":363},[188,1121,451],{"class":208},[188,1123,1124],{"class":370},"900",[188,1126,209],{"class":208},[188,1128,1129],{"class":363}," height",[188,1131,451],{"class":208},[188,1133,1134],{"class":370},"600",[188,1136,554],{"class":208},[188,1138,1139],{"class":345},"  # larger iframe in notebooks\n",[188,1141,1142,1144,1146,1148,1150,1152,1154],{"class":190,"line":360},[188,1143,491],{"class":198},[188,1145,316],{"class":208},[188,1147,868],{"class":331},[188,1149,456],{"class":208},[188,1151,1041],{"class":363},[188,1153,1104],{"class":208},[188,1155,1156],{"class":345},"  # always open in the OS browser\n",[165,1158,1159,1160,316],{},"Where the view opens is auto-detected. See ",[629,1161,106],{"href":1162},"\u002FpyBrowzarr\u002Fenvironment",[174,1164,41],{"id":1165},"plot-types",[165,1167,1168],{},"The four plot types below share a common set of options; each also accepts its own\ntype-specific keyword arguments. Unset options use their default values.",[318,1170,1172],{"id":1171},"common-options","Common options",[165,1174,1175,1176,1179,1180,1179,1183,1179,1186,1189],{},"Every plot method (",[169,1177,1178],{},"volume()",", ",[169,1181,1182],{},"points()",[169,1184,1185],{},"flat()",[169,1187,1188],{},"sphere()",") accepts the keyword\narguments below.",[224,1191,1192,1206],{},[227,1193,1194],{},[230,1195,1196,1199,1202,1204],{},[233,1197,1198],{},"Option",[233,1200,1201],{},"Type",[233,1203,982],{},[233,1205,985],{},[243,1207,1208,1234,1254,1275,1295,1315,1335,1367,1385,1409,1427,1445,1473,1492,1512,1531,1549,1567,1585,1603,1621,1649,1667,1690,1708],{},[230,1209,1210,1215,1220,1225],{},[248,1211,1212],{},[169,1213,1214],{},"colormap",[248,1216,1217],{},[169,1218,1219],{},"str",[248,1221,1222],{},[169,1223,1224],{},"\"Spectral\"",[248,1226,1227,1228,1179,1231,694],{},"Name of the colormap to use (e.g. ",[169,1229,1230],{},"\"turbo\"",[169,1232,1233],{},"\"inferno\"",[230,1235,1236,1241,1246,1251],{},[248,1237,1238],{},[169,1239,1240],{},"flip_colormap",[248,1242,1243],{},[169,1244,1245],{},"bool",[248,1247,1248],{},[169,1249,1250],{},"false",[248,1252,1253],{},"Reverse the colormap direction.",[230,1255,1256,1261,1265,1272],{},[248,1257,1258],{},[169,1259,1260],{},"bottom_left",[248,1262,1263],{},[169,1264,1219],{},[248,1266,1267],{},[1268,1269],"img",{"alt":1270,"src":1271},"#ffffff","https:\u002F\u002Fimg.shields.io\u002Fbadge\u002F-%23ffffff-ffffff?style=flat-square",[248,1273,1274],{},"Corner color of the bivariate colormap (bottom left).",[230,1276,1277,1282,1286,1292],{},[248,1278,1279],{},[169,1280,1281],{},"top_left",[248,1283,1284],{},[169,1285,1219],{},[248,1287,1288],{},[1268,1289],{"alt":1290,"src":1291},"#2a9d8f","https:\u002F\u002Fimg.shields.io\u002Fbadge\u002F-%232a9d8f-2a9d8f?style=flat-square",[248,1293,1294],{},"Corner color of the bivariate colormap (top left).",[230,1296,1297,1302,1306,1312],{},[248,1298,1299],{},[169,1300,1301],{},"bottom_right",[248,1303,1304],{},[169,1305,1219],{},[248,1307,1308],{},[1268,1309],{"alt":1310,"src":1311},"#e63946","https:\u002F\u002Fimg.shields.io\u002Fbadge\u002F-%23e63946-e63946?style=flat-square",[248,1313,1314],{},"Corner color of the bivariate colormap (bottom right).",[230,1316,1317,1322,1327,1332],{},[248,1318,1319],{},[169,1320,1321],{},"resolution",[248,1323,1324],{},[169,1325,1326],{},"int",[248,1328,1329],{},[169,1330,1331],{},"10",[248,1333,1334],{},"Resolution of the bivariate colormap texture grid.",[230,1336,1337,1342,1346,1351],{},[248,1338,1339],{},[169,1340,1341],{},"mix_mode",[248,1343,1344],{},[169,1345,1326],{},[248,1347,1348],{},[169,1349,1350],{},"2",[248,1352,1353,1354,1356,1357,1360,1361,1363,1364,1366],{},"Mixing mode of the colormap: ",[169,1355,371],{}," = darken, ",[169,1358,1359],{},"1"," = lighten, ",[169,1362,1350],{}," = multiply, ",[169,1365,707],{}," = difference",[230,1368,1369,1374,1378,1382],{},[248,1370,1371],{},[169,1372,1373],{},"bivariate_selection",[248,1375,1376],{},[169,1377,1326],{},[248,1379,1380],{},[169,1381,371],{},[248,1383,1384],{},"Which variable to send to the colormap when bivariate and only one value should be shown.",[230,1386,1387,1392,1397,1402],{},[248,1388,1389],{},[169,1390,1391],{},"value_range",[248,1393,1394],{},[169,1395,1396],{},"tuple[float, float]",[248,1398,1399],{},[169,1400,1401],{},"(0, 1)",[248,1403,1404,1405,1408],{},"Fixed ",[169,1406,1407],{},"(min, max)"," bounds of the color mapping.",[230,1410,1411,1416,1420,1424],{},[248,1412,1413],{},[169,1414,1415],{},"show_borders",[248,1417,1418],{},[169,1419,1245],{},[248,1421,1422],{},[169,1423,1250],{},[248,1425,1426],{},"Draw country\u002Fcoastline borders over the plot.",[230,1428,1429,1434,1438,1442],{},[248,1430,1431],{},[169,1432,1433],{},"use_border_texture",[248,1435,1436],{},[169,1437,1245],{},[248,1439,1440],{},[169,1441,1250],{},[248,1443,1444],{},"Draw the borders into the shaders instead of physical lines",[230,1446,1447,1452,1457,1462],{},[248,1448,1449],{},[169,1450,1451],{},"border_width",[248,1453,1454],{},[169,1455,1456],{},"float",[248,1458,1459],{},[169,1460,1461],{},"0.05",[248,1463,1464,1465,1469,1470,554],{},"Line width of the borders. (",[1466,1467,1468],"strong",{},"Requires"," ",[624,1471,1472],{},"use_border_texture=True",[230,1474,1475,1480,1484,1489],{},[248,1476,1477],{},[169,1478,1479],{},"border_color",[248,1481,1482],{},[169,1483,1219],{},[248,1485,1486],{},[169,1487,1488],{},"\"#000000\"",[248,1490,1491],{},"Border color (CSS color string).",[230,1493,1494,1499,1503,1509],{},[248,1495,1496],{},[169,1497,1498],{},"lon_extent",[248,1500,1501],{},[169,1502,1396],{},[248,1504,1505,1506],{},"Detects automatically. If fail then --> ",[169,1507,1508],{},"(-180, 180)",[248,1510,1511],{},"Longtude extent of data.",[230,1513,1514,1519,1523,1528],{},[248,1515,1516],{},[169,1517,1518],{},"lat_extent",[248,1520,1521],{},[169,1522,1396],{},[248,1524,1505,1525],{},[169,1526,1527],{},"(-90, 90)",[248,1529,1530],{},"Latitude extent of data.",[230,1532,1533,1538,1542,1546],{},[248,1534,1535],{},[169,1536,1537],{},"lon_resolution",[248,1539,1540],{},[169,1541,1456],{},[248,1543,1505,1544],{},[169,1545,1359],{},[248,1547,1548],{},"Grid resolution (degrees).",[230,1550,1551,1556,1560,1564],{},[248,1552,1553],{},[169,1554,1555],{},"lat_resolution",[248,1557,1558],{},[169,1559,1456],{},[248,1561,1505,1562],{},[169,1563,1359],{},[248,1565,1566],{},"Grid resolution (degrees)g.",[230,1568,1569,1574,1578,1582],{},[248,1570,1571],{},[169,1572,1573],{},"interp_pixels",[248,1575,1576],{},[169,1577,1245],{},[248,1579,1580],{},[169,1581,1250],{},[248,1583,1584],{},"Interpolate between pixels for smoother rendering.",[230,1586,1587,1592,1596,1600],{},[248,1588,1589],{},[169,1590,1591],{},"use_ortho",[248,1593,1594],{},[169,1595,1245],{},[248,1597,1598],{},[169,1599,1250],{},[248,1601,1602],{},"Use an orthographic camera.",[230,1604,1605,1610,1614,1618],{},[248,1606,1607],{},[169,1608,1609],{},"fill_value",[248,1611,1612],{},[169,1613,1456],{},[248,1615,1616],{},[169,1617,1073],{},[248,1619,1620],{},"Value to treat as the data fill\u002Fmissing value.",[230,1622,1623,1628,1633,1637],{},[248,1624,1625],{},[169,1626,1627],{},"mask_feature",[248,1629,1630],{},[169,1631,1632],{},"Literal[0, 1, 2]",[248,1634,1635],{},[169,1636,371],{},[248,1638,1639,1640,1642,1643,1645,1646,1648],{},"Mask by geographic feature: ",[169,1641,371],{}," = no mask, ",[169,1644,1359],{}," = mask land, ",[169,1647,1350],{}," = mask ocean.",[230,1650,1651,1656,1660,1664],{},[248,1652,1653],{},[169,1654,1655],{},"mask_value",[248,1657,1658],{},[169,1659,1456],{},[248,1661,1662],{},[169,1663,1073],{},[248,1665,1666],{},"Value to mask out.",[230,1668,1669,1674,1679,1684],{},[248,1670,1671],{},[169,1672,1673],{},"camera_position",[248,1675,1676],{},[169,1677,1678],{},"Vector3",[248,1680,1681],{},[169,1682,1683],{},"[0, 0, 5]",[248,1685,1686,1687,316],{},"Camera position ",[169,1688,1689],{},"{x, y, z}",[230,1691,1692,1697,1701,1705],{},[248,1693,1694],{},[169,1695,1696],{},"native_CRS",[248,1698,1699],{},[169,1700,1219],{},[248,1702,1703],{},[169,1704,1073],{},[248,1706,1707],{},"Native CRS of the data (used for reprojection).",[230,1709,1710,1715,1719,1723],{},[248,1711,1712],{},[169,1713,1714],{},"dest_CRS",[248,1716,1717],{},[169,1718,1219],{},[248,1720,1721],{},[169,1722,1073],{},[248,1724,1725],{},"Target CRS to reproject to. When both CRS options are set, reprojection is enabled.",[165,1727,1728,1729,1734],{},"See ",[629,1730,1732],{"href":1731},"#constructor",[169,1733,437],{}," above for how pass-through keyword arguments are\nmerged into the final plot state.",[179,1736,1738],{"className":181,"code":1737,"language":183,"meta":184,"style":184},"from browzarr import Browzarr\n\nBrowzarr(dataset=\"gs:\u002F\u002Fsome-zarr-store\", variable=\"temperature\").volume(\n    colormap=\"inferno\",\n    transparency=0.5,\n    value_range=(270, 310),\n).plot()\n",[169,1739,1740,1750,1756,1792,1808,1819,1837],{"__ignoreMap":184},[188,1741,1742,1744,1746,1748],{"class":190,"line":191},[188,1743,195],{"class":194},[188,1745,199],{"class":198},[188,1747,202],{"class":194},[188,1749,757],{"class":198},[188,1751,1752],{"class":190,"line":337},[188,1753,1755],{"emptyLinePlaceholder":1754},true,"\n",[188,1757,1758,1760,1762,1764,1766,1768,1771,1773,1775,1777,1779,1781,1784,1786,1788,1790],{"class":190,"line":349},[188,1759,252],{"class":331},[188,1761,456],{"class":208},[188,1763,459],{"class":363},[188,1765,451],{"class":208},[188,1767,464],{"class":208},[188,1769,1770],{"class":467},"gs:\u002F\u002Fsome-zarr-store",[188,1772,464],{"class":208},[188,1774,209],{"class":208},[188,1776,475],{"class":363},[188,1778,451],{"class":208},[188,1780,464],{"class":208},[188,1782,1783],{"class":467},"temperature",[188,1785,464],{"class":208},[188,1787,694],{"class":208},[188,1789,681],{"class":331},[188,1791,334],{"class":208},[188,1793,1794,1797,1799,1801,1804,1806],{"class":190,"line":360},[188,1795,1796],{"class":363},"    colormap",[188,1798,451],{"class":208},[188,1800,464],{"class":208},[188,1802,1803],{"class":467},"inferno",[188,1805,464],{"class":208},[188,1807,829],{"class":208},[188,1809,1810,1813,1815,1817],{"class":190,"line":382},[188,1811,1812],{"class":363},"    transparency",[188,1814,451],{"class":208},[188,1816,691],{"class":370},[188,1818,829],{"class":208},[188,1820,1821,1824,1826,1829,1831,1834],{"class":190,"line":398},[188,1822,1823],{"class":363},"    value_range",[188,1825,367],{"class":208},[188,1827,1828],{"class":370},"270",[188,1830,209],{"class":208},[188,1832,1833],{"class":370}," 310",[188,1835,1836],{"class":208},"),\n",[188,1838,1839,1841,1843],{"class":190,"line":414},[188,1840,694],{"class":208},[188,1842,868],{"class":331},[188,1844,1089],{"class":208},[318,1846,1178],{"id":681},[165,1848,1849,1850,1852],{},"The volume plot renders the variable as a 3D volumetric data cube. It is selected with\nthe ",[169,1851,1178],{}," method:",[179,1854,1856],{"className":181,"code":1855,"language":183,"meta":184,"style":184},"from browzarr import Browzarr\n\nBrowzarr(dataset=\"gs:\u002F\u002Fsome-zarr-store\", variable=\"temperature\").volume(\n    colormap=\"turbo\",\n    transparency=0.6,\n    value_range=(270, 310),\n).plot()\n",[169,1857,1858,1868,1872,1906,1921,1932,1946],{"__ignoreMap":184},[188,1859,1860,1862,1864,1866],{"class":190,"line":191},[188,1861,195],{"class":194},[188,1863,199],{"class":198},[188,1865,202],{"class":194},[188,1867,757],{"class":198},[188,1869,1870],{"class":190,"line":337},[188,1871,1755],{"emptyLinePlaceholder":1754},[188,1873,1874,1876,1878,1880,1882,1884,1886,1888,1890,1892,1894,1896,1898,1900,1902,1904],{"class":190,"line":349},[188,1875,252],{"class":331},[188,1877,456],{"class":208},[188,1879,459],{"class":363},[188,1881,451],{"class":208},[188,1883,464],{"class":208},[188,1885,1770],{"class":467},[188,1887,464],{"class":208},[188,1889,209],{"class":208},[188,1891,475],{"class":363},[188,1893,451],{"class":208},[188,1895,464],{"class":208},[188,1897,1783],{"class":467},[188,1899,464],{"class":208},[188,1901,694],{"class":208},[188,1903,681],{"class":331},[188,1905,334],{"class":208},[188,1907,1908,1910,1912,1914,1917,1919],{"class":190,"line":360},[188,1909,1796],{"class":363},[188,1911,451],{"class":208},[188,1913,464],{"class":208},[188,1915,1916],{"class":467},"turbo",[188,1918,464],{"class":208},[188,1920,829],{"class":208},[188,1922,1923,1925,1927,1930],{"class":190,"line":382},[188,1924,1812],{"class":363},[188,1926,451],{"class":208},[188,1928,1929],{"class":370},"0.6",[188,1931,829],{"class":208},[188,1933,1934,1936,1938,1940,1942,1944],{"class":190,"line":398},[188,1935,1823],{"class":363},[188,1937,367],{"class":208},[188,1939,1828],{"class":370},[188,1941,209],{"class":208},[188,1943,1833],{"class":370},[188,1945,1836],{"class":208},[188,1947,1948,1950,1952],{"class":190,"line":414},[188,1949,694],{"class":208},[188,1951,868],{"class":331},[188,1953,1089],{"class":208},[165,1955,1956,1957,1179,1959,1961],{},"In addition to the ",[629,1958,632],{"href":631},[169,1960,1178],{}," accepts the following\nvolume-specific keyword arguments. Unset options fall back to the frontend's default\nstate, listed below.",[224,1963,1964,1976],{},[227,1965,1966],{},[230,1967,1968,1970,1972,1974],{},[233,1969,1198],{},[233,1971,1201],{},[233,1973,982],{},[233,1975,985],{},[243,1977,1978,1996,2019,2039],{},[230,1979,1980,1985,1989,1993],{},[248,1981,1982],{},[169,1983,1984],{},"use_ray_march",[248,1986,1987],{},[169,1988,1245],{},[248,1990,1991],{},[169,1992,1250],{},[248,1994,1995],{},"Use Ray Marcher renderer. If false, volume uses DDA render",[230,1997,1998,2002,2006,2010],{},[248,1999,2000],{},[169,2001,686],{},[248,2003,2004],{},[169,2005,1456],{},[248,2007,2008],{},[169,2009,371],{},[248,2011,2012,2013,2015,2016,2018],{},"Global opacity of the rendered volume, from ",[169,2014,371],{}," (opaque) to ",[169,2017,1359],{}," (fully transparent).",[230,2020,2021,2026,2030,2034],{},[248,2022,2023],{},[169,2024,2025],{},"nan_transparency",[248,2027,2028],{},[169,2029,1456],{},[248,2031,2032],{},[169,2033,1359],{},[248,2035,2036,2037,694],{},"Opacity applied to cells whose value is missing (NaN \u002F ",[169,2038,1609],{},[230,2040,2041,2046,2050,2055],{},[248,2042,2043],{},[169,2044,2045],{},"quality",[248,2047,2048],{},[169,2049,1456],{},[248,2051,2052],{},[169,2053,2054],{},"200",[248,2056,2057,2058,1469,2060,554],{},"The quality of the ray marcher renderer. Higher values mean smaller step-sizes and better visuals. (",[1466,2059,1468],{},[624,2061,2062],{},"use_ray_march=True",[318,2064,1182],{"id":697},[165,2066,2067,2068,1852],{},"The points plot renders the variable as a high-density interactive 3D point cloud. It is\nselected with the ",[169,2069,1182],{},[179,2071,2073],{"className":181,"code":2072,"language":183,"meta":184,"style":184},"from browzarr import Browzarr\n\nBrowzarr(dataset=\"gs:\u002F\u002Fsome-zarr-store\", variable=\"temperature\").points(\n    point_size=3,\n).plot()\n",[169,2074,2075,2085,2089,2123,2134],{"__ignoreMap":184},[188,2076,2077,2079,2081,2083],{"class":190,"line":191},[188,2078,195],{"class":194},[188,2080,199],{"class":198},[188,2082,202],{"class":194},[188,2084,757],{"class":198},[188,2086,2087],{"class":190,"line":337},[188,2088,1755],{"emptyLinePlaceholder":1754},[188,2090,2091,2093,2095,2097,2099,2101,2103,2105,2107,2109,2111,2113,2115,2117,2119,2121],{"class":190,"line":349},[188,2092,252],{"class":331},[188,2094,456],{"class":208},[188,2096,459],{"class":363},[188,2098,451],{"class":208},[188,2100,464],{"class":208},[188,2102,1770],{"class":467},[188,2104,464],{"class":208},[188,2106,209],{"class":208},[188,2108,475],{"class":363},[188,2110,451],{"class":208},[188,2112,464],{"class":208},[188,2114,1783],{"class":467},[188,2116,464],{"class":208},[188,2118,694],{"class":208},[188,2120,697],{"class":331},[188,2122,334],{"class":208},[188,2124,2125,2128,2130,2132],{"class":190,"line":360},[188,2126,2127],{"class":363},"    point_size",[188,2129,451],{"class":208},[188,2131,707],{"class":370},[188,2133,829],{"class":208},[188,2135,2136,2138,2140],{"class":190,"line":382},[188,2137,694],{"class":208},[188,2139,868],{"class":331},[188,2141,1089],{"class":208},[165,2143,1956,2144,1179,2146,2148],{},[629,2145,632],{"href":631},[169,2147,1182],{}," accepts the following\npoint-specific keyword arguments. Unset options fall back to the frontend's default\nstate, listed below.",[224,2150,2151,2163],{},[227,2152,2153],{},[230,2154,2155,2157,2159,2161],{},[233,2156,1198],{},[233,2158,1201],{},[233,2160,982],{},[233,2162,985],{},[243,2164,2165,2183,2201,2219],{},[230,2166,2167,2171,2175,2180],{},[248,2168,2169],{},[169,2170,702],{},[248,2172,2173],{},[169,2174,1456],{},[248,2176,2177],{},[169,2178,2179],{},"5",[248,2181,2182],{},"Base size of the rendered points.",[230,2184,2185,2190,2194,2198],{},[248,2186,2187],{},[169,2188,2189],{},"time_scale",[248,2191,2192],{},[169,2193,1456],{},[248,2195,2196],{},[169,2197,1359],{},[248,2199,2200],{},"Scaling factor applied to points along the z-axis. Higher values spread them out.",[230,2202,2203,2208,2212,2216],{},[248,2204,2205],{},[169,2206,2207],{},"scale_points",[248,2209,2210],{},[169,2211,1245],{},[248,2213,2214],{},[169,2215,1250],{},[248,2217,2218],{},"Scale point size with the data value (intensity-scaled points).",[230,2220,2221,2226,2230,2234],{},[248,2222,2223],{},[169,2224,2225],{},"scale_intensity",[248,2227,2228],{},[169,2229,1456],{},[248,2231,2232],{},[169,2233,1359],{},[248,2235,2236],{},"How exaggerated point scaling is.",[318,2238,2240],{"id":2239},"flat-sphere","flat() - sphere()",[165,2242,2243],{},"Both the Flatmap and Sphere renderes present a 2D slice\u002Frepresentation of data that can be displaced in 3D.",[179,2245,2247],{"className":181,"code":2246,"language":183,"meta":184,"style":184},"from browzarr import Browzarr\n\nBrowzarr(dataset=\"gs:\u002F\u002Fsome-zarr-store\", variable=\"temperature\").flat().plot()\nBrowzarr(dataset=\"gs:\u002F\u002Fsome-zarr-store\", variable=\"temperature\").sphere().plot()\n",[169,2248,2249,2259,2263,2302],{"__ignoreMap":184},[188,2250,2251,2253,2255,2257],{"class":190,"line":191},[188,2252,195],{"class":194},[188,2254,199],{"class":198},[188,2256,202],{"class":194},[188,2258,757],{"class":198},[188,2260,2261],{"class":190,"line":337},[188,2262,1755],{"emptyLinePlaceholder":1754},[188,2264,2265,2267,2269,2271,2273,2275,2277,2279,2281,2283,2285,2287,2289,2291,2293,2296,2298,2300],{"class":190,"line":349},[188,2266,252],{"class":331},[188,2268,456],{"class":208},[188,2270,459],{"class":363},[188,2272,451],{"class":208},[188,2274,464],{"class":208},[188,2276,1770],{"class":467},[188,2278,464],{"class":208},[188,2280,209],{"class":208},[188,2282,475],{"class":363},[188,2284,451],{"class":208},[188,2286,464],{"class":208},[188,2288,1783],{"class":467},[188,2290,464],{"class":208},[188,2292,694],{"class":208},[188,2294,2295],{"class":331},"flat",[188,2297,807],{"class":208},[188,2299,868],{"class":331},[188,2301,1089],{"class":208},[188,2303,2304,2306,2308,2310,2312,2314,2316,2318,2320,2322,2324,2326,2328,2330,2332,2335,2337,2339],{"class":190,"line":360},[188,2305,252],{"class":331},[188,2307,456],{"class":208},[188,2309,459],{"class":363},[188,2311,451],{"class":208},[188,2313,464],{"class":208},[188,2315,1770],{"class":467},[188,2317,464],{"class":208},[188,2319,209],{"class":208},[188,2321,475],{"class":363},[188,2323,451],{"class":208},[188,2325,464],{"class":208},[188,2327,1783],{"class":467},[188,2329,464],{"class":208},[188,2331,694],{"class":208},[188,2333,2334],{"class":331},"sphere",[188,2336,807],{"class":208},[188,2338,868],{"class":331},[188,2340,1089],{"class":208},[165,2342,1956,2343,1179,2345,2347,2348,2350],{},[629,2344,632],{"href":631},[169,2346,1185],{}," and ",[169,2349,1188],{}," accept the\nkeyword arguments below. Unset options fall back to the frontend's default state, listed\nbelow.",[2352,2353,2355,2356,2347,2358],"h4",{"id":2354},"shared-by-flat-and-sphere","Shared by ",[169,2357,1185],{},[169,2359,1188],{},[224,2361,2362,2374],{},[227,2363,2364],{},[230,2365,2366,2368,2370,2372],{},[233,2367,1198],{},[233,2369,1201],{},[233,2371,982],{},[233,2373,985],{},[243,2375,2376,2394,2412],{},[230,2377,2378,2383,2387,2391],{},[248,2379,2380],{},[169,2381,2382],{},"displace_faces",[248,2384,2385],{},[169,2386,1245],{},[248,2388,2389],{},[169,2390,1250],{},[248,2392,2393],{},"Displace the individual faces according to the data values.",[230,2395,2396,2401,2405,2409],{},[248,2397,2398],{},[169,2399,2400],{},"displacement",[248,2402,2403],{},[169,2404,1456],{},[248,2406,2407],{},[169,2408,371],{},[248,2410,2411],{},"Magnitude of the vertical displacement of the surface\u002Ffaces.",[230,2413,2414,2419,2423,2428],{},[248,2415,2416],{},[169,2417,2418],{},"offset_negatives",[248,2420,2421],{},[169,2422,1245],{},[248,2424,2425],{},[169,2426,2427],{},"true",[248,2429,2430],{},"Offset negative values so the surface is not displaced below the base plane\u002Fglobe.",[2352,2432,2434,2436],{"id":2433},"flat-only",[169,2435,1185],{}," only",[224,2438,2439,2451],{},[227,2440,2441],{},[230,2442,2443,2445,2447,2449],{},[233,2444,1198],{},[233,2446,1201],{},[233,2448,982],{},[233,2450,985],{},[243,2452,2453],{},[230,2454,2455,2460,2464,2468],{},[248,2456,2457],{},[169,2458,2459],{},"rotate_flat",[248,2461,2462],{},[169,2463,1245],{},[248,2465,2466],{},[169,2467,1250],{},[248,2469,2470],{},"Rotate the flat surface to face up along the Y-axis.",[174,2472,2474],{"id":2473},"session-lifecycle","Session lifecycle",[318,2476,2478],{"id":2477},"browzarrsessionshutdown",[169,2479,2480],{},"BrowzarrSession.shutdown()",[165,2482,2483,2484,2486,2487,2489],{},"A single local server is shared across all ",[169,2485,252],{}," instances in the same process, so\nrepeated ",[169,2488,315],{}," calls reuse it instead of spawning duplicates.",[165,2491,2492],{},"To stop the shared server and free its port:",[179,2494,2496],{"className":181,"code":2495,"language":183,"meta":184,"style":184},"from browzarr.api import BrowzarrSession\n\nBrowzarrSession.shutdown()\n",[169,2497,2498,2515,2519],{"__ignoreMap":184},[188,2499,2500,2502,2505,2507,2510,2512],{"class":190,"line":191},[188,2501,195],{"class":194},[188,2503,2504],{"class":198}," browzarr",[188,2506,316],{"class":208},[188,2508,2509],{"class":198},"api ",[188,2511,202],{"class":194},[188,2513,2514],{"class":198}," BrowzarrSession\n",[188,2516,2517],{"class":190,"line":337},[188,2518,1755],{"emptyLinePlaceholder":1754},[188,2520,2521,2524,2526,2529],{"class":190,"line":349},[188,2522,2523],{"class":198},"BrowzarrSession",[188,2525,316],{"class":208},[188,2527,2528],{"class":331},"shutdown",[188,2530,1089],{"class":208},[174,2532,2534],{"id":2533},"module-functions","Module functions",[318,2536,2538],{"id":2537},"build_browzarr",[169,2539,265],{},[165,2541,2542],{},"Rebuilds the bundled frontend distribution from the upstream source.",[179,2544,2546],{"className":181,"code":2545,"language":183,"meta":184,"style":184},"from browzarr import build_browzarr\n\nbuild_browzarr()\n",[169,2547,2548,2559,2563],{"__ignoreMap":184},[188,2549,2550,2552,2554,2556],{"class":190,"line":191},[188,2551,195],{"class":194},[188,2553,199],{"class":198},[188,2555,202],{"class":194},[188,2557,2558],{"class":198}," build_browzarr\n",[188,2560,2561],{"class":190,"line":337},[188,2562,1755],{"emptyLinePlaceholder":1754},[188,2564,2565,2567],{"class":190,"line":349},[188,2566,2537],{"class":331},[188,2568,1089],{"class":208},[165,2570,2571,2572,2578,2579,316],{},"Requires ",[629,2573,2577],{"href":2574,"rel":2575},"https:\u002F\u002Fpnpm.io\u002Finstallation",[2576],"nofollow","pnpm"," on your ",[169,2580,2581],{},"PATH",[2583,2584,2585,2593,2602],"ol",{},[2586,2587,2588,2589,2592],"li",{},"Downloads the latest source from the ",[169,2590,2591],{},"main"," branch of the upstream repo.",[2586,2594,2595,2596,2347,2599,316],{},"Runs ",[169,2597,2598],{},"pnpm install",[169,2600,2601],{},"pnpm run build",[2586,2603,2604,2605,2608],{},"Replaces ",[169,2606,2607],{},"web\u002Fdist"," with the freshly built output.",[165,2610,2611],{},"The build output is written in the package data directory, which requires write access.",[318,2613,2615],{"id":2614},"update_browzarr",[169,2616,278],{},[165,2618,2619,2620,2622],{},"Updates the bundled frontend from the upstream prebuilt ",[169,2621,286],{}," branch — faster\nthan a full source rebuild.",[179,2624,2626],{"className":181,"code":2625,"language":183,"meta":184,"style":184},"from browzarr import update_browzarr\n\nupdate_browzarr()\n",[169,2627,2628,2639,2643],{"__ignoreMap":184},[188,2629,2630,2632,2634,2636],{"class":190,"line":191},[188,2631,195],{"class":194},[188,2633,199],{"class":198},[188,2635,202],{"class":194},[188,2637,2638],{"class":198}," update_browzarr\n",[188,2640,2641],{"class":190,"line":337},[188,2642,1755],{"emptyLinePlaceholder":1754},[188,2644,2645,2647],{"class":190,"line":349},[188,2646,2614],{"class":331},[188,2648,1089],{"class":208},[165,2650,2651,2652,316],{},"Downloads the tarball, extracts it, and replaces ",[169,2653,2607],{},[318,2655,2656],{"id":2591},[169,2657,294],{},[165,2659,2660,2661,2663],{},"The command-line entry point registered as the ",[169,2662,171],{}," console script. Run it from a\nterminal:",[179,2665,2669],{"className":2666,"code":2667,"language":2668,"meta":184,"style":184},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","browzarr\n","bash",[169,2670,2671],{"__ignoreMap":184},[188,2672,2673],{"class":190,"line":191},[188,2674,2667],{"class":739},[2676,2677,2678],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}",{"title":184,"searchDepth":337,"depth":337,"links":2680},[2681,2682,2688,2694,2697],{"id":176,"depth":337,"text":177},{"id":171,"depth":337,"text":252,"children":2683},[2684,2685,2686,2687],{"id":320,"depth":349,"text":321},{"id":523,"depth":349,"text":524},{"id":715,"depth":349,"text":716},{"id":868,"depth":349,"text":871},{"id":1165,"depth":337,"text":41,"children":2689},[2690,2691,2692,2693],{"id":1171,"depth":349,"text":1172},{"id":681,"depth":349,"text":1178},{"id":697,"depth":349,"text":1182},{"id":2239,"depth":349,"text":2240},{"id":2473,"depth":337,"text":2474,"children":2695},[2696],{"id":2477,"depth":349,"text":2480},{"id":2533,"depth":337,"text":2534,"children":2698},[2699,2700,2701],{"id":2537,"depth":349,"text":265},{"id":2614,"depth":349,"text":278},{"id":2591,"depth":349,"text":294},"Full reference for the pyBrowzarr public API — Browzarr, its methods, module functions, and plot-type options.","md",null,{},{"icon":119},{"title":116,"description":2702},"8KE9HZvi_lp45L8qKI1-CbVXF01EWoUHR73S2BnPsU4",[2710,2712],{"title":111,"path":112,"stem":113,"description":2711,"icon":114,"children":-1},"Update or rebuild the Browzarr frontend bundled with the pyBrowzarr package.",{"title":126,"path":127,"stem":128,"description":2713,"icon":129,"children":-1},"How to contribute to Browzarr.",1790773465283]