elchininet/isometric elchininet/isometric

  • Stars
    star
    104
  • Rank 330,604 (Top 7 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created almost 5 years ago
  • Updated 12 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
elchininet/isometric
github

elchininet

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A lightweight JavaScript library, written in TypeScript, to create isometric projections using SVGs


A lightweight JavaScript library written in TypeScript to create isometric projections using SVGs

Deployment Status ย  Coverage Status ย  npm version

Demo

https://elchininet.github.io/isometric/

Installation

Using NPM

npm install @elchininet/isometric

Using Yarn

yarn add @elchininet/isometric

In the browser

Importing the package as an external script in the HTML code

It is possible to include a compiled version of the package directly in an HTML file. It will create a global isometric object that can be accessed from anywhere in your JavaScript code.

  1. Copy the JavaScript file isometric.js, located in the dist/web folder
  2. Put it in the folder that you prefer in your web server
  3. Include it in your HTML file
<script src="wherever/you/installed/isometric.js"></script>
/* There will be a global variable named isometric containing all the classes */
isometric.IsometricCanvas;
isometric.IsometricGroup;
isometric.IsometricRectangle;
isometric.IsometricCircle;
isometric.IsometricPath;
Importing the package in your code using CommonJS
const {
    IsometricCanvas,
    IsometricGroup,
    IsometricRectangle,
    IsometricCircle,
    IsometricPath
} = require('@elchininet/isometric');
Importing the package in your code using ES6 modules
import {
    IsometricCanvas,
    IsometricGroup,
    IsometricRectangle,
    IsometricCircle,
    IsometricPath
} from '@elchininet/isometric';

In node environments

To use the package in a Node environment, you need to install jsdom because the package needs it to work properly.

Importing the package in your code using CommonJS
const {
    IsometricCanvas,
    IsometricGroup,
    IsometricRectangle,
    IsometricCircle,
    IsometricPath
} = require('@elchininet/isometric/node');
Importing the package in your code using ES6 modules
import {
    IsometricCanvas,
    IsometricGroup,
    IsometricRectangle,
    IsometricCircle,
    IsometricPath
} from '@elchininet/isometric/node';

In Deno

To import the package in Deno, use the main esm version using any content delivery as UNPKG or JSDELIVR. The package contains a reference directive to the d.ts file so you can get type checking importing it without doing anything special.

import {
    IsometricCanvas,
    IsometricGroup,
    IsometricRectangle,
    IsometricCircle,
    IsometricPath
} from 'https://cdn.jsdelivr.net/npm/@elchininet/isometric/esm/index.js';

Scripts

build

npm run build

Transpiles the TypeScript code and creates the necesary package bundles:

Bundle path Environment Module type
web/isometric.js Browser IIFE
index.js Browser CommonJS
esm/index.js Browser ESM
index.node.js Node CommonJS
esm/index.node.js Node ESM

lint

npm run lint

Runs eslint in source files.

test

npm run test

Runs tests.

demo

npm run demo

Opens a development server that provides live reloading using webpack-dev-server. Some demo examples located in the @demo folder will be shown. You can modify the code of the demos and the changes will be live reloaded in the browser.

API

Class IsometricCanvas

This is the base class, it creates an isometric canvas (an SVG object)

const isometric = new IsometricCanvas([properties]);
Parameters

properties (optional)

Object to set the properties of the isometric canvas

Property Type Default value Description
container HTMLElement or string "body" The DOM element or the query selector of the element in which the isometric will be inserted. This parameter should not be provided in Node environments
backgroundColor string "white" Sets the background color of the isometric canvas
scale number 1 Sets the scale multiplier of each isometric unit
height number 480 Sets the height of the isometric canvas
width number 640 Sets the width of the isometric canvas

Instance Methods

All the instance methods (excepting getElement and getSVGCode) return the same instance, so they are chainable.

getElement()

Returns the native SVG element

getSVGCode()

Returns the HTML code of the SVG element

addChild(child)

Adds a child to the isometric canvas

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
addChildren(child, child, child...)

Adds multiple children to the isometric canvas

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
removeChild(child)

Removes a child from the isometric canvas

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
removeChildren(child, child, child...)

Removes multiple children from the isometric canvas

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
removeChildByIndex(index)

Removes a child taking into account its index in the elements tree

Parameter Type
index number 
setChildIndex(child, index)

Change the index of a child of the isometric canvas. This method also changes the index of the native elements inside the SVG.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle
index number 
bringChildToFront(child)

Change the index of a child of the isometric canvas bringing it to the front of the rest of the children. This method also changes the index of the native elements inside the SVG.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
sendChildToBack(child)

Change the index of a child of the isometric canvas sending it to the back of the rest of the children. This method also changes the index of the native elements inside the SVG.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
bringChildForward(child)

Change the index of a child of the isometric canvas bringing it to the front of the child above it. This method also changes the index of the native elements inside the SVG.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
sendChildBackward(child)

Change the index of a child of the isometric canvas sending it to the back of the child below it. This method also changes the index of the native elements inside the SVG.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
update()

Updates the entire isometric canvas and its children

clear()

Cleans the isometric canvas (removes all the children from it and all the native SVG elements from the SVG)

pauseAnimations()

Pause all the animations (not compatible with Internet Explorer)

resumeAnimations()

Resume all the animations (not compatible with Internet Explorer)

addEventListener(type, callback, [useCapture])

Sets up a function that will be called whenever the specified event is delivered to the isometric canvas (the SVG element)

Parameter Type
type string
callback VoidFunction
callback boolean 
removeEventListener(type, callback, [useCapture])

Removes from the isometric canvas (the SVG element) an event listener previously registered with addEventListener

Parameter Type
type string
callback VoidFunction
callback boolean

Instance Properties

Property Type Description
backgroundColor string Gets and sets the background color of the isometric canvas
scale number Gets and sets the multiplier scale of the isometric canvas
height number Gets and sets the height of the isometric canvas
width number Gets and sets the width of the isometric canvas
children array Gets an array of the isometric canvas children elements
animated boolean Gets if the SVG is animations are paused or are running

Class IsometricGroup

This class can be used to group multiple isometric elements and translate them together.

const isometric = new IsometricGroup([properties]);
Parameters

properties (optional)

Object to set the properties of the isometric canvas

Property Type Default value Description
right number 0 Sets the right isometric coordinates of the isometric group
left number 0 Sets the left isometric coordinates of the isometric group
top number 0 Sets the top isometric coordinates of the isometric group

Instance Methods

All the instance methods (excepting getElement) return the same instance, so they are chainable.

getElement()

Returns the native g element

addChild(child)

Adds a child to the isometric group

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
addChildren(child, child, child...)

Adds multiple children to the isometric group

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
removeChild(child)

Removes a child from the isometric group

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
removeChildren(child, child, child...)

Removes multiple children from the isometric group

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
removeChildByIndex(index)

Removes a child taking into account its index in the elements tree

Parameter Type
index number 
setChildIndex(child, index)

Change the index of a child of the isometric group. This method also changes the index of the native elements inside the g element.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle
index number 
bringChildToFront(child)

Change the index of a child of the isometric group bringing it to the front of the rest of the children. This method also changes the index of the native elements inside the g element.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
sendChildToBack(child)

Change the index of a child of the isometric group sending it to the back of the rest of the children. This method also changes the index of the native elements inside the g element.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
bringChildForward(child)

Change the index of a child of the isometric group bringing it to the front of the child above it. This method also changes the index of the native elements inside the g element.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
sendChildBackward(child)

Change the index of a child of the isometric group sending it to the back of the child below it. This method also changes the index of the native elements inside the g element.

Parameter Type
child IsometricGroup
IsometricPath
IsometricRectangle
IsometricCircle		 
update()

Updates the entire isometric group and its children

clear()

Cleans the isometric group (removes all the children from it and all the native SVG elements from the g element)

addEventListener(type, callback, [useCapture])

Sets up a function that will be called whenever the specified event is delivered to the isometric group (the g element)

Parameter Type
type string
callback VoidFunction
callback boolean 
removeEventListener(type, callback, [useCapture])

Removes from the isometric group (the g element) an event listener previously registered with addEventListener

Parameter Type
type string
callback VoidFunction
callback boolean

Instance Properties

Property Type Description
right number Gets and sets the right isometric coordinates of the isometric group
left number Gets and sets the left isometric coordinates of the isometric group
top number Gets and sets the top isometric coordinates of the isometric group
children array Gets an array of the isometric group children elements
drag * PlaneView (string) / false Gets an sets the dragging plane of the isometric group
bounds object / false Gets an sets the boundaries of the isometric group position

* When dragging an isometric group, the events dragstart, drag and dragend will be fired in that order. These events will be CustomEvents with a detail property containing the right, left and top properties that the isometric group will receive. The drag event can be prevented using preventDefault so, if it is prevented, the isometric group will not change its position when it is dragged.

planeView values

"TOP" | "FRONT" | "SIDE" | false

bounds properties

Object to set the boundaries of the isometric group position. If it is set as false the isometric group will not have boundaries.

Property Type Default value Description
right [number, number] - Minimum and maximum boundaries of the right coordinates
left [number, number] - Minimum and maximum boundaries of the left coordinates
top [number, number] - Minimum and maximum boundaries of the top coordinates

Class IsometricRectangle

This class is to create isometric rectangles that can be added to the isometric canvas or to isometric groups.

const path = new IsometricRectangle(properties);
Parameters

properties

Object to set the properties of the isometric rectangle

Property Type Default value Description
height number - Sets the height of the isometric rectangle
width number - Sets the width of the isometric rectangle
right number 0 Sets the right isometric coordinates of the isometric rectangle
left number 0 Sets the left isometric coordinates of the isometric rectangle
top number 0 Sets the top isometric coordinates of the isometric rectangle
planeView PlaneView (string) - Sets the plane view in which the isometric rectangle will be created
fillColor string "white" Sets the fill color of the isometric rectangle
fillOpacity number 1 Sets the fill opacity of the isometric rectangle
strokeColor string "black" Sets the stroke color of the isometric rectangle
strokeOpacity number 1 Sets stroke opacity of the isometric rectangle
strokeDashArray number[] [] Sets the SVG stroke dasharray of the isometric rectangle
strokeLinecap string "butt" Sets the SVG stroke linecap of the isometric rectangle
strokeLinejoin string "round" Sets the SVG stroke linejoin of the isometric rectangle
strokeWidth number 1 Sets the stroke width of the isometric rectangle
texture Texture (object) - Sets the texture of the isometric rectangle

planeView values

"TOP" | "FRONT" | "SIDE"

texture properties

Object to set the texture of the isometric rectangle

Property Type Default value Description
url string - URL of the image texture
planeView PlaneView (string) parent planeView Sets the texture plane view. By default it takes the isometric rectangle plane view
height number - Sets the texture height
width number - Sets the texture width
scale number - Sets the scale of the texture
pixelated boolean - Sets the image rendering of the texture
shift Point (object) - Shifts the background position
rotation Rotation (object) - Set the rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

Instance Methods

All the instance methods (except getElement and getPattern) return the same instance, so they are chainable.

getElement()

Returns the native SVG path element

getPattern()

Returns the native SVGPatternElement responsible for the texture

update()

Forces a re-render of the SVG rectangle

updateTexture(texture)

Adds or override the texture properties

Property Type Optional Description
url string yes URL of the image texture
planeView PlaneView (string) yes Texture plane view
height number yes Texture height
width number yes Texture width
scale number yes Texture scale
pixelated boolean yes Image rendering of the texture
shift Point (object) yes Shifts the background position
rotation Rotation (object) yes Rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

clear()

Cleans the isometric rectangle (removes all the path commands from the native SVG path element)

addAnimation(animation)

Adds an animated element to the isometric Rectangle (not compatible with Internet Explorer). These are the properties of the SVGRectangleAnimation object:

Property Type Optional Default Description
property string no - Indicates which property should be animated
duration number yes 1 Indicates the number of seconds of the animation
repeat number yes 0 Number of times that the animation will run. 0 runs indefinitely
from string / number yes - Initial value of the animation (if this property is used, values property can't be used)
to string / number yes - Final value of the animation (if this property is used, values property can't be used)
values string / number / string[] / number[] yes - All the values of the animation (if this property is used, from and to properties can't be used)

These are the properties that can be animated (property property)

  • fillColor
  • fillOpacity
  • strokeColor
  • strokeOpacity
  • strokeWidth
  • right*
  • left*
  • top*
  • width*
  • height*
  • At the moment, it is not possible to animate more than one of these properties at the same time. If you do it, only the last one will be applied.
removeAnimationByIndex(index)

Remove an especific animation element by its index.

removeAnimations()

Remove all the animation elements.

addEventListener(type, callback, [useCapture])

Sets up a function that will be called whenever the specified event is delivered to the isometric rectangle (the SVG path element)

Parameter Type
type string
callback VoidFunction
callback boolean 
removeEventListener(type, listener, [useCapture])

Removes from the isometric rectangle (the SVG path element) an event listener previously registered with addEventListener

Parameter Type
type string
callback VoidFunction
callback boolean

Instance Properties

Property Type Description
height number Gets and sets the height of the isometric rectangle
width number Gets and sets the width of the isometric rectangle
right number Gets and sets the right isometric coordinates of the isometric rectangle
left number Gets and sets the left isometric coordinates of the isometric rectangle
top number Gets and sets the top isometric coordinates of the isometric rectangle
planeView string Gets and sets the plane view in which the isometric rectangle is created
fillColor string Gets and sets the fill color of the isometric rectangle
fillOpacity number Gets and sets the fill opacity of the isometric rectangle
strokeColor string Gets and sets the stroke color of the isometric rectangle
strokeOpacity number Gets and sets the stroke opacity of the isometric rectangle
strokeDashArray number[] Gets and sets the SVG stroke dasharray of the isometric rectangle
strokeLinecap string Gets and sets the SVG stroke linecap of the isometric rectangle
strokeLinejoin string Gets and sets the SVG stroke linejoin of the isometric rectangle
strokeWidth number Gets and sets the stroke width of the isometric rectangle
texture Texture (object) Gets and sets the texture of the isometric rectangle
drag * PlaneView (string) / false Gets an sets the dragging plane of the isometric rectangle
bounds object / false Gets an sets the boundaries of the isometric rectangle position

* When dragging an isometric rectangle, the events dragstart, drag and dragend will be fired in that order. These events will be CustomEvents with a detail property containing the right, left and top properties that the isometric rectangle will receive. The drag event can be prevented using preventDefault so, if it is prevented, the isometric rectangle will not change its position when it is dragged.

planeView values

"TOP" | "FRONT" | "SIDE" | false

bounds properties

Object to set the boundaries of the isometric rectangle position. If it is set as false the isometric rectangle will not have boundaries.

Property Type Default value Description
right [number, number] - Minimum and maximum boundaries of the right coordinates
left [number, number] - Minimum and maximum boundaries of the left coordinates
top [number, number] - Minimum and maximum boundaries of the top coordinates

Class IsometricCircle

This class is to create isometric circles that can be added to the isometric canvas.

const path = new IsometricCircle(properties);
Parameters

properties

Object to set the properties of the isometric circle

Property Type Default value Description
radius number - Sets the radius of the isometric circle
right number 0 Sets the right isometric coordinates of the isometric circle
left number 0 Sets the left isometric coordinates of the isometric circle
top number 0 Sets the top isometric coordinates of the isometric circle
planeView PlaneView (string) - Sets the plane view in which the isometric circle will be created
fillColor string "white" Sets the fill color of the isometric circle
fillOpacity number 1 Sets the fill opacity of the isometric circle
strokeColor string "black" Sets the stroke color of the isometric circle
strokeOpacity number 1 Sets stroke opacity of the isometric circle
strokeDashArray number[] [] Sets the SVG stroke dasharray of the isometric circle
strokeLinecap string "butt" Sets the SVG stroke linecap of the isometric circle
strokeLinejoin string "round" Sets the SVG stroke linejoin of the isometric circle
strokeWidth number 1 Sets the stroke width of the isometric circle
texture Texture (object) - Sets the texture of the isometric circle

planeView values

"TOP" | "FRONT" | "SIDE"

texture properties

Object to set the texture of the isometric circle

Property Type Default value Description
url string - URL of the image texture
planeView PlaneView (string) parent planeView Sets the texture plane view. By default it takes the isometric circle plane view
height number - Sets the texture height
width number - Sets the texture width
scale number - Sets the scale of the texture
pixelated boolean - Sets the image rendering of the texture
shift Point (object) - Shifts the background position
rotation Rotation (object) - Set the rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

Instance Methods

All the instance methods (except getElement and getPattern) return the same instance, so they are chainable.

getElement()

Returns the native SVG path element

getPattern()

Returns the native SVGPatternElement responsible for the texture

update()

Forces a re-render of the SVG circle

updateTexture(texture)

Adds or override the texture properties

Property Type Optional Description
url string yes URL of the image texture
planeView PlaneView (string) yes Texture plane view
height number yes Texture height
width number yes Texture width
scale number yes Texture scale
pixelated boolean yes Image rendering of the texture
shift Point (object) yes Shifts the background position
rotation Rotation (object) yes Rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

clear()

Cleans the isometric circle (removes all the path commands from the native SVG path element)

addAnimation(animation)

Adds an animated element to the isometric circle (not compatible with Internet Explorer). These are the properties of the SVGCircleAnimation object:

Property Type Optional Default Description
property string no - Indicates which property should be animated
duration number yes 1 Indicates the number of seconds of the animation
repeat number yes 0 Number of times that the animation will run. 0 runs indefinitely
from string / number yes - Initial value of the animation (if this property is used, values property can't be used)
to string / number yes - Final value of the animation (if this property is used, values property can't be used)
values string / number / string[] / number[] yes - All the values of the animation (if this property is used, from and to properties can't be used)

These are the properties that can be animated (property property)

  • fillColor
  • fillOpacity
  • strokeColor
  • strokeOpacity
  • strokeWidth
  • right*
  • left*
  • top*
  • radius*
  • At the moment, it is not possible to animate more than one of these properties at the same time. If you do it, only the last one will be applied.
removeAnimationByIndex(index)

Remove an especific animation element by its index.

removeAnimations()

Remove all the animation elements.

addEventListener(type, callback, [useCapture])

Sets up a function that will be called whenever the specified event is delivered to the isometric circle (the SVG path element)

Parameter Type
type string
callback VoidFunction
callback boolean 
removeEventListener(type, listener, [useCapture])

Removes from the isometric circle (the SVG path element) an event listener previously registered with addEventListener

Parameter Type
type string
callback VoidFunction
callback boolean

Instance Properties

Property Type Description
radius number Gets and sets the radius of the isometric circle
right number Gets and sets the right isometric coordinates of the isometric circle
left number Gets and sets the left isometric coordinates of the isometric circle
top number Gets and sets the top isometric coordinates of the isometric circle
planeView string Gets and sets the plane view in which the isometric circle is created
fillColor string Gets and sets the fill color of the isometric circle
fillOpacity number Gets and sets the fill opacity of the isometric circle
strokeColor string Gets and sets the stroke color of the isometric circle
strokeOpacity number Gets and sets the stroke opacity of the isometric circle
strokeDashArray number[] Gets and sets the SVG stroke dasharray of the isometric circle
strokeLinecap string Gets and sets the SVG stroke linecap of the isometric circle
strokeLinejoin string Gets and sets the SVG stroke linejoin of the isometric circle
strokeWidth number Gets and sets the stroke width of the isometric circle
texture Texture (object) Gets and sets the texture of the isometric circle
drag * PlaneView (string) / false Gets an sets the dragging plane of the isometric circle
bounds object / false Gets an sets the boundaries of the isometric circle position

* When dragging an isometric circle, the events dragstart, drag and dragend will be fired in that order. These events will be CustomEvents with a detail property containing the right, left and top properties that the isometric circle will receive. The drag event can be prevented using preventDefault so, if it is prevented, the isometric circle will not change its position when it is dragged.

planeView values

"TOP" | "FRONT" | "SIDE" | false

bounds properties

Object to set the boundaries of the isometric circle position. If it is set as false the isometric circle will not have boundaries.

Property Type Default value Description
right [number, number] - Minimum and maximum boundaries of the right coordinates
left [number, number] - Minimum and maximum boundaries of the left coordinates
top [number, number] - Minimum and maximum boundaries of the top coordinates

Class IsometricPath

This class is to create isometric paths that can be added to the isometric canvas

const path = new IsometricPath([properties]);
Parameters

properties (optional)

Object to set the properties of the isometric path

Property Type Default value Description
fillColor string "white" Sets the fill color of the isometric path
fillOpacity number 1 Sets the fill opacity of the isometric path
strokeColor string "black" Sets the stroke color of the isometric path
strokeOpacity number 1 Sets stroke opacity of the isometric path
strokeDashArray number[] [] Sets the SVG stroke dasharray of the isometric path
strokeLinecap string "butt" Sets the SVG stroke linecap of the isometric path
strokeLinejoin string "round" Sets the SVG stroke linejoin of the isometric path
strokeWidth number 1 Sets the stroke width of the isometric path
texture Texture (object) - Sets the texture of the isometric path
autoclose boolean true Sets if the path should close automatically or not

texture properties

Object to set the texture of the isometric path

Property Type Default value Description
url string - URL of the image texture
planeView PlaneView (string) - Sets the texture plane view
height number - Sets the texture height
width number - Sets the texture width
scale number - Sets the scale of the texture
pixelated boolean - Sets the image rendering of the texture
shift Point (object) - Shifts the background position
rotation Rotation (object) - Set the rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

Instance Methods

All the instance methods (except getElement and getPattern) return the same instance, so they are chainable.

getElement()

Returns the native SVG path element

getPattern()

Returns the native SVGPatternElement responsible for the texture

update()

Forces a re-render of the SVG path

updateTexture(texture)

Adds or override the texture properties

Property Type Optional Description
url string yes URL of the image texture
planeView PlaneView (string) yes Texture plane view
height number yes Texture height
width number yes Texture width
scale number yes Texture scale
pixelated boolean yes Image rendering of the texture
shift Point (object) yes Shifts the background position
rotation Rotation (object) yes Rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

moveTo(right, left, top)

Move the cursor to an isometric point, if the cursor was already in another point, no line is drawn between them.

Parameter Type Description
right number Right value in the isometric coordinates
left number Left value in the isometric coordinates
top number Top value in the isometric coordinates 
lineTo(right, left, top)

Draws a line from the previous isometric point to the destination point.

Parameter Type Description
right number Right value in the isometric coordinates of the destination point
left number Left value in the isometric coordinates of the destination point
top number Top value in the isometric coordinates of the destination point 
curveTo(controlRight, controlLeft, controlTop, right, left, top)

Draws a curve from the previous isometric point to the designated isometric point crossing the control isometric point.

Parameter Type Description
controlRight number Right value in the isometric coordinates of the control point
controlLeft number Left value in the isometric coordinates of the control point
controlTop number Top value in the isometric coordinates of the control point
right number Right value in the isometric coordinates of the destination point
left number Left value in the isometric coordinates of the destination point
top number Top value in the isometric coordinates of the destination point 
mt(right, left, top)

Alias of moveTo.

lt(right, left, top)

Alias of lineTo.

ct(controlRight, controlLeft, controlTop, right, left, top)

Alias of curveTo.

draw(commands)

Draws a line taking into account a series of drawing commands.

Parameter Type Description
commands string A series of drawing commands. For example, M0 0 0 L1 1 1 C 2 2 2 3 3 3has the same effect as moveTo(0, 0, 0).lineTo(1, 1, 1).curveTo(2, 2, 2, 3, 3, 3) 
clear()

Cleans the isometric path (removes all the path commands from the native SVG path element)

addAnimation(animation)

Adds an animated element to the isometric path (not compatible with Internet Explorer). These are the properties of the SVGPathAnimation object:

Property Type Optional Default Description
property string no - Indicates which property should be animated
duration number yes 1 Indicates the number of seconds of the animation
repeat number yes 0 Number of times that the animation will run. 0 runs indefinitely
from string / number yes - Initial value of the animation (if this property is used, values property can't be used)
to string / number yes - Final value of the animation (if this property is used, values property can't be used)
values string / number / string[] / number[] yes - All the values of the animation (if this property is used, from and to properties can't be used)

These are the properties that can be animated (property property)

  • fillColor
  • fillOpacity
  • strokeColor
  • strokeOpacity
  • strokeWidth
  • path
removeAnimationByIndex(index)

Remove an especific animation element by its index.

removeAnimations()

Remove all the animation elements.

addEventListener(type, callback, [useCapture])

Sets up a function that will be called whenever the specified event is delivered to the isometric path (the SVG path element)

Parameter Type
type string
callback VoidFunction
callback boolean 
removeEventListener(type, listener, [useCapture])

Removes from the isometric path (the SVG path element) an event listener previously registered with addEventListener

Parameter Type
type string
callback VoidFunction
callback boolean

Instance Properties

Property Type Description
fillColor string Gets and sets the fill color of the isometric path
fillOpacity number Gets and sets the fill opacity of the isometric path
strokeColor string Gets and sets the stroke color of the isometric path
strokeOpacity number Gets and sets the stroke opacity of the isometric path
strokeDashArray number[] Gets and sets the SVG stroke dasharray of the isometric path
strokeLinecap string Gets and sets the SVG stroke linecap of the isometric path
strokeLinejoin string Gets and sets the SVG stroke linejoin of the isometric path
strokeWidth number Gets and sets the stroke width of the isometric path
texture Texture (object) Gets and sets the texture of the isometric path
autoclose boolean Gets and sets the autoclose property of the isometric path

Class IsometricText

This class is to create isometric texts that can be added to the isometric canvas.

const path = new IsometricText(properties);
Parameters

properties

Object to set the properties of the isometric text

Property Type Default value Description
planeView PlaneView (string) - Sets the plane view in which the isometric text will be created
text string '' Sets the text content of the isometric text
right number 0 Sets the right isometric coordinates of the isometric text
left number 0 Sets the left isometric coordinates of the isometric text
top number 0 Sets the top isometric coordinates of the isometric text
fontFamily string 'Arial' Sets the font-family of the isometric text
fontSize string 12 Sets the font-size of the isometric text
fontStyle string literal 'normal Sets the font-style of the isometric text
fontWeight number string literal 'normal'
rotation number 0 Sets the rotation of the isometric text
origin string literal tuple ['center', 'center'] Sets the origin of the isometric text position and transformations
selectable boolean true Indicates if the isometric text should be selectable or not
fillColor string "white" Sets the fill color of the isometric text
fillOpacity number 1 Sets the fill opacity of the isometric text
strokeColor string "black" Sets the stroke color of the isometric text
strokeOpacity number 1 Sets stroke opacity of the isometric text
strokeDashArray number[] [] Sets the SVG stroke dasharray of the isometric text
strokeLinecap string "butt" Sets the SVG stroke linecap of the isometric text
strokeLinejoin string "round" Sets the SVG stroke linejoin of the isometric text
strokeWidth number 1 Sets the stroke width of the isometric text
texture Texture (object) - Sets the texture of the isometric text

planeView values

"TOP" | "FRONT" | "SIDE"

fontStyle values

"normal" | "italic" | "oblique"

fontWeight values

number | "normal" | "bold" | "bolder" | "lighter"

origin values

["left" | "center" | "right", "top" | "center", "bottom"]

texture properties

Object to set the texture of the isometric text

Property Type Default value Description
url string - URL of the image texture
planeView PlaneView (string) parent planeView Sets the texture plane view. By default it takes the isometric text plane view
height number - Sets the texture height
width number - Sets the texture width
scale number - Sets the scale of the texture
pixelated boolean - Sets the image rendering of the texture
shift Point (object) - Shifts the background position
rotation Rotation (object) - Set the rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

Instance Methods

All the instance methods (except getElement and getPattern) return the same instance, so they are chainable.

getElement()

Returns the native SVG g element*

  • The IsometricText class, due to its complexity, it is conformed by a group of SVG elements, a g element with a text element inside and inside this last one a tspan element.
getPattern()

Returns the native SVGPatternElement responsible for the texture

update()

Forces a re-render of the SVG text

updateTexture(texture)

Adds or override the texture properties

Property Type Optional Description
url string yes URL of the image texture
planeView PlaneView (string) yes Texture plane view
height number yes Texture height
width number yes Texture width
scale number yes Texture scale
pixelated boolean yes Image rendering of the texture
shift Point (object) yes Shifts the background position
rotation Rotation (object) yes Rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

clear()

Cleans the isometric text (set an empty string in the native SVG text element)

addAnimation(animation)

Adds an animated tranform element to the isometric text (not compatible with Internet Explorer). These are the properties of the SVGTextAnimation object:

Property Type Optional Default Description
property string no - Indicates which property should be animated
duration number yes 1 Indicates the number of seconds of the animation
repeat number yes 0 Number of times that the animation will run. 0 runs indefinitely
from string / number yes - Initial value of the animation (if this property is used, values property can't be used)
to string / number yes - Final value of the animation (if this property is used, values property can't be used)
values string / number / string[] / number[] yes - All the values of the animation (if this property is used, from and to properties can't be used)

These are the properties that can be animated (property property)

  • fillColor
  • fillOpacity
  • strokeColor
  • strokeOpacity
  • strokeWidth
  • right
  • left
  • top
  • rotation
removeAnimationByIndex(index)

Remove an especific animation element by its index.

removeAnimations()

Remove all the animation elements.

addEventListener(type, callback, [useCapture])

Sets up a function that will be called whenever the specified event is delivered to the isometric text (the SVG text element)

Parameter Type
type string
callback VoidFunction
callback boolean 
removeEventListener(type, listener, [useCapture])

Removes from the isometric text (the SVG text element) an event listener previously registered with addEventListener

Parameter Type
type string
callback VoidFunction
callback boolean

Instance Properties

Property Type Description
planeView string Gets and sets the plane view in which the isometric text is created
right number Gets and sets the right isometric coordinates of the isometric text
left number Gets and sets the left isometric coordinates of the isometric text
top number Gets and sets the top isometric coordinates of the isometric text
fontFamily string Gets and sets the font-family of the isometric text
fontSize string Gets and sets the font-size of the isometric text
fontStyle string literal Gets and sets the font-style of the isometric text
fontWeight number string literal
rotation number Gets and sets the rotation of the isometric text
origin string literal tuple Gets and sets the origin of the isometric text position and transformations
selectable boolean Gets and sets the ability of the isometric text of being selectable
fillColor string Gets and sets the fill color of the isometric text
fillOpacity number Gets and sets the fill opacity of the isometric text
strokeColor string Gets and sets the stroke color of the isometric text
strokeOpacity number Gets and sets the stroke opacity of the isometric text
strokeDashArray number[] Gets and sets the SVG stroke dasharray of the isometric text
strokeLinecap string Gets and sets the SVG stroke linecap of the isometric text
strokeLinejoin string Gets and sets the SVG stroke linejoin of the isometric text
strokeWidth number Gets and sets the stroke width of the isometric text
texture Texture (object) Gets and sets the texture of the isometric text

planeView values

"TOP" | "FRONT" | "SIDE"

fontStyle values

"normal" | "italic" | "oblique"

fontWeight values

number | "normal" | "bold" | "bolder" | "lighter"

origin values

["left" | "center" | "right", "top" | "center", "bottom"]

texture properties

Object to set the texture of the isometric text

Property Type Default value Description
url string - URL of the image texture
planeView PlaneView (string) parent planeView Sets the texture plane view. By default it takes the isometric text plane view
height number - Sets the texture height
width number - Sets the texture width
scale number - Sets the scale of the texture
pixelated boolean - Sets the image rendering of the texture
shift Point (object) - Shifts the background position
rotation Rotation (object) - Set the rotation of the texture

shift properties

Object to shift the background position

Property Type Default value Description
right number - Right coordinates
left number - Left coordinates
top number - Top coordinates

rotation properties

Object to set the background rotation

Property Type Default value Description
axis Axis (string) - Rotation axis
value number - Rotation value

axis values

"RIGHT" | "LEFT" | "TOP"

More Repositories

1

postcss-rtlcss

PostCSS plugin to build Cascading Style Sheets (CSS) with Left-To-Right (LTR) and Right-To-Left (RTL) rules using RTLCSS
TypeScript
83
star
2

ColorTranslator

A JavaScript library, written in TypeScript, to convert among different color models
TypeScript
67
star
3

isometric-css

Isometric-CSS is a lightweight JavaScript library to build isometric projections through declarative HTML attributes.
JavaScript
38
star
4

keep-texts-in-tabs

Avoid removing texts from Home Assistant tabs when icons are added to them
TypeScript
6
star
5

nextjs-postcss-rtlcss-example

Next.js project using postcss-rtlcss plugin to automatically create left-to-right and right-to-left CSS rules
JavaScript
2
star
6

postcss-janus

PostCSS plugin to create RTL rules using CSSJanus
JavaScript
1
star