Class Layer

constructor

• new Layer(
      name: string,
      index: number,
      pageId?: string,
      pkg?: VisioPackage,
      modifier?: ShapeModifier,
      _visible?: boolean,
      _locked?: boolean,
      _print?: boolean,
  ): Layer

  Parameters

  • name: string
  • index: number
  • OptionalpageId: string
  • Optionalpkg: VisioPackage
  • Optionalmodifier: ShapeModifier
  • _visible: boolean = true
  • _locked: boolean = false
  • _print: boolean = true

  Returns Layer

index

name

locked

• get locked(): boolean

  Whether the layer is currently locked.

  Returns boolean

print

• get print(): boolean

  Whether shapes on this layer are included when printing.

  Returns boolean

visible

• get visible(): boolean

  Whether the layer is currently visible.

  Returns boolean

delete

• delete(): Promise<void>

  Delete this layer from the page. Removes the layer definition and strips it from all shape LayerMember cells.

  Returns Promise<void>

hide

• hide(): Promise<Layer>

  Returns Promise<Layer>

rename

• rename(newName: string): Promise<Layer>

  Rename this layer.

  Parameters

  • newName: string

  Returns Promise<Layer>

setLocked

• setLocked(locked: boolean): Promise<Layer>

  Parameters

  • locked: boolean

  Returns Promise<Layer>

setVisible

• setVisible(visible: boolean): Promise<Layer>

  Parameters

  • visible: boolean

  Returns Promise<Layer>

show

• show(): Promise<Layer>

  Returns Promise<Layer>