1.0.5 • Published 6 years ago

@astrouxds/rux-spectrum-analyzer v1.0.5

Weekly downloads
1
License
GPL-3.0
Repository
-
Last release
6 years ago

Spectrum Analyzer (aka "Spec A")

RUX Spectrum Analyzer leverages both Web Components and the D3 data visualization library to create classic, animated "Spec A" instances.

##Guidelines

##Installation npm i @astrouxds/rux-spectrum-analyzer

##Usage ###Import the RUX Spectrum Analyzer

import { RuxSpectrumAnalyzer } from "@astrouxds/rux-spectrum-analyzer/rux-spectrum-analyzer.js";

###Basic HTML Usage RUX Spectrum Analyzer

<rux-spectrum-analyzer chart-legend-x="freq" chart-legend-y="pwr" chart-title="signals" height="384" width="900" x-scale-min="900" x-scale-max="2301" x-scale-step="175" y-scale-min="-30" y-scale-max="0" data-source="wss://satellite-1.astrouxds.com" data-source-type="web-socket"></rux-spectrum-analyzer>

###Properties

PropertyTypeDefaultRequiredDescription
chart-legend-xStringN/AtrueText value for labeling x axis
checked-legend-yStringN/AtrueText value for labeling y axis
chart-titleStringN/AtrueText value for graph label
heightIntegerN/AtrueHeight of graph in pixels
widthIntegerN/AtrueWidth of graph in pixels
x-scale-minIntegerN/AtrueStarting point for x scale
x-scale-maxIntegerN/AtrueEnding point for x scale
x-scale-stepIntegerN/AtrueInterval between labels on x axis
y-scale-minIntegerN/AtrueStarting point for y scale
y-scale-maxIntegerN/AtrueEnding point for y scale
y-scale-stepIntegerN/AfalseInterval between labels on y axis
data-sourceStringN/AtrueURL of data source (currently only supports Web Sockets)
data-source-typeStringN/AfalseFor future use