Hive Header.js

Our Header.js is the cornerstone of our apps. It allows the navigation following the rules set up in the design system. It is fully designed and working with Javascript.

To avoid conflicts with your application, we have implemented the following restrictions:

  1. All css classes are prefixed with .hh- or #hive-.

  2. The Header is 40px in height and uses a z-index value of 10000.

Usage

To use the Hive Header.js, you will be required to do the following:

  1. Import the JavaScript library from our Content Delivery Network.

  2. Load the Hive Header.js in the page

Importing the Hive Header

Copy the following code into the pages that will be using the Header.js:

<script type="text/javascript" src="https://cdn.financeactive.com/hive-header.js" charset="utf-8"></script>

JavaScript will write a DOM element in the body allowing the header component to be loaded. It will also write a stylesheet in the DOM that contains Finance Active specific styles. Finally, it will set a global variable, HIVE_HEADER_APP, in order to interact with the Header.js.

Loading the Hive Header.js in a page

Once imported, the Header.js must be initialized with a set of parameters by calling the load method:

HIVE_HEADER_APP.load({ language:'fr', app:'my_app', accountId:'15', organizationId:'12', translationMode:false });

All these parameters are mandatory, as they will be used to get navigation links to other applications while preserving the global context. Here are the possible parameters for this load method:

Name Query Parameter Type Summary

app

None

string

The application code. This is specific to your application. Contact Finance Active for your code.

language

h:locale

string

The language code in IETF format. Hive currently supports en, en-US, fr, sv, fi, no, es-ES, nl and de

accountId

h:tid

string

The identifier of the current Account.

organizationId

h:oid

string

The identifier of the current Organisation.

translationMode

h:tmode

string

Can either be ON or OFF. Allows the possibility of displaying translation keys for labels and messages on the platform.

filter

h:fdid

string

The identifier of a Debt filter

analysisDate

h:ad

string

ISO-8601 format (yyyy-MM-dd). The (current or past) date which must be used to contextualize the portfolio and retrieve market data

analysisCurrency

h:acur

string

ISO-4217 code. The currency that must be used to aggregate the results of an analysis. Conversions at analysis date will be used for results in different currencies.

analysisTimeBucket

h:tb

string

Definition of a time interval, that can be spot (single date), interval or periodic intervals. This is used to compute analysis.

analysisSimulatedTags

h:st

string

A comma-separated list of string tags. These tags are used to select subset of simulated transactions to be included in analysis

includeDerivatives

h:ide

boolean

Indicated if derivatives must be included or not in the analysis

includeRenewals

h:ire

boolean

Indicates if transactions automatic renewals must be included or not in the analysis

marketScenario

h:ms

string

Provides a string representation of a market simulation, e.g. a market data shift

interestRateSortPortfolio

ir:p:srt-portfolio

string

Tells which attribute is used to sort the portfolio in Debt & Derivatives app

interestRateOrderPortfolio

ir:p:ord-portfolio

string

Tells if the sort is ASC ending or DESC ending in Debt & Derivatives app

interestRateFilterCategories

ir:p:cp

string

Tells which transactions categories are used to filter the portfolio in Debt & Derivatives app

interestRateFilterNonMatured

ir:p:nm

string

Tells if matured transactions must or not be displayed in the portfolio in Debt & Derivatives app

Please not our identifiers are 20-digits long, which exceeds the JavaScript number limit. They must therefore be manipulated as string.