CornerAnnotation

Source (.js)Source (.d.ts)

Introduction

vtkCornerAnnotation is a DOM overlay that displays text in the four corners and the four sides of a container. Each slot is filled by a template function evaluated against the annotation metadata.

Methods

extend

Method used to decorate a given object (publicAPI+model) with vtkCornerAnnotation characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	ICornerAnnotationInitialValues	No	(default: {})

getAnnotationContainer

Root element holding the nine annotation slots.

newInstance

Method used to create a new instance of vtkCornerAnnotation.

Argument	Type	Required	Description
initialValues	ICornerAnnotationInitialValues	No	for pre-setting some of its content

resize

No-op kept for API symmetry with the other UI widgets.

setContainer

Attach the annotation container to the given DOM element, detaching it from any previously set one.

Argument	Type	Required	Description
el		Yes

updateMetadata

Merge the given metadata into the current one and re-render.

Argument	Type	Required	Description
metadata	CornerAnnotationMetadata	Yes

updateTemplates

Merge the given templates into the current ones and re-render.

Argument	Type	Required	Description
templates	ICornerAnnotationTemplates	Yes