Class ShapeLibraryImpl<T>

constructor

• new ShapeLibraryImpl<T>(shapeSets, options?): ShapeLibraryImpl<T>

• ShapeLibrary constructor.

  Type Parameters

  • T extends ObjectData

  Parameters

  • shapeSets: ShapeSet | ShapeSet[]

    One or more shape sets to include in the library.
  • Optionaloptions: ShapeLibraryOptions

    Options for the library.

  Returns ShapeLibraryImpl<T>

getCompiledShape

• getCompiledShape(type, category?): ShapeGeneratorFunction

• Gets a compiled version of the given shape, creating and caching it if it does not already exist.

  Parameters

  • type: string

    Shape type.
  • Optionalcategory: string

    Category to use. Defaults to the ID of the first category provided in the shape list.

  Returns ShapeGeneratorFunction

getShapeDefinition

• getShapeDefinition(type, set?): ShapeType

• Gets the definition for some shape. May return null.

  Parameters

  • type: string
  • Optionalset: string

  Returns ShapeType

getShapeTagDefinition

• getShapeTagDefinition(strokeWidth?, includeLabel?, labelAttribute?): CustomTagOptions

• Returns a tag definition that can be used in a Surface's tags declaration. Note that this method returns an object containing the tag's implementation, but not the name of the tag. You can call the tag whatever you like.

  Parameters

  • OptionalstrokeWidth: number
  • OptionalincludeLabel: boolean
  • labelAttribute: string = DEFAULT_LABEL_PROPERTY

  Returns CustomTagOptions

getShapeTemplate

• getShapeTemplate(type, set): string

• Gets the template for the given shape type in the given set. If no template is resolved then we return DEFAULT_TEMPLATE (and log the issue to the console).

  Parameters

  • type: string

    Shape type
  • set: string

    Name of set. If not provided, the value of DEFAULT_SET is used as the set name.

  Returns string

renderCompiledShape

• renderCompiledShape(data, strokeWidth?, typeParameter?, categoryParameter?): HTMLElement | SVGElement

• Render the given data with the appropriate template. A fill value is set on the resulting element, and the vector-effect attribute is set to 'non scaling stroke', ie. when the shape is scaled due to the element dimensions differing from the viewbox, the stroke does not change.

  Parameters

  • data: ObjectData
  • OptionalstrokeWidth: number

    Stroke width to use. This is passed to the underlying template and is taken into account by the shape template (or at least, it should be, because it has a bearing on the quality of the result)
  • OptionaltypeParameter: string

    Optional key to use to look up an object's type. When not provided, the typeParameter from the class is used.
  • OptionalcategoryParameter: string

    Optional key to use to look up an object's category. When not provided, the categoryParameter from the class is used.

  Returns HTMLElement | SVGElement

renderShapeLabel

• renderShapeLabel(data, labelProperty?, strokeWidth?, label?): SVGTextElement

• Render a label element for the given data - an SVG text element.

  Parameters

  • data: ObjectData

    Data to extract label from
  • OptionallabelProperty: string

    Name of the property that provides the label. Defaults to "label"
  • OptionalstrokeWidth: string

    Optional stroke width, defaults to 0.25px
  • Optionallabel: string

    Optional label to use, overrides extracting label from the data.

  Returns SVGTextElement

compiledIconList

compiledIcons