Skip to content

Documentation / @expofp/schema / FpLayer

Type Alias: FpLayer ​

ts
type FpLayer = object;

One __fpLayers entry (consumed by store/init/init-layers.ts). name also derives the layer's file and global names: fp.svg.<name>.js, __fp<name>, __fpPaths<name>. mode is the numeric LayerMode enum (0 Unset, 1 AlwaysVisible, 2 AlwaysHidden, 3 TurnedOn, 4 TurnedOff — store/LayerStore.ts).

Type Declaration ​

Index Signature ​

ts
[key: string]: unknown

description? ​

ts
optional description?: string;

floorIndex? ​

ts
optional floorIndex?: number | null;

frozen? ​

ts
optional frozen?: boolean;

mode? ​

ts
optional mode?: number | null;

name ​

ts
name: string;

rect? ​

ts
optional rect?: 
  | {
[key: string]: unknown;
  angle?: number;
  x1: number;
  x2: number;
  y1: number;
  y2: number;
}
  | null;

Union Members ​

Type Literal ​
ts
{
[key: string]: unknown;
  angle?: number;
  x1: number;
  x2: number;
  y1: number;
  y2: number;
}
Index Signature ​
ts
[key: string]: unknown
angle? ​
ts
optional angle?: number;

Rotation — present on layer viewboxes.

x1 ​
ts
x1: number;
x2 ​
ts
x2: number;
y1 ​
ts
y1: number;
y2 ​
ts
y2: number;

null

viewbox? ​

ts
optional viewbox?: 
  | {
[key: string]: unknown;
  angle?: number;
  x1: number;
  x2: number;
  y1: number;
  y2: number;
}
  | null;

Union Members ​

Type Literal ​
ts
{
[key: string]: unknown;
  angle?: number;
  x1: number;
  x2: number;
  y1: number;
  y2: number;
}
Index Signature ​
ts
[key: string]: unknown
angle? ​
ts
optional angle?: number;

Rotation — present on layer viewboxes.

x1 ​
ts
x1: number;
x2 ​
ts
x2: number;
y1 ​
ts
y1: number;
y2 ​
ts
y2: number;

null