Page Comparison

...

...
var attributes = category.flexAttributes;
...

string category.get(key)

Returns a single flex attribute's value by its the value of key as string or null if no value is set under the key.

Example

...
var url = category.get(rhino.category.url);
if (url) 
{
  window.location = url;
}
...

Parameter key:string (required)

Use any flex attribute keyThe key to be looked up in the flexAttributes of the order.

string category.

...

cacheKey

Returns an array of sub-categories of a category as objects.a string that you can use in the fragment cache. This string will change whenever the category or one its children are changed.

Example

... 
category.cacheKey # => "12589387317632578294"
...

category.getCategories(deep, maxDepth)

Returns an array of sub-categories of a category as objects.

Example

...
var categories = category.getCategories(deep,5);
...

...

Returns an array of children of a category as objects.

Example

...
var children = category.getChildren(deep,5);
...

...

Returns 'CategoryJsma' for a valid category.

Example

...
var className = category.getClassName;

if (className !== "CategoryJsma") {
  return false;
}
...

...

Returns an array of contents of a category

Example

...
var contents = category.getContents(deep,5);
...

...

Returns an array of files of a category

Example

...
var files = category.getFiles(deep,5);
...

...

Returns the highest price iterating through all sub-categories with a depth equal to the provided parameter.

Example

Object.defineProperty(this, "highestPrice", {
  get : function () {
	return Math.round(self.categoryJsma.getHighestPrice(5) * 100);
  }
});

...

Returns the lowest price iterating through all sub-categories with a depth equal to the provided parameter.

Example

Object.defineProperty(this, "lowestPrice", {
  get : function () {
	return Math.round(self.categoryJsma.getLowestPrice(5) * 100);
  }
});

...

Returns an array of portals of a category

Example

...
var portals = category.getPortals(deep,5);
...

...

Returns an array of portals of a category

Example

...
var products = category.getProducts(deep,5);
...

...

Parameter maxDepth (required)

boolean category.has(key)

Returns a boolean value depending on the existence of the key provided.whether key is present for a given category

Example

...
if (category.has("description") === true)
{
  ...
}
...

Parameter key:string (required)

Use any flex attribute keyThe key to be checked in the flexAttributes of the order.

category.highestPrice

Same as category.getHighestPrice(0). Returns the highest price of a category's immediate children.

Example

Object.defineProperty(this, "highestPriceNoDepth", { 
  get : function () { 
    return Math.round(self.categoryJsma.highestPrice * 100); 
  } 
});

...

Returns the actual main image of a category as an object (JSMA file).

Example

...
var image = category.image;

if (image) {
this.categoryImage.attr("src", "/static/image/get?id=" + image.uuid + "&size=" + this.previewMaxWidth + "x" + this.previewMaxHeight");
}
...

...

Increases the value of any flex attribute by 1 permanently. If two or more persons call this method at the same time, they will not receive the same value.

Example

...
category.increment("amount")
...

Parameter key:string (required)

The key to be incremented in the flexAttributes of the order.

category.isAny

Returns true when the content type of a category is "Any"

Example

...
if (category.isAny === true)
{
  ...
}
...

...

Returns true when the content type of a category is "Category"

Example

...
if (category.isCategories === true)
{
  ...
}
...

...

Returns true when the content type of a category is "Content"

Example

...
if (category.isContents === true)
{
  ...
}
...

...

Returns true when the content type of a category is "File"

Example

...
if (category.isFiles === true)
{
   ...
}
...

...

Returns true when a category is a leaf

Example

...
if (category.isLeaf === true)
{
  ...
}
...

...

Returns true when a category is a mixed node

Example

...
if (category.isMixed === true)
{
  ...
}
...

...

Returns true when a category is a node

Example

...
if (category.isNode === true)
{
  ...
}
...

...

Returns true when the content type of a category is "Portal"

Example

...
if (category.isPortals === true)
{
  ...
}
...

...

Returns true when the content type of a category is "Product"

Example

...
if (category.isProducts === true)
{
  ...
}
...

...

Same as category.getLowestPrice(0). Returns the lowest price of a category's immediate children.

Example

...
if (category.lowestPrice === true)
{
  ...
}
...

...

Changes the index of a child within a category (e.g. for sorting purposes).

Example

...
category.moveChild(child, 7)
...

...

Returns the FQN of a category.

Example

...
var fqn = category.name;

...

...

Returns the node type of a category - Node, Mixed or Leaf

Example

...
if (category.nodeType == "CONTENT")
{
  ...
}
...

...

Returns an array containing the preview images of a category as objects. Works the same way as category.image for preview images.

Example

...
var previewImageId = null;
        
if (category.previewImages && category.previewImages.length > 0) 
{
  previewImageId = category.previewImages[0].uuid;        
}
...

...

Returns all product FQNs from immediate child products in a category without iterating through sub-categories.

Example

...
function categoryContainsProduct(category, productName)
{
  var productNames = category.productNames;
  var found = false;

  if (productNames && productNames.length > 0) 
  {
    for (var j = 0; j < productNames.length; j++) 
    {
       if (productName === productNames[j]) 
      {
        found = true;
        break;
      }
    }         
  }

  return found;
}
...

...

Returns products contained in a category without iterating through sub-categories (i.e. immediate children with className = 'ProductJsma') as objects.

Example

...
var prods = category.products;
...

category.remove(key)

Removes a flex attribute from a category.the key from the flexAttributes of the category

Example

...
category.remove(key)
...

Parameter key:string (required)

The key to be removed from the flexAttributes of the category.

category.removeChild(child)

Removes a child from a category.

Example

...
category.removeChild(child)
...

...

category.set(key, value, [options])

Sets a flex attribute to the provided valuethe value of a specified key for a given category.

Example

...
category.set("description", "Anhänger mit Gravur");
...

Parameter key:string (required)

The key to be set in the flexAttributes of the category.

Parameter value:string (required)

The value to be set for the key

Parameter options:object (optional)

May have a key 'broadcastEvent':bool which determines whether the log message shows up in the websocket log view.

category.setContentType(type)

Sets a category's content type.

...

Example

...
category.setContentType("CONTENT");
...

...

Sets a category's description.

Example

...
category.setDescription("Anhänger");
...

Parameter value (required)

category.

...

setImage(

...

file)

Sets a category's image.

Example

...
category.setImage(file);
...

Parameter file (required)

category.setName(value)

Sets a category's name.

Example

...
category.setName("Fotobuch");
...

Parameter value (required)

category.setNodeType(type)

Sets a category's node type.

Example

...
category.setNodeType("LEAF");
...

...

Sets a category's short description.

Example

...
category.setShortDescription("Anhänger")
...

Parameter value (required)

category.shortDescription

Retrieves a category's short description string.

Example

...
var sDesc = category.shortDescription;
...

...

Retrieves a category's unprocessed short description string.

Example

...
var shortDesUnproc = category.shortdescriptionUnprocessed;
...

...

Example

...
var sliceID = category.sliceId;
...

...

Retrieves a category's title.

Example

...
if (category.title == "Fotobuch")
{
  ...
}
...

...

Updates a category with the given options.

Example

...
category.update(options);
...

...

Retrieves a category's UUID.

Example

...
var catUUID = category.uuid;
...

...