@dokieli/web-annotation - v1.0.1
    Preparing search index...

    Interface SerializeOptions

    interface SerializeOptions {
        about?: string;
        headingLevel?: number;
        labels?: Partial<AnnotationLabels>;
        licenses?: Record<string, { name: string }>;
        motivationLabels?: Record<string, MotivationLabelOverride>;
        resolveImage?: (creator: Partial<AnnotationCreator>) => string | undefined;
        resolveLanguageName?: (code: string) => string | undefined;
        resolveName?: (creator: Partial<AnnotationCreator>) => string | undefined;
    }
    Index
    about? headingLevel? labels? licenses? motivationLabels? resolveImage? resolveLanguageName? resolveName?
    about?: string

    RDFa subject for <article about="...">. Defaults to annotation IRI, else #<id>

    headingLevel?: number

    Top heading level; body Note uses headingLevel + 1. Defaults to 1

    labels?: Partial<AnnotationLabels>

    Localized label overrides. Unset slots fall back to English

    licenses?: Record<string, { name: string }>

    Map of license IRI to display name

    motivationLabels?: Record<string, MotivationLabelOverride>

    Per-motivation overrides, keyed by motivation IRI

    resolveImage?: (creator: Partial<AnnotationCreator>) => string | undefined

    Resolve a display image for the creator. Return undefined to fall back to creator.image. No image means no avatar is rendered. Use for proxy URLs, contact lookups, etc.

    resolveLanguageName?: (code: string) => string | undefined

    Resolve a language code to a display name. Return undefined to fall back to the bare code.

    resolveName?: (creator: Partial<AnnotationCreator>) => string | undefined

    Resolve a display name for the creator. Return undefined to fall back to creator.name then creator.iri.

    Settings
    Member Visibility

    On This Page
    Properties