Skip to content

The Text Card product for the TIBCO Spotfire environment is an extension used to visualize text data in an efficient and esthetical way, often alongside other data visualizations.

License

Notifications You must be signed in to change notification settings

hajke-gu/text-mod

Repository files navigation

Text Card

Licence GitHub Workflow Status CodeQL GitHub Workflow Status CI GitHub Workflow Status CI

The Text Card product for the TIBCO Spotfire® environment is an extension used to visualize text data in an efficient and esthetical way, often alongside other data visualizations.

Project for Software innovation course at Gothenburg University and TIBCO Spotfire®

Getting started

Visit the project's website for a user guide of the Text Card mod.

To run (and modify) the Text Card mod locally, please follow these steps:

Prerequisites

These instructions assume that you have Node.js (which includes npm) installed.

How to get started (with development server)

  • Open a terminal at the location of the downloaded/cloned Text Card mod repository.
  • Run npm install. This will install necessary tools. Run this command only the first time you are building the mod and skip this step for any subsequent builds.
  • Run npm run server. This will start a development server.
  • Start editing, for example src/main.js.
  • In Spotfire®, follow the steps of creating a new mod and connecting to the development server.

Descriptions

Architecture

The text card mod is created inside a sandboxed iframe within the Spotfire® environment. It communicates solely with the Spotfire® API. More information can be found in the Spotfire® Mods documentation. The code is split in three files roughly according to the tasks.
architecture

Custom theme adaption

The text card mod uses the following styling elements supplied by the Spotfire® Mods API:

  • general.font: Annotation and content font styling, text-card-border mouse-over line, buttons and scrollbars adapt to it (using different opacity levels)
  • scales.line.stroke: Box shadow of text card
  • scales.tick.stroke: Seperation line between annotation and content (thin_hr), seperation line between annotations

Authors

Acknowledgments

Thanks to the team at TIBCO Spotfire® for all the support in the development of this extension as well as for developing the environment in which this extension has been constructed and to our academic supervisor Miroslaw Staron from Gothenburg University.

License

This project is licensed under the MIT License.

About

The Text Card product for the TIBCO Spotfire environment is an extension used to visualize text data in an efficient and esthetical way, often alongside other data visualizations.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published