Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

  • IAnnotationEditorField

Index

Properties

Optional category

category: string

Optional category/group label in the editor.

Optional description

description: string

Optional help text shown as a tooltip where the default editor supports it.

id

id: string

Unique field identifier in the editor definition.

Optional isVisible

isVisible: (annotation: TAnnotation) => boolean

Optional visibility predicate for fields that only apply in some states.

Type declaration

    • (annotation: TAnnotation): boolean
    • Parameters

      • annotation: TAnnotation

      Returns boolean

label

label: string

Label shown in the editor.

Optional max

max: number

Optional max for number input.

Optional min

min: number

Optional min for number input.

Optional options

Options for enum/select fields.

Optional step

step: number

Optional step for number input.

type

Input type used for editing.

Methods

getValue

  • Reads field value from an annotation instance.

    Parameters

    • annotation: TAnnotation

    Returns TAnnotationEditorFieldValue

setValue

  • Writes field value back to annotation instance.

    Parameters

    Returns void

Generated using TypeDoc