matplotlib.github.com/3.6.1/_static/doctools.js at main · matplotlib/matplotlib.github.com · GitHub

History

264 lines (239 loc) · 7.98 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

* doctools.js

* ~~~~~~~~~~~

* Base JavaScript utilities for all Sphinx HTML documentation.

* :license: BSD, see LICENSE for details.

"use strict";

const _ready = (callback) => {

if (document.readyState !== "loading") {

callback();

} else {

document.addEventListener("DOMContentLoaded", callback);

}

};

/**

* highlight a given string on a node by wrapping it in

* span elements with the given class name.

const _highlight = (node, addItems, text, className) => {

if (node.nodeType === Node.TEXT_NODE) {

const val = node.nodeValue;

const parent = node.parentNode;

const pos = val.toLowerCase().indexOf(text);

if (

pos >= 0 &&

!parent.classList.contains(className) &&

!parent.classList.contains("nohighlight")

) {

let span;

const closestNode = parent.closest("body, svg, foreignObject");

const isInSVG = closestNode && closestNode.matches("svg");

if (isInSVG) {

span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");

} else {

span = document.createElement("span");

span.classList.add(className);

}

span.appendChild(document.createTextNode(val.substr(pos, text.length)));

parent.insertBefore(

span,

parent.insertBefore(

document.createTextNode(val.substr(pos + text.length)),

node.nextSibling

)

);

node.nodeValue = val.substr(0, pos);

if (isInSVG) {

const rect = document.createElementNS(

"http://www.w3.org/2000/svg",

"rect"

);

const bbox = parent.getBBox();

rect.x.baseVal.value = bbox.x;

rect.y.baseVal.value = bbox.y;

rect.width.baseVal.value = bbox.width;

rect.height.baseVal.value = bbox.height;

rect.setAttribute("class", className);

addItems.push({ parent: parent, target: rect });

}

} else if (node.matches && !node.matches("button, select, textarea")) {

node.childNodes.forEach((el) => _highlight(el, addItems, text, className));

}

};

const _highlightText = (thisNode, text, className) => {

let addItems = [];

_highlight(thisNode, addItems, text, className);

addItems.forEach((obj) =>

obj.parent.insertAdjacentElement("beforebegin", obj.target)

);

};

/**

* Small JavaScript module for the documentation.

const Documentation = {

init: () => {

Documentation.highlightSearchWords();

Documentation.initDomainIndexTable();

Documentation.initOnKeyListeners();

/**

* i18n support

TRANSLATIONS: {},

PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),

LOCALE: "unknown",

// gettext and ngettext don't access this so that the functions

// can safely bound to a different name (_ = Documentation.gettext)

gettext: (string) => {

const translated = Documentation.TRANSLATIONS[string];

switch (typeof translated) {

case "undefined":

return string; // no translation

case "string":

return translated; // translation exists

default:

return translated[0]; // (singular, plural) translation tuple exists

}

ngettext: (singular, plural, n) => {

const translated = Documentation.TRANSLATIONS[singular];

if (typeof translated !== "undefined")

return translated[Documentation.PLURAL_EXPR(n)];

return n === 1 ? singular : plural;

addTranslations: (catalog) => {

Object.assign(Documentation.TRANSLATIONS, catalog.messages);

Documentation.PLURAL_EXPR = new Function(

"n",

`return (${catalog.plural_expr})`

);

Documentation.LOCALE = catalog.locale;

/**

* highlight the search words provided in the url in the text

highlightSearchWords: () => {

const highlight =

new URLSearchParams(window.location.search).get("highlight") || "";

const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);

if (terms.length === 0) return; // nothing to do

// There should never be more than one element matching "div.body"

const divBody = document.querySelectorAll("div.body");

const body = divBody.length ? divBody[0] : document.querySelector("body");

window.setTimeout(() => {

terms.forEach((term) => _highlightText(body, term, "highlighted"));

}, 10);

const searchBox = document.getElementById("searchbox");

if (searchBox === null) return;

searchBox.appendChild(

document

.createRange()

.createContextualFragment(

'<p class="highlight-link">' +

'<a href="javascript:Documentation.hideSearchWords()">' +

Documentation.gettext("Hide Search Matches") +

"</a></p>"

)

);

/**

* helper function to hide the search marks again

hideSearchWords: () => {

document

.querySelectorAll("#searchbox .highlight-link")

.forEach((el) => el.remove());

document

.querySelectorAll("span.highlighted")

.forEach((el) => el.classList.remove("highlighted"));

const url = new URL(window.location);

url.searchParams.delete("highlight");

window.history.replaceState({}, "", url);

/**

* helper function to focus on search bar

focusSearchBar: () => {

document.querySelectorAll("input[name=q]")[0]?.focus();

/**

* Initialise the domain index toggle buttons

initDomainIndexTable: () => {

const toggler = (el) => {

const idNumber = el.id.substr(7);

const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);

if (el.src.substr(-9) === "minus.png") {

el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;

toggledRows.forEach((el) => (el.style.display = "none"));

} else {

el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;

toggledRows.forEach((el) => (el.style.display = ""));

}

};

const togglerElements = document.querySelectorAll("img.toggler");

togglerElements.forEach((el) =>

el.addEventListener("click", (event) => toggler(event.currentTarget))

);

togglerElements.forEach((el) => (el.style.display = ""));

if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);

initOnKeyListeners: () => {

// only install a listener if it is really needed

if (

!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&

!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS

)

return;

const blacklistedElements = new Set([

"TEXTAREA",

"INPUT",

"SELECT",

"BUTTON",

]);

document.addEventListener("keydown", (event) => {

if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements

if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys

if (!event.shiftKey) {

switch (event.key) {

case "ArrowLeft":

if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;

const prevLink = document.querySelector('link[rel="prev"]');

if (prevLink && prevLink.href) {

window.location.href = prevLink.href;

event.preventDefault();

}

break;

case "ArrowRight":

if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;

const nextLink = document.querySelector('link[rel="next"]');

if (nextLink && nextLink.href) {

window.location.href = nextLink.href;

event.preventDefault();

}

break;

case "Escape":

if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;

Documentation.hideSearchWords();

event.preventDefault();

}

// some keyboard layouts may need Shift to get /

switch (event.key) {

case "/":

if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;

Documentation.focusSearchBar();

event.preventDefault();

}

});

};

// quick alias for translations

const _ = Documentation.gettext;

_ready(Documentation.init);

matplotlib.github.com/3.6.1/_static/doctools.js at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

doctools.js

Latest commit

History

Breadcrumbs

doctools.js

File metadata and controls