Nutrient Web SDK
    Preparing search index...

    Class MeasurementScale

    MeasurementScale is a class that represents the scale of measurement annotations.

    It is an Immutable.Record and thus can be updated using set(key, value), for example: scale.set("fromValue", 15)

    Create and update a scale.

    const scale = new NutrientViewer.MeasurementScale({
    unitFrom: NutrientViewer.MeasurementScaleUnitFrom.Millimeters,
    unitTo: NutrientViewer.MeasurementScaleUnitTo.Inches,
    fromValue: 1,
    toValue: 10
    });
    const newScale = scale.set("fromValue", 2);
    newScale.fromValue // => 2

    Hierarchy

    • Record<
          {
              fromValue: number;
              toValue: number;
              unitFrom: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
          },
          this,
      > & Readonly<
          {
              fromValue: number;
              toValue: number;
              unitFrom: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
          },
      >
      • MeasurementScale
    Index

    Properties

    fromValue: number
    toValue: number
    unitFrom: "in" | "mm" | "cm" | "pt"
    unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi"

    Methods

    • Returns IterableIterator<
          [
              keyof {
                  fromValue: number;
                  toValue: number;
                  unitFrom: "in"
                  | "mm"
                  | "cm"
                  | "pt";
                  unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
              },
              number
              | "in"
              | "mm"
              | "cm"
              | "pt"
              | "ft"
              | "m"
              | "yd"
              | "km"
              | "mi",
          ],
      >

    • 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

      • K extends keyof {
            fromValue: number;
            toValue: number;
            unitFrom: "in" | "mm" | "cm" | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }

      Parameters

      • key: K

      Returns this

      remove

    • Parameters

      Returns this

      removeIn

    • Parameters

      • other: any

      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

      • K extends keyof {
            fromValue: number;
            toValue: number;
            unitFrom: "in" | "mm" | "cm" | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }

      Parameters

      • key: K
      • OptionalnotSetValue: any

      Returns {
          fromValue: number;
          toValue: number;
          unitFrom: "in" | "mm" | "cm" | "pt";
          unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
      }[K]

    • Type Parameters

      • T

      Parameters

      • key: string
      • notSetValue: T

      Returns T

    • Parameters

      Returns any

    • Parameters

      • key: string

      Returns key is "unitFrom" | "unitTo" | "fromValue" | "toValue"

    • Returns number

    • Parameters

      Returns boolean

    • Parameters

      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    fromValue: number;
                    toValue: number;
                    unitFrom: "in"
                    | "mm"
                    | "cm"
                    | "pt";
                    unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
                },
            >
        )[]

      Returns this

    • Parameters

      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    fromValue: number;
                    toValue: number;
                    unitFrom: "in"
                    | "mm"
                    | "cm"
                    | "pt";
                    unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
                },
            >
        )[]

      Returns this

    • Parameters

      • keyPath: Iterable<any>
      • ...collections: any[]

      Returns this

    • Parameters

      • merger: (oldVal: any, newVal: any, key: any) => any
      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    fromValue: number;
                    toValue: number;
                    unitFrom: "in"
                    | "mm"
                    | "cm"
                    | "pt";
                    unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
                },
            >
        )[]

      Returns this

    • Parameters

      • keyPath: Iterable<any>
      • ...collections: any[]

      Returns this

    • Parameters

      • merger: (
            oldVal: any,
            newVal: any,
            key: keyof {
                fromValue: number;
                toValue: number;
                unitFrom: "in" | "mm" | "cm" | "pt";
                unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
            },
        ) => any
      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    fromValue: number;
                    toValue: number;
                    unitFrom: "in"
                    | "mm"
                    | "cm"
                    | "pt";
                    unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
                },
            >
        )[]

      Returns this

    • Type Parameters

      • K extends keyof {
            fromValue: number;
            toValue: number;
            unitFrom: "in" | "mm" | "cm" | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }

      Parameters

      • key: K

      Returns this

    • Parameters

      Returns this

    • Type Parameters

      • K extends keyof {
            fromValue: number;
            toValue: number;
            unitFrom: "in" | "mm" | "cm" | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }

      Parameters

      • key: K
      • value: {
            fromValue: number;
            toValue: number;
            unitFrom: "in" | "mm" | "cm" | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }[K]

      Returns this

    • Parameters

      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 { fromValue: any; toValue: any; unitFrom: any; unitTo: any }

    • Shallowly converts this Record to equivalent native JavaScript Object.

      Returns {
          fromValue: number;
          toValue: number;
          unitFrom: "in" | "mm" | "cm" | "pt";
          unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
      }

    • Shallowly converts this Record to equivalent JavaScript Object.

      Returns {
          fromValue: number;
          toValue: number;
          unitFrom: "in" | "mm" | "cm" | "pt";
          unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
      }

    • Returns Keyed<
          keyof {
              fromValue: number;
              toValue: number;
              unitFrom: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
          },
          number
          | "in"
          | "mm"
          | "cm"
          | "pt"
          | "ft"
          | "m"
          | "yd"
          | "km"
          | "mi",
      >

    • Type Parameters

      • K extends keyof {
            fromValue: number;
            toValue: number;
            unitFrom: "in" | "mm" | "cm" | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }

      Parameters

      • key: K
      • updater: (
            value: {
                fromValue: number;
                toValue: number;
                unitFrom: "in" | "mm" | "cm" | "pt";
                unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
            }[K],
        ) => {
            fromValue: number;
            toValue: number;
            unitFrom: "in"
            | "mm"
            | "cm"
            | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }[K]

      Returns this

    • Parameters

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

      Returns this

    • Returns boolean

      Map#wasAltered

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

      Parameters

      • mutator: (mutable: this) => any

      Returns this

      Map#withMutations