Readonly
accessReadonly
assignedReadonly
ATTRIBUTE_Readonly
attributesReadonly
attributeReadonly
bareboneWritable Svelte store indicating if barebone texture downloading is enabled (lower quality, less bandwidth).
Readonly
baseURIReturns node's node document's document base URL.
Readonly
canvasThe controller managing the HTML <canvas>
element, resizing, and viewport.
Readonly
canvasesArray holding all instantiated MicrioImage objects managed by this element.
Readonly
CDATA_node is a CDATASection node.
Readonly
childReadonly
childReturns the children.
Readonly
childrenReturns the child elements.
Readonly
classAllows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns the value of element's class content attribute. Can be set to change it.
Readonly
clientReadonly
clientReadonly
clientReadonly
clientReadonly
COMMENT_node is a Comment node.
Readonly
currentWritable Svelte store holding the currently active main MicrioImage.
Use <micr-io>.open()
to change the active image.
Subscribe to this store to react to image changes.
Access the current value directly using the $current getter.
Readonly
datasetOptional
defaultCustom settings object provided programmatically, overriding server-fetched settings.
Readonly
DOCUMENT_node is a DocumentFragment node.
Readonly
DOCUMENT_node is a document.
Readonly
DOCUMENT_Set when other is a descendant of node.
Readonly
DOCUMENT_Set when other is an ancestor of node.
Readonly
DOCUMENT_Set when node and other are not in the same tree.
Readonly
DOCUMENT_Set when other is following node.
Readonly
DOCUMENT_Readonly
DOCUMENT_Set when other is preceding node.
Readonly
DOCUMENT_node is a doctype.
Readonly
ELEMENT_node is an element.
Readonly
ENTITY_Readonly
ENTITY_Readonly
eventsThe controller managing user input events (mouse, touch, keyboard) and dispatching custom events.
Readonly
firstReturns the first child.
Readonly
firstReturns the first child that is an element, and null otherwise.
Holds loaded grid info data if applicable.
Returns the value of element's id content attribute. Can be set to change it.
Readonly
isReturns true if node is connected and false otherwise.
Readonly
isReadonly
lastReturns the last child.
Readonly
lastReturns the last child that is an element, and null otherwise.
Readonly
localReturns the local name.
Readonly
namespaceURIReturns the namespace.
Readonly
nextReturns the first following sibling that is an element, and null otherwise.
Readonly
nextReturns the next sibling.
Readonly
nodeReturns a string appropriate for the type of node.
Readonly
nodeReturns the type of node.
Optional
nonceReadonly
NOTATION_Readonly
offsetReadonly
offsetReadonly
offsetReadonly
offsetReadonly
offsetFires when the user aborts the download.
The event.
Fires when the object loses the input focus.
The focus event.
Occurs when playback is possible, but would require further buffering.
The event.
Fires when the contents of the object or selection have changed.
The event.
Fires when the user clicks the left mouse button on the object
The mouse event.
Fires when the user clicks the right mouse button in the client area, opening the context menu.
The mouse event.
Fires when the user double-clicks the object.
The mouse event.
Fires on the source object continuously during a drag operation.
The event.
Fires on the source object when the user releases the mouse at the close of a drag operation.
The event.
Fires on the target element when the user drags the object to a valid drop target.
The drag event.
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
The drag event.
Fires on the target element continuously while the user drags the object over a valid drop target.
The event.
Fires on the source object when the user starts to drag a text selection or selected object.
The event.
Occurs when the duration attribute is updated.
The event.
Occurs when the media element is reset to its initial state.
The event.
Occurs when the end of playback is reached.
The event
Fires when an error occurs during object loading.
Fires when the object receives focus.
The event.
Fires when the user presses a key.
The keyboard event
Fires when the user presses an alphanumeric key.
The event.
Fires when the user releases a key.
The keyboard event
Fires immediately after the browser loads the object.
The event.
Occurs when media data is loaded at the current playback position.
The event.
Occurs when the duration and dimensions of the media have been determined.
The event.
Occurs when Internet Explorer begins looking for media data.
The event.
Fires when the user clicks the object with either mouse button.
The mouse event.
Fires when the user moves the mouse over the object.
The mouse event.
Fires when the user moves the mouse pointer outside the boundaries of the object.
The mouse event.
Fires when the user moves the mouse pointer into the object.
The mouse event.
Fires when the user releases a mouse button while the mouse is over the object.
The mouse event.
Occurs when playback is paused.
The event.
Occurs when the play method is requested.
The event.
Occurs when the audio or video has started playing.
The event.
Occurs to indicate progress while downloading media data.
The event.
Occurs when the playback rate is increased or decreased.
The event.
Fires when the user resets a form.
The event.
Fires when the user repositions the scroll box in the scroll bar on the object.
The event.
Occurs when the seek operation ends.
The event.
Occurs when the current playback position is moved.
The event.
Fires when the current selection changes.
The event.
Occurs when the download has stopped.
The event.
Occurs if the load operation has been intentionally halted.
The event.
Occurs to indicate the current playback position.
The event.
Optional
ontouchcancelOptional
ontouchendOptional
ontouchmoveOptional
ontouchstartOccurs when the volume is changed, or playback is muted or unmuted.
The event.
Occurs when playback stops because the next frame of a video resource is not available.
The event.
Readonly
ownerReturns the node document. Returns null for documents.
Readonly
parentReturns the parent element.
Readonly
parentReturns the parent.
Readonly
partReadonly
prefixReturns the namespace prefix.
Readonly
previousReturns the first preceding sibling that is an element, and null otherwise.
Readonly
previousReturns the previous sibling.
Readonly
PROCESSING_node is a ProcessingInstruction node.
Readonly
scrollReadonly
scrollReadonly
shadowReturns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Returns the value of element's slot content attribute. Can be set to change it.
Holds data for the current 360 space, if applicable (loaded via data-space
attribute or API).
Readonly
stateThe main state manager, providing access to various application states (UI visibility, active marker, tour, etc.). See State.Main.
Readonly
styleReadonly
tagReturns the HTML-uppercased qualified name.
Readonly
TEXT_node is a Text node.
Readonly
visibleWritable Svelte store holding an array of currently visible MicrioImage instances (relevant for split-screen or grid).
Static
jsonStatic cache store for downloaded JSON files (like image info).
Static
VERSIONThe Micrio library version number.
Getter for the current value of the current store. Provides direct access to the active MicrioImage instance.
Getter for the current language code.
Setter for the current language code. Triggers language change logic.
Static
observedObserved attributes trigger attributeChangedCallback
when changed.
Optional
options: boolean | AddEventListenerOptionsOptional
options: boolean | AddEventListenerOptionsOptional
options: boolean | AddEventListenerOptionsCloses an opened MicrioImage. For split-screen images, it triggers the split-end transition. For main images, it removes the canvas from the Wasm controller.
The MicrioImage instance to close.
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
Opens a Micrio image by its ID or by providing partial image info data. This is the primary method for loading and displaying images.
An image ID string (e.g., 'abcdef123') or a partial Models.ImageInfo.ImageInfo object.
Options for opening the image.
Optional
gridIf true, keeps the grid view active instead of focusing on the opened image.
Optional
isIf true, opens the split-screen view passively (doesn't take focus).
Optional
splitIf true, opens the image as a secondary split-screen view.
Optional
splitThe primary image when opening in split-screen mode. Defaults to the current main image.
Optional
startAn optional starting view [x0, y0, x1, y1]
to apply immediately.
Optional
vector?: VectorFor 360 transitions, provides the direction vector from the previous image.
The MicrioImage instance being opened.
Returns the first element that is a descendant of node that matches selectors.
Returns all element descendants of node that match selectors.
Optional
options: boolean | EventListenerOptionsOptional
options: boolean | EventListenerOptionsOptional
options: boolean | EventListenerOptionsDisplays element fullscreen and resolves promise when done.
When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.
Optional
options: FullscreenOptionsIf force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.
Returns true if qualifiedName is now present, and false otherwise.
Optional
force: boolean
The main Micrio custom HTML element
<micr-io>
. This class acts as the central controller for the Micrio viewer, managing the WebGL canvas, WebAssembly module, Svelte UI, state, events, and image loading.It orchestrates the interaction between different parts of the library and exposes methods and properties for controlling the viewer.
Example
[[include:./ts/element.md]]
Author
Marcel Duin marcel@micr.io