Tour API Demos Download Tests
Aperture version 1.0
Generated by: JsDoc Toolkit 2.4.0

Namespace aperture.palette

Aperture exposes a global base palette in order to promote and ease use of coordinated, complementary, cognitively effective visual attributes in a display context. Palettes support derivation, providing a concise and systematic method of defining properties through the articulation of relationships.

The base palette is populated at load time from the aperture.palette configuration provider. Its prototype includes the 17 named colors defined by CSS 2.1 for runtime access only. Support for exporting LESS CSS compatible variable lists for import is also provided for deriving CSS style sheet values from base palette entries. LESS provides a concise and systematic method of defining CSS properties for style sheets, however if use of LESS is not an option, export of named CSS classes for specifically targeted style sheet properties (e.g. color, border-color, etc) is also supported.

Namespace Summary
Constructor Attributes Constructor Name and Description
 

Method Summary

Namespace Detail

aperture.palette
Parameters:
ns

Method Detail

  • <static> {String} aperture.palette.asLESS()
    Returns:
    {String} a string representation in LESS CSS variable format.
    See:
    lesscss.org
  • <static> {aperture.Color} aperture.palette.color(id)
    Parameters:
    {String} id
    the identifying name of the palette entry.
    Returns:
    {aperture.Color} a color object
  • <static> {Array} aperture.palette.colors(id)
    Parameters:
    {String} id
    the identifying name of the palette entry.
    Returns:
    {Array} an Array of color objects
  • <static> {String} aperture.palette.icon(properties)
    Parameters:
    {Object} properties
    the specification of the icon
    {String} properties.type
    The ontological type for the icon service to resolve within the namespace of the ontology.
    {String} properties.ontology Optional, Default: 'aperture-hscb'
    Refers to the namespace used by any active icon services to resolve types with attributes to icons. Note that the mapping of ontology to symbology is a function of the icon services configured and running. The default symbology is a core set of icons with a specific focus on socio-cultural themes and media artifacts of socio-cultural analysis.
    {Object} properties.attributes Optional
    The optional attributes of the ontological type, for interpretation by the icon service.
    {Number} properties.width Optional, Default: 24
    The width of the icon. Defaults to 24.
    {Number} properties.height Optional, Default: 24
    The height of the icon. Defaults to 24.
    {String} properties.format Optional
    The image format of the icon. When absent the format is left to the discretion of the icon service. Support for specific formats is service dependent, however the default aperture-hscb ontology supports png (a lossless compressed raster format with transparency), svg (a vector format that can draw nicely at any scale), and jpeg (an opaque, lossy but highly compressible format).
    Returns:
    {String} a url
    Requires:
    an Aperture icon service
    jQuery
  • <static> {Object} aperture.palette.parchmentCSS(confidence, currency)
    Returns CSS properties to reflect confidence using background texture. Confidence of information is indicated by how pristine the parchment is, and currency of information is indicated by how white the parchment is. Dated information yellows with time.
    Parameters:
    {Number} confidence
    an indication of confidence, as a value between 0 and 1 (confident).
    {Number} currency Optional
    an indication of how current the information is, as a value between 0 and 1 (current).
    Returns:
    {Object} an object with CSS properties, that includes background image and border color.
  • <static> {String} aperture.palette.parchmentClass(confidence, currency)
    Returns a CSS class used to reflect confidence using background texture. Confidence of information is indicated by how pristine the parchment is, and currency of information is indicated by how white the parchment is. Dated information yellows with time.
    Parameters:
    {Number} confidence
    an indication of confidence, as a value between 0 and 1 (confident).
    {Number} currency Optional
    an indication of how current the information is, as a value between 0 and 1 (current).
    Returns:
    {String} the name of a CSS class defined in rest/parchment.css.
  • <static> {Number} aperture.palette.size(id)
    Parameters:
    {String} id
    the identifying name of the palette entry.
    Returns:
    {Number} a Number
  • <static> {Array} aperture.palette.sizes(id)
    Parameters:
    {String} id
    the identifying name of the palette entry.
    Returns:
    {Array} an array of Numbers