About the yFiles for HTML Documentation

This documentation was designed to quickly find relevant information in the yFiles for HTML API and the Developer's Guide while working on a yFiles for HTML project.

The Search Box and the Member Filter are tools that allow for an easy access of API types, members, fields, constants, events, and chapters in the Developer's Guide

The Search Box

The search box on top is a powerful tool. It provides various ways for quickly finding APIs and documentation.

Entering text in the search box without pressing ENTER will search the public API member names, as well as the Developer's Guide topics. This type of search supports camel-case searching.

Graph

will show the type Graph, but also the main interface IGraph, as well as members(properties, constructors, methods, events) containing the word "graph" in the search preview. In addition, Developer's Guide topics like "Graph Structure" are shown.

GEIM

will show matching types based on camel-casing, so GraphEditorInputMode will be shown

GraphEIM

will show matching members like "GraphEditorInputMode".

Just enter the search string and use the up and down keys to select the desired match. Hit enter to directly switch to that entry.

Hitting enter in the search box will open the search results page. Here, a full-text search is performed. Words can be put in double quotes for exact matches, otherwise fuzzy matches are made. Camel-case matches are performed for single-word searches, only.

The search results are categorized into the following categories:

• types that have the search term in their description or name
• type members that have the terms in their name and description
• chapters in the Developer's Guide that have the terms in their text
• demo applications that include the terms in their description

Member Navigation and Filtering

The panel on the left shows an alphabetical list of constructors, methods, default methods, properties, and events for each API type and a table of content for pages of the Developer's Guide. Selecting an entry in the list or a chapter in the Developer's Guide will automatically scroll to the respective item.

Use the filter box on top of the left panel to filter the listed type members or chapters. CTRL+F12 will focus the input field.

Feedback

Please feel free to provide feedback about this tool to support@yworks.com.