public class | source

FZP

The FZP class is the main fzp data entry. Here you can access the main data properties/objects and some utility functions can be used to load svgs as string, count the total number of connections or set a connector.

Example:

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

let fzp = new FZP({moduleId: 'sample'})
fzp.version = '1.0.0'
fzp.setTag('demo')
fzp.setProperty('p', 'hello', true)
fzp.setView()
fzp.setConnector()
fzp.setBus()

Constructor Summary

Public Constructor
public	constructor(opt: Object) FZP constructor has an opt argument object that can be used to setup data at the initialization.

Member Summary

Public Members
public	author: String The FZP author
public	buses: Object The FZP buses is a map with instances of the Bus class.
public	connectors: Object The FZP connectors
public	date: String The FZP date
public	description: String The FZP description
public	family: String The FZP family
public	fritzingVersion: String The FZP fritzing version
public	label: String The FZP label
public	language: String The FZP language
public	moduleId: String The FZP module id
public	properties: Object The FZP properties
public	tags: Array The FZP tags
public	taxonomy: String The FZP taxonomy
public	title: String The FZP title
public	url: String The FZP url
public	variant: String The FZP variant
public	version: String The FZP version
public	views: Object The FZP views (icon, breadboard, schematic, pcb)

Method Summary

Public Methods
public	getProperty(key: String): FZPProperty Get a FZP property by the given key.
public	loadSVGs(baseurl: String): FZP Load all SVG sources.
public	setBus(name: String, bus: FZPBus): FZP setBus
public	setConnector(name: String, connector: FZPConnector): FZP setConnector
public	setProperty(key: String, value: String, showInLabel: Boolean): FZP Create or update a FZPProperty instance to the FZP.
public	setTag(tag: String): FZP Set a tag
public	setView(name: String, view: FZPView): FZP Set a view
public	totalBuses(): Number Get the total number of buses.
public	totalConnector(): Number Get the total number of connector.
public	totalProperties(): Number Get the total number of properties.
public	totalTags(): Number Get the total number of tags.

Public Constructors

public constructor(opt: Object) source

FZP constructor has an opt argument object that can be used to setup data at the initialization.

Params:

Name	Type	Attribute	Description
opt	Object

Public Members

public author: String source

The FZP author

public buses: Object source

The FZP buses is a map with instances of the Bus class.

public connectors: Object source

The FZP connectors

public date: String source

The FZP date

public description: String source

The FZP description

public family: String source

The FZP family

public fritzingVersion: String source

The FZP fritzing version

public label: String source

The FZP label

public language: String source

The FZP language

public moduleId: String source

The FZP module id

public properties: Object source

The FZP properties

public tags: Array source

The FZP tags

public taxonomy: String source

The FZP taxonomy

public title: String source

The FZP title

public url: String source

The FZP url

public variant: String source

The FZP variant

public version: String source

The FZP version

public views: Object source

The FZP views (icon, breadboard, schematic, pcb)

Public Methods

public getProperty(key: String): FZPProperty source

Get a FZP property by the given key.

Params:

Name	Type	Attribute	Description
key	String

Return:

FZPProperty

public loadSVGs(baseurl: String): FZP source

Load all SVG sources.

Params:

Name	Type	Attribute	Description
baseurl	String

Return:

FZP

public setBus(name: String, bus: FZPBus): FZP source

setBus

Params:

Name	Type	Attribute	Description
name	String
bus	FZPBus

Return:

FZP

public setConnector(name: String, connector: FZPConnector): FZP source

setConnector

Params:

Name	Type	Attribute	Description
name	String
connector	FZPConnector

Return:

FZP

public setProperty(key: String, value: String, showInLabel: Boolean): FZP source

Create or update a FZPProperty instance to the FZP.

Params:

Name	Type	Attribute	Description
key	String
value	String
showInLabel	Boolean

Return:

FZP

public setTag(tag: String): FZP source

Set a tag

Params:

Name	Type	Attribute	Description
tag	String

Return:

FZP

public setView(name: String, view: FZPView): FZP source

Set a view

Params:

Name	Type	Attribute	Description
name	String		The name of the view can be 'breadboard', 'pcb', or 'schematic'
view	FZPView

Return:

FZP

public totalBuses(): Number source

Get the total number of buses.

Return:

Number

public totalConnector(): Number source

Get the total number of connector.

Return:

Number

public totalProperties(): Number source

Get the total number of properties.

Return:

Number

public totalTags(): Number source

Get the total number of tags.

Return:

Number