Exporting help in the JSON format

TO SUPPORT MY WORK, ORDER A COMMERCIAL LICENSE

THANK YOU!

The tutorial consists of more than 200 live examples from 50 sections. Each of the examples can be copied and run on your own environment. In addition, mXparser provides an extensive collection of over 500 built-in math functions, expressions and symbols. Familiarize yourself with the scope and the syntax. Live testing is the best way to learn. Good luck! 🙂

Tutorial Math Collection API spec Download

Below is the code for JAVA, the code for C# is almost identical. To copy the code, double-click inside the frame.

List of available options

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...

// Only built-in elements
String mXparser.getHelpAsJson();
String mXparser.getHelpAsJson(String query);
String mXparser.getHelpAsJson(boolean addCaption, String caption);
String mXparser.getHelpAsJson(
      String query
      ,boolean addCaption
      ,String caption
);

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...

// Also with user-defined elements,
// when e is an instance of Expression
String e.getHelpAsJson();
String e.getHelpAsJson(String query);
String e.getHelpAsJson(boolean addCaption, String caption);
String e.getHelpAsJson(
      String query
      ,boolean addCaption
      ,String caption
);

Query parameter syntax

For a basic in-line search, simply provide a word (e.g.: `"sine"`) in the `query` parameter.

Advanced search is also possible, please use one of the tags below when formatting the `query` parameter:

"key=" – keyword (e.g.: "key=sin")
"desc=" – description (e.g.: "desc=trigonometric"),
"syn=" – syntax (e.g.: "syn=sin")
"type=" – type (e.g.: "type=unit")
"since=" – since (e.g.: "since=4.1")
"typeid=" – please refer to parser tokens (e.g.: "typeid=3")
"keyid=" – please refer to parser tokens (e.g.: "keyid=1004").

Only one tag can be used per search.

Other parameters

Other parameters are self-explanatory by their names. In case you need more details please refer the API documentation.

Case 1: Output with standard caption + advanced search

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpJson = mXparser.getHelpAsJson(
		"type=Bitwise operator"
		,true
		,""
);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpJson);

[mXparser-v.5.2.0] 
[
  { "Caption": "Help content limited to query: 'type=Bitwise operator'" },
  {
    "Keyword": "@~",
    "Type": "Bitwise operator",
    "Syntax": "@~a",
    "Since": "4.0",
    "Description": "Bitwise unary complement - Bitwise operator"
  },
  {
    "Keyword": "@&",
    "Type": "Bitwise operator",
    "Syntax": "a @& b",
    "Since": "4.0",
    "Description": "Bitwise and AND - Bitwise operator"
  },
  {
    "Keyword": "@^",
    "Type": "Bitwise operator",
    "Syntax": "a @^ b",
    "Since": "4.0",
    "Description": "Bitwise exclusive or XOR - Bitwise operator"
  },
  {
    "Keyword": "@|",
    "Type": "Bitwise operator",
    "Syntax": "a @| b",
    "Since": "4.0",
    "Description": "Bitwise inclusive or OR - Bitwise operator"
  },
  {
    "Keyword": "@<<",
    "Type": "Bitwise operator",
    "Syntax": "a @<< b",
    "Since": "4.0",
    "Description": "Signed left shift - Bitwise operator"
  },
  {
    "Keyword": "@>>",
    "Type": "Bitwise operator",
    "Syntax": "a @>> b",
    "Since": "4.0",
    "Description": "Signed right shift - Bitwise operator"
  }
]

Case 2: Output with user caption + advanced search

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpJson = mXparser.getHelpAsJson(
		"type=Bitwise operator"
		,true
		,"This is a caption"
);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpJson);

[mXparser-v.5.2.0] 
[
  { "Caption": "This is a caption" },
  {
    "Keyword": "@~",
    "Type": "Bitwise operator",
    "Syntax": "@~a",
    "Since": "4.0",
    "Description": "Bitwise unary complement - Bitwise operator"
  },
  {
    "Keyword": "@&",
    "Type": "Bitwise operator",
    "Syntax": "a @& b",
    "Since": "4.0",
    "Description": "Bitwise and AND - Bitwise operator"
  },
  {
    "Keyword": "@^",
    "Type": "Bitwise operator",
    "Syntax": "a @^ b",
    "Since": "4.0",
    "Description": "Bitwise exclusive or XOR - Bitwise operator"
  },
  {
    "Keyword": "@|",
    "Type": "Bitwise operator",
    "Syntax": "a @| b",
    "Since": "4.0",
    "Description": "Bitwise inclusive or OR - Bitwise operator"
  },
  {
    "Keyword": "@<<",
    "Type": "Bitwise operator",
    "Syntax": "a @<< b",
    "Since": "4.0",
    "Description": "Signed left shift - Bitwise operator"
  },
  {
    "Keyword": "@>>",
    "Type": "Bitwise operator",
    "Syntax": "a @>> b",
    "Since": "4.0",
    "Description": "Signed right shift - Bitwise operator"
  }
]

Case 3: Output with no caption + advanced search

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpJson = mXparser.getHelpAsJson(
		"type=Bitwise operator"
		,false
		,""
);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpJson);

[mXparser-v.5.2.0] 
[
  {
    "Keyword": "@~",
    "Type": "Bitwise operator",
    "Syntax": "@~a",
    "Since": "4.0",
    "Description": "Bitwise unary complement - Bitwise operator"
  },
  {
    "Keyword": "@&",
    "Type": "Bitwise operator",
    "Syntax": "a @& b",
    "Since": "4.0",
    "Description": "Bitwise and AND - Bitwise operator"
  },
  {
    "Keyword": "@^",
    "Type": "Bitwise operator",
    "Syntax": "a @^ b",
    "Since": "4.0",
    "Description": "Bitwise exclusive or XOR - Bitwise operator"
  },
  {
    "Keyword": "@|",
    "Type": "Bitwise operator",
    "Syntax": "a @| b",
    "Since": "4.0",
    "Description": "Bitwise inclusive or OR - Bitwise operator"
  },
  {
    "Keyword": "@<<",
    "Type": "Bitwise operator",
    "Syntax": "a @<< b",
    "Since": "4.0",
    "Description": "Signed left shift - Bitwise operator"
  },
  {
    "Keyword": "@>>",
    "Type": "Bitwise operator",
    "Syntax": "a @>> b",
    "Since": "4.0",
    "Description": "Signed right shift - Bitwise operator"
  }
]