public class | source

FZPView

FZPView class is used by the fzp breadboard, pcb and schematics view.

Example:

const {FZPView} = require('fzp-js')

let view = new FZPView()

Constructor Summary

Public Constructor
public	constructor(image: String, ids: Array, flipH: Boolean, flipV: Boolean, svg: String) FZPView constructor

Member Summary

Public Members
public	flipHorizontal: Boolean FZPView flip horizontal
public	flipVertical: Boolean FZPView flip vertical
public	image: String The FZPView image
public	layerIds: Array The FZPView layer id's
public	svg: String The FZPView svg data

Method Summary

Public Methods
public	existLayerId(id: String): Boolean Check if a layer id exist at the FZPView layerIds array
public	loadSVG(baseurl: String): Promise load the svg of the image path from the fritzing-parts api
public	setImage(src: String): FZPView Set the FZPView image source
public	setLayerId(name: String): FZPView Add a layer id to the FZPView
public	setSVG(data: String): FZPView Set the svg data
public	totalLayerId(): Number Get the total number of FZPView layer id's

Public Constructors

public constructor(image: String, ids: Array, flipH: Boolean, flipV: Boolean, svg: String) source

FZPView constructor

Params:

Name	Type	Attribute	Description
image	String
ids	Array
flipH	Boolean
flipV	Boolean
svg	String		The raw svg string

Public Members

public flipHorizontal: Boolean source

FZPView flip horizontal

public flipVertical: Boolean source

FZPView flip vertical

public image: String source

The FZPView image

public layerIds: Array source

The FZPView layer id's

public svg: String source

The FZPView svg data

Public Methods

public existLayerId(id: String): Boolean source

Check if a layer id exist at the FZPView layerIds array

Params:

Name	Type	Attribute	Description
id	String

Return:

Boolean

public loadSVG(baseurl: String): Promise source

load the svg of the image path from the fritzing-parts api

Params:

Name	Type	Attribute	Description
baseurl	String		the url to the fritzing-parts/core directory

Return:

Promise

public setImage(src: String): FZPView source

Set the FZPView image source

Params:

Name	Type	Attribute	Description
src	String		The image source

Return:

FZPView

public setLayerId(name: String): FZPView source

Add a layer id to the FZPView

Params:

Name	Type	Attribute	Description
name	String		The layer name

Return:

FZPView

public setSVG(data: String): FZPView source

Set the svg data

Params:

Name	Type	Attribute	Description
data	String		The SVG data

Return:

FZPView

public totalLayerId(): Number source

Get the total number of FZPView layer id's

Return:

Number