Nutrient Web SDK
    Preparing search index...

    Properties of the arrow line attached to a callout (text) annotation.

    Hierarchy

    • InheritableImmutableRecord<
          {
              cap: | "square"
              | "circle"
              | "diamond"
              | "openArrow"
              | "closedArrow"
              | "butt"
              | "reverseOpenArrow"
              | "reverseClosedArrow"
              | "slash"
              | null;
              end: NutrientViewer.Geometry.Point
              | null;
              innerRectInset: NutrientViewer.Geometry.Inset | null;
              knee: NutrientViewer.Geometry.Point | null;
              start: NutrientViewer.Geometry.Point | null;
          },
      >
      • Callout
    Index

    Constructors

    • Parameters

      • Optionalvalues:
            | Iterable<[string, unknown], any, any>
            | Partial<
                {
                    cap: | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                    end: NutrientViewer.Geometry.Point
                    | null;
                    innerRectInset: NutrientViewer.Geometry.Inset | null;
                    knee: NutrientViewer.Geometry.Point | null;
                    start: NutrientViewer.Geometry.Point | null;
                },
            >

      Returns Callout

    Properties

    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null

    The line cap style.

    Ending point of the arrow line.

    innerRectInset: NutrientViewer.Geometry.Inset | null

    The inner rectangle inset.

    Knee point of the arrow line.

    Starting point of the arrow line.

    defaultValues: {
        cap:
            | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
        end: NutrientViewer.Geometry.Point
        | null;
        innerRectInset: NutrientViewer.Geometry.Inset | null;
        knee: NutrientViewer.Geometry.Point | null;
        start: NutrientViewer.Geometry.Point | null;
    } = ...

    Methods

    • Returns this

      Map#asImmutable

    • Returns this

      Map#asMutable

    • Returns a new instance of this Record type with all values set to their default values.

      Returns this

    • Returns a new instance of this Record type with the value for the specific key set to its default value.

      Type Parameters

      Parameters

      • key: K

      Returns this

      remove

    • Parameters

      Returns this

      removeIn

    • Parameters

      • other: unknown

      Returns boolean

    • Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

      If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

      Type Parameters

      Parameters

      • key: K

      Returns {
          cap:
              | "square"
              | "circle"
              | "diamond"
              | "openArrow"
              | "closedArrow"
              | "butt"
              | "reverseOpenArrow"
              | "reverseClosedArrow"
              | "slash"
              | null;
          end: NutrientViewer.Geometry.Point
          | null;
          innerRectInset: NutrientViewer.Geometry.Inset | null;
          knee: NutrientViewer.Geometry.Point | null;
          start: NutrientViewer.Geometry.Point | null;
      }[K]

    • Parameters

      • keyPath: Iterable<unknown>
      • OptionalnotSetValue: unknown

      Returns unknown

    • Parameters

      • key: unknown

      Returns boolean

    • Parameters

      • ...collections: Partial<
            {
                cap: | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            },
        >[]

      Returns this

    • Parameters

      • ...collections: (
            | Iterable<[string, unknown], any, any>
            | Partial<
                {
                    cap: | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                    end: NutrientViewer.Geometry.Point
                    | null;
                    innerRectInset: NutrientViewer.Geometry.Inset | null;
                    knee: NutrientViewer.Geometry.Point | null;
                    start: NutrientViewer.Geometry.Point | null;
                },
            >
        )[]

      Returns this

    • Parameters

      • keyPath: Iterable<unknown>
      • ...collections: (
            | Iterable<[string, unknown], any, any>
            | Partial<
                {
                    cap: | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                    end: NutrientViewer.Geometry.Point
                    | null;
                    innerRectInset: NutrientViewer.Geometry.Inset | null;
                    knee: NutrientViewer.Geometry.Point | null;
                    start: NutrientViewer.Geometry.Point | null;
                },
            >
        )[]

      Returns this

    • Parameters

      • merger: (previous?: unknown, next?: unknown, key?: string) => unknown
      • ...collections: (
            | Iterable<[string, unknown], any, any>
            | Partial<
                {
                    cap: | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                    end: NutrientViewer.Geometry.Point
                    | null;
                    innerRectInset: NutrientViewer.Geometry.Inset | null;
                    knee: NutrientViewer.Geometry.Point | null;
                    start: NutrientViewer.Geometry.Point | null;
                },
            >
        )[]

      Returns this

    • Parameters

      • keyPath: Iterable<unknown>
      • ...collections: (
            | Iterable<[string, unknown], any, any>
            | Partial<
                {
                    cap: | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                    end: NutrientViewer.Geometry.Point
                    | null;
                    innerRectInset: NutrientViewer.Geometry.Inset | null;
                    knee: NutrientViewer.Geometry.Point | null;
                    start: NutrientViewer.Geometry.Point | null;
                },
            >
        )[]

      Returns this

    • Parameters

      • merger: (previous?: unknown, next?: unknown, key?: string) => unknown
      • ...collections: (
            | Iterable<[string, unknown], any, any>
            | Partial<
                {
                    cap: | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                    end: NutrientViewer.Geometry.Point
                    | null;
                    innerRectInset: NutrientViewer.Geometry.Inset | null;
                    knee: NutrientViewer.Geometry.Point | null;
                    start: NutrientViewer.Geometry.Point | null;
                },
            >
        )[]

      Returns this

    • Parameters

      Returns this

    • Type Parameters

      Parameters

      Returns this

    • Parameters

      • keyPath: Iterable<unknown>
      • value: unknown

      Returns this

    • Deeply converts this Record to equivalent native JavaScript Object.

      Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

      Returns {
          cap:
              | "square"
              | "circle"
              | "diamond"
              | "openArrow"
              | "closedArrow"
              | "butt"
              | "reverseOpenArrow"
              | "reverseClosedArrow"
              | "slash"
              | null;
          end: NutrientViewer.Geometry.Point
          | null;
          innerRectInset: NutrientViewer.Geometry.Inset | null;
          knee: NutrientViewer.Geometry.Point | null;
          start: NutrientViewer.Geometry.Point | null;
      }

    • Shallowly converts this Record to equivalent native JavaScript Object.

      Returns {
          cap:
              | "square"
              | "circle"
              | "diamond"
              | "openArrow"
              | "closedArrow"
              | "butt"
              | "reverseOpenArrow"
              | "reverseClosedArrow"
              | "slash"
              | null;
          end: NutrientViewer.Geometry.Point
          | null;
          innerRectInset: NutrientViewer.Geometry.Inset | null;
          knee: NutrientViewer.Geometry.Point | null;
          start: NutrientViewer.Geometry.Point | null;
      }

    • Returns Keyed<string, unknown>

    • Type Parameters

      Parameters

      • key: K
      • updater: (
            value: {
                cap:
                    | "square"
                    | "circle"
                    | "diamond"
                    | "openArrow"
                    | "closedArrow"
                    | "butt"
                    | "reverseOpenArrow"
                    | "reverseClosedArrow"
                    | "slash"
                    | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            }[K],
        ) => {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        }[K]

      Returns this

    • Parameters

      • keyPath: Iterable<unknown>
      • notSetValue: unknown
      • updater: (value: unknown) => unknown

      Returns this

    • Parameters

      • keyPath: Iterable<unknown>
      • updater: (value: unknown) => unknown

      Returns this

    • Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.

      Parameters

      • mutator: (mutable: this) => unknown

      Returns this

      Map#withMutations