-
Notifications
You must be signed in to change notification settings - Fork 5
add documentation on how to customize mathjs #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mProjectsCode
merged 1 commit into
mProjectsCode:master
from
Cube707:mathjs-import-example
Mar 6, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
title: Customizing MathJS | ||
description: An example on how to import customizations into mathjs | ||
--- | ||
|
||
You may find yourself wanting to add functionality to the [math view fields](/obsidian-meta-bind-plugin-docs/reference/viewfields/math/). | ||
And as they use [mathjs](https://mathjs.org/) internally, you actually can! | ||
|
||
## Importing new options into mathJS | ||
|
||
The mathjs library allows the user to define his own functions and constants, as described in [their documentation](https://mathjs.org/docs/core/extension.html). | ||
|
||
To leverage that, Meta Bind exposed its mathjs instance for you to modify. | ||
The most sensible place to do this, is inside a [JS-Engine startup-script](/obsidian-js-engine-plugin-docs/guides/startupscripts/). | ||
This ensures the modifications are loaded early and will be immediately available when the first documents gets rendered. | ||
|
||
:::caution | ||
Modifying mathJS via a js-engine codeblock inside a document may cause timing problems and is not recommended! | ||
::: | ||
|
||
### Adding a custom function `clamp` | ||
|
||
As an example, we defined the `clamp()` function, which is not part of default mathJS, but can be very helpful. | ||
It takes in three parameters, the current value, a minimum and a maximum. It returns the current value as long as its inside the range otherwise the boundary-value. | ||
|
||
```js | ||
clamp: (val, min, max) => Math.min(Math.max(min, val), max) | ||
``` | ||
|
||
Add this definitions inside a JavaScrypt file stored in you Vault and enable that file to be [run as a startup script](/obsidian-js-engine-plugin-docs/guides/startupscripts/). | ||
Inside the file you use the `mathJSimport(dict, options)` function from the API to import you definitions into mathjs. | ||
|
||
```js | ||
const mb = engine.getPlugin('obsidian-meta-bind-plugin').api; | ||
|
||
mb.mathJSimport({ | ||
// we define the function 'clamp' | ||
clamp: (val, min, max) => Math.min(Math.max(min, val), max), | ||
|
||
// and a constant 'foo' | ||
foo: 42 | ||
}); | ||
``` | ||
|
||
Now you can create a view field using that function. | ||
This example will always display values between 0 and 10, even if `num` gets outside that range. | ||
|
||
```meta-bind | ||
VIEW[clamp({num}, 0, 10)] | ||
``` | ||
|
||
You can also use the new constant `foo`. This will display 52: | ||
|
||
```meta-bind | ||
VIEW[foo + 10] | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.