Type Alias AcApLayerByEntityResult

Type Declaration

• {
      layerName: string;
      ok: true;
      previousFrozen?: boolean;
      previousLocked?: boolean;
      previousOff?: boolean;
  }

  • layerName: string

    Name of the affected layer.

  • ok: true

    Operation succeeded.

  • OptionalpreviousFrozen?: boolean

    Frozen state before the operation, when applicable.

  • OptionalpreviousLocked?: boolean

    Locked state before the operation, when applicable.

  • OptionalpreviousOff?: boolean

    Off state before the operation, when applicable.

• {
      layerName?: string;
      ok: false;
      reason:
          | "invalid_selection"
          | "layer_not_found"
          | "cannot_change_current"
          | "already_frozen"
          | "already_off"
          | "already_locked"
          | "already_unlocked";
  }

  • OptionallayerName?: string

    Name of the layer involved, when known.

  • ok: false

    Operation failed or was a no-op.

  • reason:
        | "invalid_selection"
        | "layer_not_found"
        | "cannot_change_current"
        | "already_frozen"
        | "already_off"
        | "already_locked"
        | "already_unlocked"

    Failure reason:

    • invalid_selection — entity id does not resolve to a layer.
    • layer_not_found — entity layer is missing from the layer table.
    • cannot_change_current — current layer cannot be changed.
    • already_frozen / already_off / already_locked / already_unlocked.