GoJS/intro/layers.html at master · NorthwoodsSoftware/GoJS

History

547 lines (515 loc) · 21 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

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

<!DOCTYPE html>

<head>

<title>

Layers | GoJS

</title>

</head>

window.diagrams = [];

window.goCode = function (pre, w, h, parentid, animation) {

window

.diagrams

.push([pre, w, h, parentid, animation]);

}

</script>

<body>

<a class="text-white bg-nwoods-primary font-bold !leading-[calc(var(--topnav-h)_-_1px)] my-0 px-2 text-4xl lg:text-5xl logo"

href="../">

GoJS

</a>

</svg>

</button>

<div class="absolute right-0 z-30 flex flex-col items-end rounded border border-gray-200 p-4 pl-12 shadow bg-white text-gray-900 font-semibold

md:flex-row md:space-x-4 md:items-start md:border-0 md:p-0 md:shadow-none md:bg-inherit">

<a href="../learn/">Learn</a>

<a href="../samples/">Samples</a>

<a href="../intro/">Intro</a>

<a href="../download.html">Download</a>

<a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a>

<a id="tc" href="https://nwoods.com/contact.html"

target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/contact.html', 'contact');">Contact</a>

<a id="tb" href="https://nwoods.com/sales/index.html"

target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/sales/index.html', 'buy');">Buy</a>

</div>

</nav>

window.addEventListener("DOMContentLoaded", function () {

// topnav

var topButton = document.getElementById("topnavButton");

var topnavList = document.getElementById("topnavList");

if (topButton && topnavList) {

topButton.addEventListener("click", function (e) {

topnavList

.classList

.toggle("hidden");

e.stopPropagation();

});

document.addEventListener("click", function (e) {

// if the clicked element isn't the list, close the list

if (!topnavList.classList.contains("hidden") && !e.target.closest("#topnavList")) {

topButton.click();

}

});

// set active <a> element

var url = window

.location

.href

.toLowerCase();

var aTags = topnavList.getElementsByTagName('a');

for (var i = 0; i < aTags.length; i++) {

var lowerhref = aTags[i]

.href

.toLowerCase();

if (lowerhref.endsWith('.html'))

lowerhref = lowerhref.slice(0, -5);

if (url.startsWith(lowerhref)) {

aTags[i]

.classList

.add('active');

break;

}

});

</script>

</svg>

</button>

</div>

window.addEventListener("DOMContentLoaded", function () {

// sidenav

var sideButton = document.getElementById("sidenavButton");

var sidenav = document.getElementById("sidenav");

if (sideButton && sidenav) {

sideButton.addEventListener("click", function (e) {

sidenav

.classList

.toggle("hidden");

e.stopPropagation();

});

document.addEventListener("click", function (e) {

// if the clicked element isn't the list, close the list

if (!sidenav.classList.contains("hidden") && !e.target.closest("#sidenavList")) {

sideButton.click();

}

});

}

});

</script>

<aside id="sidenav"

class="hidden fixed top-0 left-0 z-10 w-full bg-black/10 min-h-screen max-h-screen overflow-x-hidden overflow-y-auto shrink-0

md:block md:sticky md:w-52 md:min-h-0 md:bg-inherit md:border-r md:border-r-gray-200 md:overscroll-auto">

<a href="index.html">Basics</a>

<a href="buildingObjects.html">Building Parts</a>

<a href="usingModels.html">Using Models</a>

<a href="dataBinding.html">Data Binding</a>

<a href="react.html">GoJS with React</a>

<a href="svelte.html">GoJS with Svelte</a>

<a href="angular.html">GoJS with Angular</a>

<a href="textBlocks.html">TextBlocks</a>

<a href="shapes.html">Shapes</a>

<a href="pictures.html">Pictures</a>

<a href="panels.html">Panels</a>

<a href="tablePanels.html">Table Panels</a>

<a href="brush.html">Brushes</a>

<a href="sizing.html">Sizing Objects</a>

<a href="itemArrays.html">Item Arrays</a>

<a href="changedEvents.html">Changed Events</a>

<a href="transactions.html">Transactions</a>

<a href="viewport.html">Coordinates</a>

<a href="initialView.html">Initial View</a>

<a href="collections.html">Collections</a>

<a href="links.html">Links</a>

<a href="linkLabels.html">Link Labels</a>

<a href="connectionPoints.html">Link Points</a>

<a href="ports.html">Ports</a>

<a href="nodes.html">Nodes</a>

<a href="typings.html">Typings</a>

<a href="debugging.html">Debugging</a>

<a href="layouts.html">Layouts</a>

<a href="routers.html">Routers</a>

<a href="trees.html">Trees</a>

<a href="subtrees.html">SubTrees</a>

<a href="groups.html">Groups</a>

<a href="subgraphs.html">SubGraphs</a>

<a href="sizedGroups.html">Sized Groups</a>

<a href="selection.html">Selection</a>

<a href="highlighting.html">Highlighting</a>

<a href="theming.html">Theming</a>

<a href="tooltips.html">ToolTips</a>

<a href="contextMenus.html">Context Menus</a>

<a href="events.html">Diagram Events</a>

<a href="tools.html">Tools</a>

<a href="commands.html">Commands</a>

<a href="accessibility.html">Accessibility</a>

<a href="buttons.html">Buttons</a>

<a href="permissions.html">Permissions</a>

<a href="validation.html">Validation</a>

<a href="animation.html">Animation</a>

<a href="HTMLInteraction.html">HTML Interaction</a>

<a href="layers.html">Layers & Z-ordering</a>

<a href="palette.html">Palette</a>

<a href="overview.html">Overview</a>

<a href="replacingDeleting.html">Replacing and Deleting</a>

<a href="templateMaps.html">Template Maps</a>

<a href="legends.html">Legends and Titles</a>

<a href="extensions.html">Extensions</a>

<a href="geometry.html">Geometry Strings</a>

<a href="grids.html">Grid Patterns</a>

<a href="graduatedPanels.html">Graduated Panels</a>

<a href="SVGContext.html">Rendering to SVG</a>

<a href="makingSVG.html">Snapshot to SVG</a>

<a href="makingImages.html">Diagram Images</a>

<a href="printing.html">Printing</a>

<a href="serverSideImages.html">Server-side Images</a>

<a href="testing.html">Testing</a>

<a href="performance.html">Performance</a>

<a href="platforms.html">Platforms</a>

<a href="deployment.html">Deployment</a>

</nav>

</aside>

var navList = document.getElementById('sidenavList');

if (navList !== null) {

var url = window.location.href;

var lindex = url.lastIndexOf('/');

url = url

.slice(lindex + 1)

.toLowerCase();

var aTags = navList.getElementsByTagName('a');

var currentindex = -1;

for (var i = 0; i < aTags.length; i++) {

var lowerhref = aTags[i]

.href

.toLowerCase();

if (lowerhref.indexOf('/' + url) !== -1) {

currentindex = i;

aTags[i]

.classList

.add('active');

break;

}

</script>

<h1>Layers and Z-ordering</h1>

<p>

All <a>Part</a>s that are in a <a>Diagram</a> actually belong to a <a>Layer</a> in the diagram. You can control the visibility, Z-order, and various user

permissions for all of the parts in each layer.

</p>

<p>

Parts can be individually modified to toggle their visibility using <a>Part.visible</a> or <a>Part.opacity</a>. Parts can be individually Z-ordered within

layers using <a>Part.zOrder</a>.

</p>

<h2 id="StandardLayers">Standard Layers</h2>

<p>

Every Diagram starts off with several standard layers. These are their <a>Layer.name</a>s, in order from furthest behind to most in front:

</p>

<ul>

<li><b>"Grid"</b>, holding the <a>Diagram.grid</a> and any other static Parts that you wish to be behind everything</li>

<li><b>"ViewportBackground"</b>, holding Parts aligned to the viewport rather than in the document</li>

<li><b>"Background"</b></li>

<li><b>""</b>, the default layer</li>

<li><b>"Foreground"</b></li>

<li><b>"ViewportForeground"</b>, holding Parts aligned to the viewport rather than in the document</li>

<li><b>"Adornment"</b>, holding <a>Adornment</a>s for selection and various Tools</li>

<li><b>"Tool"</b>, holding Parts used in the execution of various Tools</li>

</ul>

<p>

The Layers "ViewportBackground" and "ViewportForeground" are for adding Parts that do not move with the Diagram scale or position, because they are aligned to

the viewport, so such Parts stay fixed to a specific point in the viewport. See the <a href="./legends.html#StaticParts">Legends intro page</a> for more

discussion.

</p>

<p>

Each Part is placed in a Layer according to its <a>Part.layerName</a>. The default value is the empty string. Use <a>Diagram.findLayer</a> to find a Layer

given a layer name. Change which layer a part is in by setting <a>Part.layerName</a>.

</p>

<p>

Changes to Parts in the "Grid", "Adornment", "Tool", and "Viewport..." Layers are automatically ignored by the <a>UndoManager</a>, because

<a>Layer.isTemporary</a> is true. Those Parts are also not selectable.

</p>

<h2 id="LayersExample">Layers Example</h2>

<p>

This example adds several <a>Layer</a>s to the diagram, each named by a color, and then creates a bunch of colored parts at random locations. Every

<a>Part.layerName</a> is data-bound to the "color" property of the node data.

</p>

<p>

In addition there are checkboxes for each layer, controlling the visibility of the respective layer. You can see how all of the parts of the same color appear

and disappear according to the value of the checkbox. Furthermore you can see how they all have the same depth in the Z-ordering.

</p>

<p>

Finally, each Part has a <a>Part.selectionChanged</a> function which puts the part in the "Foreground" layer when it is selected and back in its normal color

layer when it is not selected.

</p>

// These new layers come in front of the standard regular layers,

// but behind the "Foreground" layer:

const forelayer = diagram.findLayer("Foreground");

diagram.addLayerBefore(new go.Layer({ name: "blue" }), forelayer);

diagram.addLayerBefore(new go.Layer({ name: "green" }), forelayer);

diagram.addLayerBefore(new go.Layer({ name: "orange" }), forelayer);

diagram.nodeTemplate = // no links or grouping, so can use the simpler Part class

new go.Part("Spot", {

selectionChanged: p => {

p.layerName = (p.isSelected ? "Foreground" : p.data.color);

layerChanged: (p, oldLayer, newLayer) => {

if (newLayer !== null) p.elt(1).text = newLayer.name;

}

})

.bind("layerName", "color")

.bind("location", "loc")

.add(

new go.Shape({ width: 80, height: 80 })

.bind("fill", "color"),

new go.TextBlock({ stroke: "white", font: "bold 12px sans-serif" })

);

const array = [];

for (let i = 0; i < 12; i++) {

const data = { loc: new go.Point(Math.random()*520, Math.random()*200) };

switch (Math.floor(Math.random()*3)) {

case 0: data.color = "blue"; break;

case 1: data.color = "green"; break;

case 2: data.color = "orange"; break;

default: data.color = "Foreground"; break;

}

array.push(data);

}

diagram.model.nodeDataArray = array;

diagram.undoManager.isEnabled = true;

// define this function so that the checkbox event handlers can call it

toggleVisible = (layername, e) => {

diagram.commit(d => {

const layer = d.findLayer(layername);

if (layer !== null) layer.visible = e.currentTarget.checked;

}, 'toggle ' + layername);

};

</code></pre>

goCode('layers', 610, 290);

</script>

Layer visibility:<br />

<input type="checkbox" checked="checked" onclick="toggleVisible('blue', event)" />blue

<input type="checkbox" checked="checked" onclick="toggleVisible('green', event)" />green

<input type="checkbox" checked="checked" onclick="toggleVisible('orange', event)" />orange

<input type="checkbox" checked="checked" onclick="toggleVisible('Foreground', event)" />Foreground

<h2 id="ZOrderExample">ZOrder Example</h2>

<p>

This example adds several <a>Part</a>s to one Layer (the default) in the diagram. Every <a>Part.zOrder</a> is data-bound to the "zOrder" property of the node

data, as is its text.

</p>

<p>

Buttons on the Part can be used to modify the z-order of each.

</p>

function changeZOrder(amt, obj) {

diagram.commit(d => {

const data = obj.part.data;

d.model.set(data, "zOrder", data.zOrder + amt);

}, 'modified zOrder');

}

diagram.nodeTemplate =

new go.Part("Spot")

.bind("layerName", "color")

.bind("location", "loc")

.bind("zOrder")

.add(

new go.Shape({

width: 100, height: 100,

stroke: 'rgb(50,50,50)', fill: 'rgb(50,100,255)'

}),

new go.TextBlock({ font: "52px sans-serif", stroke: 'whitesmoke' })

.bind("text", "zOrder"),

go.GraphObject.build("Button", {

alignment: go.Spot.BottomLeft, alignmentFocus: go.Spot.BottomLeft,

click: (e, obj) => changeZOrder(-1, obj)

})

.add(

new go.Shape("LineH", { width: 14, height: 14 })

go.GraphObject.build("Button", {

alignment: go.Spot.BottomRight, alignmentFocus: go.Spot.BottomRight,

click: (e, obj) => changeZOrder(1, obj)

})

.add(

new go.Shape("PlusLine", { width: 14, height: 14 })

)

);

const array = [];

for (let i = 0; i < 12; i++) {

const data = { loc: new go.Point(Math.random()*500, Math.random()*200) };

data.zOrder = (Math.floor(Math.random()*20))

array.push(data);

}

diagram.model.nodeDataArray = array;

diagram.undoManager.isEnabled = true;

</code></pre>

goCode('zOrder', 610, 310);

</script>

</div>

<div>

<li>

<a href="../samples/index.html">Samples</a>

</li>

<li>

<a href="../learn/index.html">Learn</a>

</li>

<li>

<a href="../intro/index.html">Intro</a>

</li>

<li>

</li>

<li>

<a href="../changelog.html">Changelog</a>

</li>

<li>

<a href="https://github.com/NorthwoodsSoftware/GoJS" target="_blank" rel="noopener">GitHub</a>

</li>

</ul>

</div>

<div>

<h2 class="text-base font-semibold text-nwoods-primary">Support</h2>

<li>

<a href="https://nwoods.com/contact.html"

target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/contact.html', 'contact');">Contact</a>

</li>

<li>

<a href="https://forum.nwoods.com/c/gojs" target="_blank" rel="noopener">Forum</a>

</li>

<li>

<a href="https://nwoods.com/app/activate.aspx?sku=gojs" target="_blank" rel="noopener">Activate</a>

</li>

<li>

<a href="https://nwoods.com/sales/index.html"

target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/sales/index.html', 'buy');">Buy</a>

</li>

<li>

<a href="https://nwoods.com/register.html" target="_blank" rel="noopener">Register</a>

</li>

</ul>

</div>

<div>

<h2 class="text-base font-semibold text-nwoods-primary">Company</h2>

<li>

<a target="_blank" href="https://nwoods.com" target="_blank" rel="noopener">Northwoods</a>

</li>

<li>

<a target="_blank" href="https://nwoods.com/about.html" target="_blank" rel="noopener">About Us</a>

</li>

<li>

<a target="_blank" href="https://nwoods.com/contact.html" target="_blank" rel="noopener">Contact Us</a>

</li>

<li>

<a target="_blank" href="https://nwoods.com/consulting.html" target="_blank" rel="noopener">Consulting</a>

</li>

<li>

<a target="_blank" href="https://twitter.com/northwoodsgo" target="_blank" rel="noopener">Twitter</a>

</li>

</ul>

</div>

</p>

</div>

</footer>

</body>

window.dataLayer = window.dataLayer || [];

function gtag() {

dataLayer.push(arguments);

}

gtag('js', new Date());

gtag('config', 'G-S5QK8VSK84');

var getOutboundLink = function (url, label) {

gtag('event', 'click', {

'event_category': 'outbound',

'event_label': label,

'transport_type': 'beacon'

});

}

const params = new URL(document.location).searchParams

let a = params.get('a');

if (a) localStorage.setItem('a', a);

a = localStorage.getItem('a');

if (a) {

const links = [...document.body.getElementsByTagName("a")].filter((l) => l.href.includes('nwoods.com'));

for (const l of links) {

const url = new URL(l.href);

url.searchParams.set('a', a);

l.href = url;

}

</script>

document.addEventListener("DOMContentLoaded", function () {

if (window.go)

document

.getElementById('version')

.textContent = "GoJS version " + go.version;

if (window.goDoc)

window.goDoc();

var d = window.diagrams;

for (var i = 0; i < d.length; i++) {

var dargs = d[i];

goCodeExecute(dargs[0], dargs[1], dargs[2], dargs[3], dargs[4]);

}

if (window.extra)

window.extra();

}

);

</script>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

layers.html

Latest commit

History

layers.html

File metadata and controls