Class NamedAction

constructor

• new NamedAction(
      options?: { action?: string } & {
          subActions?:
              | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
              | null;
      },
  ): NutrientViewer.Actions.NamedAction

  Parameters

  • Optionaloptions: { action?: string } & {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }

    • Optionalaction?: string

      The name of the action. This includes but is not limited to the following actions:

      Supported:

      • nextPage
      • prevPage
      • firstPage
      • lastPage
      • find
      • print
      • outline
      • search
      • zoomIn
      • zoomOut
      • saveAs
      • fullScreen
      • goBack
      • goForward

      Not supported:

      • goToPage
      • brightness
      • info
      • close
      • quit

    • OptionalsubActions?: NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null

  Returns NutrientViewer.Actions.NamedAction

OptionalsubActions

asImmutable

• asImmutable(): this

  Returns this

  See

  Map#asImmutable

asMutable

• asMutable(): this

  Returns this

  See

  Map#asMutable

clear

• clear(): this

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

  Returns this

delete

• delete<K extends "subActions">(key: K): 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 "subActions"

  Parameters

  • key: K

  Returns this

  Alias

  remove

deleteIn

• deleteIn(keyPath: Iterable<unknown>): this

  Parameters

  • keyPath: Iterable<unknown>

  Returns this

  Alias

  removeIn

equals

• equals(other: unknown): boolean

  Parameters

  • other: unknown

  Returns boolean

get

• get<K extends "subActions">(
      key: K,
  ): {
      subActions?:
          | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
          | null;
  }[K]

  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 "subActions"

  Parameters

  • key: K

  Returns {
      subActions?:
          | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
          | null;
  }[K]

getIn

• getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown

  Parameters

  • keyPath: Iterable<unknown>
  • OptionalnotSetValue: unknown

  Returns unknown

has

• has(key: unknown): boolean

  Parameters

  • key: unknown

  Returns boolean

merge

• merge(
      ...collections: Partial<
          {
              subActions?: | NutrientViewer.Immutable.List<
                  NutrientViewer.Actions.Action,
              >
              | null;
          },
      >[],
  ): this

  Parameters

  • ...collections: Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >[]

  Returns this

mergeDeep

• mergeDeep(
      ...collections: (
          | Iterable<[string, unknown], any, any>
          | Partial<
              {
                  subActions?: | NutrientViewer.Immutable.List<
                      NutrientViewer.Actions.Action,
                  >
                  | null;
              },
          >
      )[],
  ): this

  Parameters

  • ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[]

  Returns this

mergeDeepIn

• mergeDeepIn(
      keyPath: Iterable<unknown>,
      ...collections: (
          | Iterable<[string, unknown], any, any>
          | Partial<
              {
                  subActions?: | NutrientViewer.Immutable.List<
                      NutrientViewer.Actions.Action,
                  >
                  | null;
              },
          >
      )[],
  ): this

  Parameters

  • keyPath: Iterable<unknown>
  • ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[]

  Returns this

mergeDeepWith

• mergeDeepWith(
      merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
      ...collections: (
          | Iterable<[string, unknown], any, any>
          | Partial<
              {
                  subActions?: | NutrientViewer.Immutable.List<
                      NutrientViewer.Actions.Action,
                  >
                  | null;
              },
          >
      )[],
  ): this

  Parameters

  • merger: (previous?: unknown, next?: unknown, key?: string) => unknown
  • ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[]

  Returns this

mergeIn

• mergeIn(
      keyPath: Iterable<unknown>,
      ...collections: (
          | Iterable<[string, unknown], any, any>
          | Partial<
              {
                  subActions?: | NutrientViewer.Immutable.List<
                      NutrientViewer.Actions.Action,
                  >
                  | null;
              },
          >
      )[],
  ): this

  Parameters

  • keyPath: Iterable<unknown>
  • ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[]

  Returns this

mergeWith

• mergeWith(
      merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
      ...collections: (
          | Iterable<[string, unknown], any, any>
          | Partial<
              {
                  subActions?: | NutrientViewer.Immutable.List<
                      NutrientViewer.Actions.Action,
                  >
                  | null;
              },
          >
      )[],
  ): this

  Parameters

  • merger: (previous?: unknown, next?: unknown, key?: string) => unknown
  • ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[]

  Returns this

removeIn

• removeIn(keyPath: Iterable<unknown>): this

  Parameters

  • keyPath: Iterable<unknown>

  Returns this

set

• set<K extends "subActions">(
      key: K,
      value: {
          subActions?:
              | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
              | null;
      }[K],
  ): this

  Type Parameters

  • K extends "subActions"

  Parameters

  • key: K
  • value: {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }[K]

  Returns this

setIn

• setIn(keyPath: Iterable<unknown>, value: unknown): this

  Parameters

  • keyPath: Iterable<unknown>
  • value: unknown

  Returns this

toJS

• toJS(): {
      subActions?: | NutrientViewer.Immutable.List<
          NutrientViewer.Actions.Action,
      >
      | null;
  }

  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 {
      subActions?:
          | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
          | null;
  }

toJSON

• toJSON(): {
      subActions?: | NutrientViewer.Immutable.List<
          NutrientViewer.Actions.Action,
      >
      | null;
  }

  Shallowly converts this Record to equivalent native JavaScript Object.

  Returns {
      subActions?:
          | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
          | null;
  }

toSeq

• toSeq(): Keyed<string, unknown>

  Returns Keyed<string, unknown>

update

• update<K extends "subActions">(
      key: K,
      updater: (
          value: {
              subActions?:
                  | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
                  | null;
          }[K],
      ) => {
          subActions?: | NutrientViewer.Immutable.List<
              NutrientViewer.Actions.Action,
          >
          | null;
      }[K],
  ): this

  Type Parameters

  • K extends "subActions"

  Parameters

  • key: K
  • updater: (
        value: {
            subActions?:
                | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
                | null;
        }[K],
    ) => {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    }[K]

  Returns this

updateIn

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

withMutations

• withMutations(mutator: (mutable: this) => unknown): 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

  See

  Map#withMutations