Template:API Listing New

Jump to: navigation, search

A template that generates an overview listing.

It operates in two modes:

  1. by using a Semantic Media Query (if provided with a Query parameter), which creates a table. The header will say "API Name" unless Use_page_title is "Yes", in which case it will just say "Page".
  2. or by setting List_all_subpages to "Yes", which will spit out all subpages and descendants.
{{API_Listing|
Query=
Use_page_title= {Yes, No, ""}
List_all_subpages= {Yes, No, ""}
}}

Example:


API Name Summary
ApplicationCache The Application Cache (AppCache) lets web-based applications run offline. Developers can specify resources for the browser to cache, making them available to the application even if no connection can be made to the server. These resources load and work correctly even if users click the refresh button when they are offline.
AudioTrack AudioTrack is an object representing an audio portion of a video element.
AudioTrackList An AudioTrackList object represents a dynamic list of zero or more audio tracks, of which zero or more can be enabled at a time. Each audio track is represented by an AudioTrack object.
TextTracks A media element can have a group of associated text tracks, known as the media element's "list of text tracks".
TextTrackCue A text track cue is the unit of time-sensitive data in a text track corresponding, for instance, for subtitles and captions to the text that appear at a particular time and disappear at another time.
TextTrackCueList A TextTrackCueList object represents a dynamically updating list of text track cues in a given order.
TextTrackList A TextTrackList object represents a dynamically updating list of text tracks in a given order.
TimeRanges A TimeRanges object represents the collection of ranges (time periods) from the media resource that have been buffered or played. Ranges in a TimeRanges collection are sequential and not empty. Adjacent ranges are combined together to create longer ones.
TrackEvent A TrackEvent object exposes (via its track attribute) the track to which an event relates.
audio The audio object is part of the HTML5 audio api. It extends the <audio> tag and allows users to access audio data. This enables the ability to manipulate or create new audio data.
track
video
BatteryManager The object that exposes the battery status information.
NavigatorBattery The NavigatorBattery interface is exposed on the Navigator object.
CanvasGradient An opaque object of the canvas API.
CanvasPattern An opaque object of the canvas API. See Notes.
CanvasPixelArray Specifies each pixel within a canvas's rectangular selection, via the ImageData object's data property. The array uses four elements to represent each pixel's red, green, blue, and alpha channels. See Notes.
CanvasRenderingContext2D The 2D rendering context for the drawing surface of a <canvas> element.
ImageData The ImageData object of the canvas API.
TextMetrics The TextMetrics object of the canvas API. TextMetrics retrieves numeric informations like the width of a text that is drawn onto the canvas with the current font style.
CSSRegionStyleRule Represents an @region rule in a CSS style sheet, which applies styles to fragments of content that flow into a CSS region.
NamedFlow Represents content to flow among various block region elements. The NamedFlow interface allows access to both the content of the flow and the series of regions in which it displays, and helps determine if the content exceeds or falls short of the number of regions necessary to display it.
NamedFlowCollection Static snapshot array of a document's available named flows
Region The Region interface is available for any element that serves as a CSS region, whose flow-from CSS specifies it displays content from a named flow.
Blob The Blob object represents immutable raw data. It provides a method to slice data objects between ranges of bytes into further chunks of raw data.
File The File object provides information about files stored on the user's computer, and access to their contents. These are generally retrieved from a FileList object returned when a user selects files using the input element, or from a drag-and-drop operation's DataTransfer object.
FileError Represents an error that occurs while using the FileReader interface.

Obsolete per latest specification. Use DOMError instead.

FileList FileList is an object which represents an array of individually selected files from the underlying system.
FileReader The FileReader object lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using File or Blob objects to specify the file or data to read. File objects may be obtained from a FileList object returned as a result of a user selecting files using the input element, from a drag-and-drop operation's DataTransfer object, or from the mozGetAsFile() API on an HTMLCanvasElement.
FileReaderSync Allows for synchronous reading of File or Blob objects. Only available in Workers, as synchronous I/O would otherwise block the main application from executing.
MSStreamError Non-StandardThe MSStreamError object reports file-related errors asynchronously.

Obsolete per latest specification. Use DOMError instead.

MSStreamReader Non-StandardCreates random access data (Blob) from an MSStream object.
ObjectURLOptions Provides the oneTimeOnly property for use with the createObjectURL method.
URL A static object for URL related utility operations.
DirectoryEntry This interface represents a directory on a file system.
DirectoryEntrySync This interface represents a directory on a file system.
DirectoryReader This interface lets a user list files and directories in a directory.
DirectoryReaderSync This interface lets a user list files and directories in a directory.
EntriesCallback When readEntries() succeeds, this callback is made.
Entry An abstract interface representing entries in a file system, each of which may be a File or DirectoryEntry.
EntryCallback This interface is the callback used to look up Entry objects.
EntrySync An abstract interface representing entries in a file system, each of which may be a File or DirectoryEntry.
ErrorCallback When an error occurs, this callback is made.
FileCallback This interface is the callback used to obtain a File.
FileEntry This interface represents a file on a file system.
FileEntrySync This interface represents a file on a file system.
FileSystem In the File System API, a FileSystem object represents a file system. The object is the argument of a successful callback of requestFileSystem().
FileSystemCallback When requestFileSystem() succeeds, this callback is made.
FileSystemSync In the File System API, a FileSystemSync object represents a file system.
FileWriterCallback This interface is the callback used to create a FileWriter.
See more pages...