Class HideAction

PDF action to hide an annotation or form field.

It is an Immutable.Record and thus can be updated using set(key, value), for example: action.set("hide", true);.

When clicking on an annotation with a HideAction, the annotations specified in its annotationReferences property will be hidden.

Example

Create a new HideAction

const action = new NutrientViewer.Actions.HideAction({ hide: true });

Hierarchy

NutrientViewer.Actions.Action
- HideAction

Index

Constructors

constructor

new HideAction(
    options?: {
        annotationReferences?: NutrientViewer.Immutable.List<
            AnnotationReference,
        >;
        hide?: boolean;
        subActions?: | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
    },
): NutrientViewer.Actions.HideAction
Parameters
- Optionaloptions: {
      annotationReferences?: NutrientViewer.Immutable.List<
          AnnotationReference,
      >;
      hide?: boolean;
      subActions?: | null
      | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
  }
Returns NutrientViewer.Actions.HideAction
Overrides Action.constructor

Properties

annotationReferences

annotationReferences: NutrientViewer.Immutable.List<AnnotationReference>

A list of references to annotations, either via the pdfObjectId or a form field name.

hide

hide: boolean

If true, the action will hide the annotation, otherwise it will show it.

`Optional`subActions

subActions?: null | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> = null

Actions can be chained by adding them to this immutable List.

Methods

asImmutable

asImmutable(): this
Returns this
Inherited from Action.asImmutable

asMutable

asMutable(): this
Returns this
Inherited from Action.asMutable

clear

clear(): this
Returns this
Inherited from Action.clear

delete

delete<K extends "subActions">(key: K): this
Type Parameters
- K extends "subActions"
Parameters
- key: K
Returns this
Inherited from Action.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Inherited from Action.deleteIn

equals

equals(other: unknown): boolean
Parameters
- other: unknown
Returns boolean
Inherited from Action.equals

get

get<K extends "subActions">(
    key: K,
): {
    subActions?:
        | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}[K]
Type Parameters
- K extends "subActions"
Parameters
- key: K
Returns {
    subActions?:
        | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}[K]
Inherited from Action.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
- keyPath: Iterable<unknown>
- OptionalnotSetValue: unknown
Returns unknown
Inherited from Action.getIn

has

has(key: unknown): boolean
Parameters
- key: unknown
Returns boolean
Inherited from Action.has

merge

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

mergeDeep

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

mergeDeepIn

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

mergeDeepWith

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

mergeIn

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

mergeWith

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

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Inherited from Action.removeIn

set

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

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
- keyPath: Iterable<unknown>
- value: unknown
Returns this
Inherited from Action.setIn

toJS

toJS(): {
    subActions?: | null
    | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}
Returns {
    subActions?:
        | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}
Inherited from Action.toJS

toJSON

toJSON(): {
    subActions?: | null
    | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}
Returns {
    subActions?:
        | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}
Inherited from Action.toJSON

toSeq

toSeq(): Keyed<string, unknown>
Returns Keyed<string, unknown>
Inherited from Action.toSeq

update

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

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): this
Parameters
- keyPath: Iterable<unknown>
- notSetValue: unknown
- updater: (value: unknown) => unknown
Returns this
Inherited from Action.updateIn
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
- keyPath: Iterable<unknown>
- updater: (value: unknown) => unknown
Returns this
Inherited from Action.updateIn

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Parameters
- mutator: (mutable: this) => unknown
Returns this
Inherited from Action.withMutations

Class HideAction

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Actions.HideAction

Properties

annotationReferences

hide

OptionalsubActions

Methods

asImmutable

Returns this

asMutable

Returns this

clear

Returns this

delete

Type Parameters

Parameters

Returns this

deleteIn

Parameters

Returns this

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

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

getIn

Parameters

Returns unknown

has

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

removeIn

Parameters

Returns this

set

Type Parameters

Parameters

Returns this

setIn

Parameters

Returns this

toJS

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

toJSON

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

toSeq

Returns Keyed<string, unknown>

update

Type Parameters

Parameters

Returns this

`Optional`subActions

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

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

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